HPS::Exchange::CommonMeasurementOperator Class Reference

The CommonMeasurementOperator class defines an operator which contains many often used functions when inserting measurements. More...

#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::CommonMeasurementOperator:

Collaboration diagram for HPS::Exchange::CommonMeasurementOperator:

Classes
class	MeasurementDeletedEvent
class	MeasurementInsertedEvent

Public Types
enum	Tags {   Tags::Name = 0,   Tags::MeasurementType,   Tags::Radius,   Tags::Inverted,   Tags::VectorX,   Tags::VectorY,   Tags::VectorZ }
enum	Priority {   Priority::Low,   Priority::Default,   Priority::High }

Public Member Functions
	CommonMeasurementOperator ()
	CommonMeasurementOperator (Exchange::CADModel const &in_cad_model, MouseButtons in_mouse_trigger=MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger=ModifierKeys())
virtual HPS::UTF8	GetName () const override
	Returns the name of the operator. More...
virtual void	OnViewAttached () override
	This function is called whenever a view is attached to this operator. More...
virtual void	OnViewDetached () override
	This function is called whenever a view is detached from this operator. More...
Exchange::CADModel	GetCADModel () const
void	SetCADModel (Exchange::CADModel const &in_cad_model)
size_t	GetPrecision () const
	Returns the precision used in the measurement (number of digits after the decimal point) More...
void	SetPrecision (size_t in_precision)
	Changes the precision used in the measurement (number of digits after the decimal point) Only affects future measurements. More...
MaterialMappingKit	GetMaterial () const
	Returns the material used for the measurements. More...
void	SetMaterial (MaterialMappingKit const &in_material_mapping)
	Changes the material used for the measurements. More...
TextAttributeKit	GetTextAttributes () const
	Returns the text attributes used for the measurements. More...
void	SetTextAttribute (TextAttributeKit const &in_text_attributes)
	Changes the text attributes used for the measurements. More...
SegmentKey	GetMeasurementSegment () const
	Returns the top measurement segment containing all measurements. More...
void	DeleteMeasurements ()
HPS::Type	ObjectType () const
virtual void	Assign (Operator const &in_that)
	Assigns the parameter in_that to this operator, resulting in a clone. More...
virtual bool	Equals (Operator const &in_that) const
	Tests this operator for equality against the parameter in_that. More...
virtual bool	operator!= (Operator const &in_that) const
	Tests this operator for non-equality against the parameter in_that. More...
virtual bool	operator== (Operator const &in_that) const
	Tests this operator for equality against the parameter in_that. More...
void	DetachView ()
	Detaches the Operator from the View it was previously attached to. More...
View	GetAttachedView () const
	Returns the View the Operator is currently attached to. More...
virtual bool	OnMouseDown (MouseState const &in_state)
	This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed. More...
virtual bool	OnMouseUp (MouseState const &in_state)
	This function is called whenever HPS receives a MouseEvent that signals a mouse button was released. More...
virtual bool	OnMouseMove (MouseState const &in_state)
	This function is called whenever HPS receives a MouseEvent that signals the mouse moved. More...
virtual bool	OnMouseWheel (MouseState const &in_state)
	This function is called whenever HPS receives a MouseEvent that signals the mouse wheel was scrolled. More...
virtual bool	OnMouseEnter (MouseState const &in_state)
	This function is called whenever HPS receives a MouseEvent that signals the mouse entered the window. More...
virtual bool	OnMouseLeave (MouseState const &in_state)
	This function is called whenever HPS receives a MouseEvent that signals the mouse left the window. More...
virtual bool	OnTouchDown (TouchState const &in_state)
	This function is called whenever HPS receives a TouchEvent that signals the device was touched. More...
virtual bool	OnTouchUp (TouchState const &in_state)
	This function is called whenever HPS receives a TouchEvent that signals a point of contact has been released. More...
virtual bool	OnTouchMove (TouchState const &in_state)
	This function is called whenever HPS receives a TouchEvent that signals a point of contact has moved. More...
virtual bool	OnKeyDown (KeyboardState const &in_state)
	This function is called whenever HPS receives a KeyboardEvent that signals a key was pressed. More...
virtual bool	OnKeyUp (KeyboardState const &in_state)
	This function is called whenever HPS receives a KeyboardEvent that signals a key was released. More...
virtual bool	OnTextInput (HPS::UTF8 const &in_text)
	This function is called whenever HPS receives a TextInputEvent that signals text was entered. More...
virtual bool	OnTimerTick (HPS::TimerTickEvent const &in_event)
	This function is called whenever HPS receives a TimerTickEvent. More...
virtual void	OnModelAttached ()
	This function is called whenever a model is attached to the view that is attached to this operator. More...
virtual void	OnModelDetached ()
	This function is called whenever a model is detached from the view that is attached to this operator. More...
void	SetMouseTrigger (MouseButtons in_buttons)
	Sets the mouse trigger for this operator. More...
MouseButtons	GetMouseTrigger () const
	Gets the mouse trigger associated with this operator. More...
void	SetModifierTrigger (ModifierKeys in_modifiers)
	Sets the modifier trigger associated with this operator. More...
ModifierKeys	GetModifierTrigger () const
	Gets the modifier trigger associated with this operator. More...
virtual bool	IsMouseTriggered (MouseState const &in_state)
	Returns true if the MouseButtons and ModifierKeys are active. More...
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
virtual bool	Empty () const
	Indicates whether this object has any values set on it. More...
virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...
bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...
intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...
intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static UTF8	GetNewMeasurementSegmentName (HPS::UTF8 const &in_prefix)
	Returns the name to be used for the new measurement segment name. More...
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::Operator

Protected Member Functions
void	Tag (HPS::Key &tag, const char *message, Tags tag_index)
void	GetUnits ()
void	SetGlyphColor ()
void	GetCameraDirection ()
void	SetupConstructionSegment ()
void	PositionLinearMeasurementGeometry (WindowPoint const &window_cursor_location, KeyPath const &event_path, LineKey &leader_line_one, LineKey &leader_line_two, LineKey &measurement_line, LineKey &line_to_cursor, Point &original_point_one, Point &original_point_two, TextKey &text, UTF8 const &text_string, Point &distance_point_one, Point &distance_point_two, SegmentKey &current_measurement_segment, Plane const &measurement_plane=Plane(), Vector const &explicit_direction=Vector())
float	GetModelScale (Exchange::Component const &component)
void	SetMaterialsOnMeasurementSegment (HPS::SegmentKey const &set_materials_here, HPS::MaterialMappingKit const &materials_to_apply)

Protected Attributes
Exchange::CADModel	cad_model
size_t	measurement_precision
UTF8	units
MaterialMappingKit	materials
TextAttributeKit	text_attributes
SegmentKey	measurement_segment
GlyphDefinition	left_arrow
GlyphDefinition	right_arrow
SelectionOptionsKit	selection_options
bool	manipulate_measurement
Vector	camera_direction
PortfolioKey	portfolio
SegmentKey	style_segment
HighlightOptionsKit	highlight_options
HPS::MouseButtons	mouse_trigger
HPS::ModifierKeys	modifier_trigger

Static Protected Attributes
static size_t	length_measurement_index
static size_t	radius_measurement_index
static size_t	distance_measurement_index
static size_t	angle_measurement_index

Detailed Description

The CommonMeasurementOperator class defines an operator which contains many often used functions when inserting measurements.

Users can build a custom measurement operator by deriving from this class. This operator requires the model be loaded using the Exchange bridge, and the model must contain B-rep.

Member Enumeration Documentation

Priority

enum HPS::Operator::Priority

stronginherited

Enumerator
Low
Default
High

Tags

enum HPS::Exchange::CommonMeasurementOperator::Tags

strong

Enumerator
Name
MeasurementType
Radius
Inverted
VectorX
VectorY
VectorZ

Constructor & Destructor Documentation

CommonMeasurementOperator() [1/2]

HPS::Exchange::CommonMeasurementOperator::CommonMeasurementOperator

(

)

CommonMeasurementOperator() [2/2]

HPS::Exchange::CommonMeasurementOperator::CommonMeasurementOperator	(	Exchange::CADModel const &	in_cad_model,
		MouseButtons	in_mouse_trigger = MouseButtons::ButtonLeft(),
		ModifierKeys	in_modifier_trigger = ModifierKeys()
	)

Member Function Documentation

Assign()

virtual void HPS::Operator::Assign ( Operator const &  in_that )

virtualinherited

Assigns the parameter in_that to this operator, resulting in a clone.

ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

DeleteMeasurements()

void HPS::Exchange::CommonMeasurementOperator::DeleteMeasurements

(

)

DetachView()

void HPS::Operator::DetachView ( )

inherited

Detaches the Operator from the View it was previously attached to.

Empty()

virtual bool HPS::Object::Empty ( ) const

inlinevirtualinherited

Indicates whether this object has any values set on it.

Returns

true if no values are set on this object, false otherwise.

Reimplemented in HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ImportResultsKit, HPS::OBJ::ImportOptionsKit, HPS::Hardcopy::File::ExportOptionsKit, HPS::Stream::ExportOptionsKit, HPS::Stream::ImportResultsKit, HPS::Stream::ImportOptionsKit, HPS::PointCloud::ImportOptionsKit, HPS::PointCloud::ImportResultsKit, HPS::UpdateOptionsKit, HPS::HighlightSearchOptionsKit, HPS::HighlightOptionsKit, HPS::SelectionOptionsKit, HPS::SearchOptionsKit, HPS::CutGeometryGatheringOptionsKit, HPS::ShapeKit, HPS::ShaderKit, HPS::Shader::ImportOptionsKit, HPS::ImageKit, HPS::Image::ImportOptionsKit, HPS::Image::ExportOptionsKit, HPS::TextureOptionsKit, HPS::LinePatternKit, HPS::LinePatternParallelKit, HPS::LinePatternOptionsKit, HPS::GlyphKit, HPS::ApplicationWindowOptionsKit, HPS::OffScreenWindowOptionsKit, HPS::StandAloneWindowOptionsKit, HPS::GridKit, HPS::PolygonKit, HPS::MeshKit, HPS::ShellKit, HPS::ShellRelationResultsKit, HPS::ShellRelationOptionsKit, HPS::ShellOptimizationOptionsKit, HPS::TextKit, HPS::EllipticalArcKit, HPS::EllipseKit, HPS::TrimKit, HPS::NURBSSurfaceKit, HPS::NURBSCurveKit, HPS::SpotlightKit, HPS::InfiniteLineKit, HPS::CuttingSectionKit, HPS::CircularWedgeKit, HPS::CircularArcKit, HPS::CircleKit, HPS::SphereKit, HPS::CylinderKit, HPS::DistantLightKit, HPS::MarkerKit, HPS::LineKit, HPS::AttributeLockKit, HPS::FontInfoState, HPS::WindowInfoKit, HPS::DebuggingKit, HPS::SubwindowKit, HPS::ContourLineKit, HPS::VisualEffectsKit, HPS::TransformMaskKit, HPS::PostProcessEffectsKit, HPS::DrawingAttributeKit, HPS::HiddenLineAttributeKit, HPS::PerformanceKit, HPS::NURBSSurfaceAttributeKit, HPS::MaterialKit, HPS::MaterialMappingKit, HPS::MatrixKit, HPS::CurveAttributeKit, HPS::EdgeAttributeKit, HPS::LineAttributeKit, HPS::TextAttributeKit, HPS::CuttingSectionAttributeKit, HPS::CylinderAttributeKit, HPS::LightingAttributeKit, HPS::SphereAttributeKit, HPS::MarkerAttributeKit, HPS::CullingKit, HPS::ColorInterpolationKit, HPS::TransparencyKit, HPS::SelectabilityKit, HPS::CameraKit, HPS::VisibilityKit, HPS::BoundingKit, HPS::SegmentOptimizationOptionsKit, HPS::Publish::ExportOptionsKit, HPS::Publish::TextFieldKit, HPS::Publish::SignatureFieldKit, HPS::Publish::DropDownListKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::ListBoxKit, HPS::Exchange::ExportSTEPOptionsKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportIGESOptionsKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportU3DOptionsKit, HPS::Exchange::ExportSTLOptionsKit, HPS::Publish::ButtonKit, HPS::Exchange::ExportPRCOptionsKit, HPS::Publish::LinkKit, HPS::Exchange::ExportJTOptionsKit, HPS::Publish::SlideTableKit, HPS::Exchange::ExportACISOptionsKit, HPS::Publish::TableKit, HPS::Exchange::Export3MFOptionsKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Publish::ViewKit, HPS::Exchange::TranslationOptionsKit, HPS::Publish::ArtworkKit, HPS::Publish::AnnotationKit, HPS::ComponentPath, HPS::Exchange::ImportOptionsKit, HPS::Parasolid::ExportOptionsKit, HPS::Exchange::NURBSConversionOptionsKit, HPS::Parasolid::LineTessellationKit, HPS::Exchange::Configuration, HPS::Publish::PageKit, HPS::Parasolid::FacetTessellationKit, HPS::Publish::DocumentKit, HPS::Parasolid::ImportOptionsKit, HPS::DWG::ImportOptionsKit, HPS::OOC::ImportOptionsKit, HPS::Sketchup::ImportOptionsKit, and HPS::Sketchup::ImportResultsKit.

Equals()

virtual bool HPS::Operator::Equals ( Operator const &  in_that ) const

virtualinherited

Tests this operator for equality against the parameter in_that.

Same as Operator::operator==

GetAttachedView()

View HPS::Operator::GetAttachedView ( ) const

inherited

Returns the View the Operator is currently attached to.

GetCADModel()

Exchange::CADModel HPS::Exchange::CommonMeasurementOperator::GetCADModel

(

)

const

GetCameraDirection()

void HPS::Exchange::CommonMeasurementOperator::GetCameraDirection ( )

protected

GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns

A unique value shared by all objects of the same class.

GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns

A value unique to an instance of an object and all objects that are backed by the same database resource.

GetMaterial()

MaterialMappingKit HPS::Exchange::CommonMeasurementOperator::GetMaterial

(

)

const

Returns the material used for the measurements.

GetMeasurementSegment()

SegmentKey HPS::Exchange::CommonMeasurementOperator::GetMeasurementSegment

(

)

const

Returns the top measurement segment containing all measurements.

GetModelScale()

float HPS::Exchange::CommonMeasurementOperator::GetModelScale ( Exchange::Component const &  component )

protected

GetModifierTrigger()

ModifierKeys HPS::Operator::GetModifierTrigger ( ) const

inlineinherited

Gets the modifier trigger associated with this operator.

GetMouseTrigger()

MouseButtons HPS::Operator::GetMouseTrigger ( ) const

inlineinherited

Gets the mouse trigger associated with this operator.

GetName()

virtual HPS::UTF8 HPS::Exchange::CommonMeasurementOperator::GetName ( ) const

inlineoverridevirtual

Returns the name of the operator.

Reimplemented from HPS::Operator.

Reimplemented in HPS::Exchange::MeasurementOperator.

GetNewMeasurementSegmentName()

static UTF8 HPS::Exchange::CommonMeasurementOperator::GetNewMeasurementSegmentName ( HPS::UTF8 const &  in_prefix )

static

Returns the name to be used for the new measurement segment name.

GetPrecision()

size_t HPS::Exchange::CommonMeasurementOperator::GetPrecision

(

)

const

Returns the precision used in the measurement (number of digits after the decimal point)

GetTextAttributes()

TextAttributeKit HPS::Exchange::CommonMeasurementOperator::GetTextAttributes

(

)

const

Returns the text attributes used for the measurements.

GetUnits()

void HPS::Exchange::CommonMeasurementOperator::GetUnits ( )

protected

HasType()

bool HPS::Object::HasType ( HPS::Type  in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask

The Type mask to check against this Object.

Returns

true if this Object has the given Type mask, false otherwise.

IsMouseTriggered()

virtual bool HPS::Operator::IsMouseTriggered ( MouseState const &  in_state )

inlinevirtualinherited

Returns true if the MouseButtons and ModifierKeys are active.

Reimplemented in HPS::SimpleWalkOperator.

Here is the call graph for this function:

ObjectType()

HPS::Type HPS::Operator::ObjectType ( ) const

inlinevirtualinherited

Reimplemented from HPS::Object.

Here is the call graph for this function:

OnKeyDown()

virtual bool HPS::Operator::OnKeyDown ( KeyboardState const &  in_state )

inlinevirtualinherited

This function is called whenever HPS receives a KeyboardEvent that signals a key was pressed.

Parameters

in_state

A KeyboardState object describing the current keyboard state.

Returns

true if the input event was handled, false otherwise.

Reimplemented in HPS::Exchange::MeasurementOperator, HPS::AnnotationOperator, HPS::MarkupOperator, HPS::SimpleWalkOperator, and HPS::FlyOperator.

OnKeyUp()

virtual bool HPS::Operator::OnKeyUp ( KeyboardState const &  in_state )

inlinevirtualinherited

This function is called whenever HPS receives a KeyboardEvent that signals a key was released.

Parameters

in_state

A KeyboardState object describing the current keyboard state.

Returns

true if the input event was handled, false otherwise.

Reimplemented in HPS::SimpleWalkOperator, and HPS::FlyOperator.

OnModelAttached()

virtual void HPS::Operator::OnModelAttached ( )

inlinevirtualinherited

This function is called whenever a model is attached to the view that is attached to this operator.

If no view is attached to this operator, this function will not be called.

Reimplemented in HPS::NavigationCubeOperator, HPS::CuttingSectionOperator, HPS::SimpleWalkOperator, HPS::WalkOperator, HPS::FlyOperator, and HPS::MouseWheelOperator.

OnModelDetached()

virtual void HPS::Operator::OnModelDetached ( )

inlinevirtualinherited

This function is called whenever a model is detached from the view that is attached to this operator.

If no view is attached to this operator, this function will not be called.

OnMouseDown()

virtual bool HPS::Operator::OnMouseDown ( MouseState const &  in_state )

inlinevirtualinherited

This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed.

Parameters

in_state

A MouseState object describing the current mouse state.

Returns

true if the input event was handled, false otherwise.

Reimplemented in HPS::Exchange::MeasurementOperator, HPS::NavigationCubeOperator, HPS::AxisTriadOperator, HPS::HandlesOperator, HPS::AnnotationOperator, HPS::MarkupOperator, HPS::CuttingSectionOperator, HPS::SimpleWalkOperator, HPS::FlyOperator, HPS::TurntableOperator, HPS::HighlightOperator, HPS::SelectOperator, HPS::ConstructRectangleOperator, HPS::ZoomOperator, HPS::RelativeOrbitOperator, HPS::OrbitOperator, HPS::PanOperator, and HPS::PanOrbitZoomOperator.

OnMouseEnter()

virtual bool HPS::Operator::OnMouseEnter ( MouseState const &  in_state )

inlinevirtualinherited

This function is called whenever HPS receives a MouseEvent that signals the mouse entered the window.

Parameters

in_state

A MouseState object describing the current mouse state.

Returns

true if the input event was handled, false otherwise.

Reimplemented in HPS::SimpleWalkOperator.

OnMouseLeave()

virtual bool HPS::Operator::OnMouseLeave ( MouseState const &  in_state )

inlinevirtualinherited

This function is called whenever HPS receives a MouseEvent that signals the mouse left the window.

Parameters

in_state

A MouseState object describing the current mouse state.

Returns

true if the input event was handled, false otherwise.

Reimplemented in HPS::SimpleWalkOperator.

OnMouseMove()

virtual bool HPS::Operator::OnMouseMove ( MouseState const &  in_state )

inlinevirtualinherited

This function is called whenever HPS receives a MouseEvent that signals the mouse moved.

Parameters

in_state

A MouseState object describing the current mouse state.

Returns

true if the input event was handled, false otherwise.

Reimplemented in HPS::Exchange::MeasurementOperator, HPS::NavigationCubeOperator, HPS::AxisTriadOperator, HPS::HandlesOperator, HPS::AnnotationOperator, HPS::MarkupOperator, HPS::CuttingSectionOperator, HPS::SimpleWalkOperator, HPS::FlyOperator, HPS::TurntableOperator, HPS::ConstructRectangleOperator, HPS::ZoomOperator, HPS::RelativeOrbitOperator, HPS::OrbitOperator, HPS::PanOperator, and HPS::PanOrbitZoomOperator.

OnMouseUp()

virtual bool HPS::Operator::OnMouseUp ( MouseState const &  in_state )

inlinevirtualinherited

This function is called whenever HPS receives a MouseEvent that signals a mouse button was released.

Parameters

in_state

A MouseState object describing the current mouse state.

Returns

true if the input event was handled, false otherwise.

Reimplemented in HPS::Exchange::MeasurementOperator, HPS::NavigationCubeOperator, HPS::AxisTriadOperator, HPS::HandlesOperator, HPS::MarkupOperator, HPS::CuttingSectionOperator, HPS::SimpleWalkOperator, HPS::FlyOperator, HPS::TurntableOperator, HPS::HighlightAreaOperator, HPS::SelectAreaOperator, HPS::ZoomBoxOperator, HPS::ConstructRectangleOperator, HPS::ZoomOperator, HPS::RelativeOrbitOperator, HPS::OrbitOperator, HPS::PanOperator, and HPS::PanOrbitZoomOperator.

OnMouseWheel()

virtual bool HPS::Operator::OnMouseWheel ( MouseState const &  in_state )

inlinevirtualinherited

This function is called whenever HPS receives a MouseEvent that signals the mouse wheel was scrolled.

Parameters

in_state

A MouseState object describing the current mouse state.

Returns

true if the input event was handled, false otherwise.

Reimplemented in HPS::SimpleWalkOperator, HPS::FlyOperator, HPS::TurntableOperator, and HPS::MouseWheelOperator.

OnTextInput()

virtual bool HPS::Operator::OnTextInput ( HPS::UTF8 const &  in_text )

inlinevirtualinherited

This function is called whenever HPS receives a TextInputEvent that signals text was entered.

Parameters

in_text

The text entered.

Returns

true if the input event was handled, false otherwise.

Reimplemented in HPS::AnnotationOperator, and HPS::MarkupOperator.

OnTimerTick()

virtual bool HPS::Operator::OnTimerTick ( HPS::TimerTickEvent const &  in_event )

inlinevirtualinherited

This function is called whenever HPS receives a TimerTickEvent.

Parameters

in_event

A TimerTickEvent object describing the current event state.

Returns

true if the input event was handled, false otherwise.

Reimplemented in HPS::CuttingSectionOperator, HPS::SimpleWalkOperator, HPS::WalkOperator, and HPS::FlyOperator.

OnTouchDown()

virtual bool HPS::Operator::OnTouchDown ( TouchState const &  in_state )

inlinevirtualinherited

This function is called whenever HPS receives a TouchEvent that signals the device was touched.

Parameters

in_state

A TouchState object describing the current touch state.

Returns

true if the input event was handled, false otherwise.

Reimplemented in HPS::Exchange::MeasurementOperator, HPS::NavigationCubeOperator, HPS::AxisTriadOperator, HPS::HandlesOperator, HPS::AnnotationOperator, HPS::MarkupOperator, HPS::CuttingSectionOperator, HPS::SimpleWalkOperator, HPS::FlyOperator, HPS::ZoomFitTouchOperator, HPS::TurntableOperator, HPS::HighlightOperator, HPS::SelectOperator, HPS::ConstructRectangleOperator, HPS::ZoomOperator, HPS::RelativeOrbitOperator, HPS::OrbitOperator, HPS::PanOperator, and HPS::PanOrbitZoomOperator.

OnTouchMove()

virtual bool HPS::Operator::OnTouchMove ( TouchState const &  in_state )

inlinevirtualinherited

This function is called whenever HPS receives a TouchEvent that signals a point of contact has moved.

Parameters

in_state

A TouchState object describing the current touch state.

Returns

true if the input event was handled, false otherwise.

Reimplemented in HPS::Exchange::MeasurementOperator, HPS::NavigationCubeOperator, HPS::AxisTriadOperator, HPS::HandlesOperator, HPS::AnnotationOperator, HPS::MarkupOperator, HPS::CuttingSectionOperator, HPS::SimpleWalkOperator, HPS::FlyOperator, HPS::TurntableOperator, HPS::ConstructRectangleOperator, HPS::ZoomOperator, HPS::RelativeOrbitOperator, HPS::OrbitOperator, HPS::PanOperator, and HPS::PanOrbitZoomOperator.

OnTouchUp()

virtual bool HPS::Operator::OnTouchUp ( TouchState const &  in_state )

inlinevirtualinherited

This function is called whenever HPS receives a TouchEvent that signals a point of contact has been released.

Parameters

in_state

A TouchState object describing the current touch state.

Returns

true if the input event was handled, false otherwise.

Reimplemented in HPS::Exchange::MeasurementOperator, HPS::NavigationCubeOperator, HPS::AxisTriadOperator, HPS::HandlesOperator, HPS::AnnotationOperator, HPS::MarkupOperator, HPS::CuttingSectionOperator, HPS::SimpleWalkOperator, HPS::FlyOperator, HPS::ZoomFitTouchOperator, HPS::TurntableOperator, HPS::HighlightAreaOperator, HPS::SelectAreaOperator, HPS::ZoomBoxOperator, HPS::ConstructRectangleOperator, HPS::RelativeOrbitOperator, HPS::OrbitOperator, HPS::PanOperator, and HPS::PanOrbitZoomOperator.

OnViewAttached()

virtual void HPS::Exchange::CommonMeasurementOperator::OnViewAttached ( )

overridevirtual

This function is called whenever a view is attached to this operator.

Reimplemented from HPS::Operator.

Reimplemented in HPS::Exchange::MeasurementOperator.

OnViewDetached()

virtual void HPS::Exchange::CommonMeasurementOperator::OnViewDetached ( )

overridevirtual

This function is called whenever a view is detached from this operator.

Reimplemented from HPS::Operator.

Reimplemented in HPS::Exchange::MeasurementOperator.

operator!=()

virtual bool HPS::Operator::operator!= ( Operator const &  in_that ) const

virtualinherited

Tests this operator for non-equality against the parameter in_that.

operator==()

virtual bool HPS::Operator::operator== ( Operator const &  in_that ) const

virtualinherited

Tests this operator for equality against the parameter in_that.

Same as Operator::Equals.

PositionLinearMeasurementGeometry()

void HPS::Exchange::CommonMeasurementOperator::PositionLinearMeasurementGeometry ( WindowPoint const &  window_cursor_location, KeyPath const &  event_path, LineKey &  leader_line_one, LineKey &  leader_line_two, LineKey &  measurement_line, LineKey &  line_to_cursor, Point &  original_point_one, Point &  original_point_two, TextKey &  text, UTF8 const &  text_string, Point &  distance_point_one, Point &  distance_point_two, SegmentKey &  current_measurement_segment, Plane const &  measurement_plane = Plane(), Vector const &  explicit_direction = Vector()  )

protected

Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

SetCADModel()

void HPS::Exchange::CommonMeasurementOperator::SetCADModel

(

Exchange::CADModel const &

in_cad_model

)

SetGlyphColor()

void HPS::Exchange::CommonMeasurementOperator::SetGlyphColor ( )

protected

SetMaterial()

void HPS::Exchange::CommonMeasurementOperator::SetMaterial

(

MaterialMappingKit const &

in_material_mapping

)

Changes the material used for the measurements.

Affects all measurements, even those already inserted.

SetMaterialsOnMeasurementSegment()

void HPS::Exchange::CommonMeasurementOperator::SetMaterialsOnMeasurementSegment ( HPS::SegmentKey const &  set_materials_here, HPS::MaterialMappingKit const &  materials_to_apply  )

protected

SetModifierTrigger()

void HPS::Operator::SetModifierTrigger ( ModifierKeys  in_modifiers )

inlineinherited

Sets the modifier trigger associated with this operator.

Parameters

in_modifiers

The modifier keys that are used to trigger this operator.

SetMouseTrigger()

void HPS::Operator::SetMouseTrigger ( MouseButtons  in_buttons )

inlineinherited

Sets the mouse trigger for this operator.

SetPrecision()

void HPS::Exchange::CommonMeasurementOperator::SetPrecision

(

size_t

in_precision

)

Changes the precision used in the measurement (number of digits after the decimal point) Only affects future measurements.

SetTextAttribute()

void HPS::Exchange::CommonMeasurementOperator::SetTextAttribute

(

TextAttributeKit const &

in_text_attributes

)

Changes the text attributes used for the measurements.

Affects all measurements, even those already inserted.

SetupConstructionSegment()

void HPS::Exchange::CommonMeasurementOperator::SetupConstructionSegment ( )

protected

Tag()

void HPS::Exchange::CommonMeasurementOperator::Tag ( HPS::Key &  tag, const char *  message, Tags  tag_index  )

protected

Type()

virtual HPS::Type HPS::Object::Type ( ) const

virtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns

The true type of the object in question.

Reimplemented in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionOptionsControl, HPS::OffScreenWindowOptionsControl, HPS::ApplicationWindowOptionsControl, HPS::StandAloneWindowOptionsControl, HPS::AttributeLockControl, HPS::WindowInfoControl, HPS::DebuggingControl, HPS::SubwindowControl, HPS::ContourLineControl, HPS::VisualEffectsControl, HPS::TransformMaskControl, HPS::PostProcessEffectsControl, HPS::DrawingAttributeControl, HPS::HiddenLineAttributeControl, HPS::PerformanceControl, HPS::NURBSSurfaceAttributeControl, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::CurveAttributeControl, HPS::EdgeAttributeControl, HPS::LineAttributeControl, HPS::TextAttributeControl, HPS::CuttingSectionAttributeControl, HPS::CylinderAttributeControl, HPS::LightingAttributeControl, HPS::SphereAttributeControl, HPS::MarkerAttributeControl, HPS::CullingControl, HPS::ColorInterpolationControl, HPS::TransparencyControl, HPS::SelectabilityControl, HPS::CameraControl, HPS::VisibilityControl, HPS::BoundingControl, HPS::Kit, and HPS::Control.

Member Data Documentation

angle_measurement_index

size_t HPS::Exchange::CommonMeasurementOperator::angle_measurement_index

staticprotected

cad_model

Exchange::CADModel HPS::Exchange::CommonMeasurementOperator::cad_model

protected

camera_direction

Vector HPS::Exchange::CommonMeasurementOperator::camera_direction

protected

distance_measurement_index

size_t HPS::Exchange::CommonMeasurementOperator::distance_measurement_index

staticprotected

highlight_options

HighlightOptionsKit HPS::Exchange::CommonMeasurementOperator::highlight_options

protected

left_arrow

GlyphDefinition HPS::Exchange::CommonMeasurementOperator::left_arrow

protected

length_measurement_index

size_t HPS::Exchange::CommonMeasurementOperator::length_measurement_index

staticprotected

manipulate_measurement

bool HPS::Exchange::CommonMeasurementOperator::manipulate_measurement

protected

materials

MaterialMappingKit HPS::Exchange::CommonMeasurementOperator::materials

protected

measurement_precision

size_t HPS::Exchange::CommonMeasurementOperator::measurement_precision

protected

measurement_segment

SegmentKey HPS::Exchange::CommonMeasurementOperator::measurement_segment

protected

modifier_trigger

HPS::ModifierKeys HPS::Operator::modifier_trigger

protectedinherited

mouse_trigger

HPS::MouseButtons HPS::Operator::mouse_trigger

protectedinherited

portfolio

PortfolioKey HPS::Exchange::CommonMeasurementOperator::portfolio

protected

radius_measurement_index

size_t HPS::Exchange::CommonMeasurementOperator::radius_measurement_index

staticprotected

right_arrow

GlyphDefinition HPS::Exchange::CommonMeasurementOperator::right_arrow

protected

selection_options

SelectionOptionsKit HPS::Exchange::CommonMeasurementOperator::selection_options

protected

staticType

const HPS::Type HPS::Operator::staticType = HPS::Type::Operator

staticinherited

style_segment

SegmentKey HPS::Exchange::CommonMeasurementOperator::style_segment

protected

text_attributes

TextAttributeKit HPS::Exchange::CommonMeasurementOperator::text_attributes

protected

units

UTF8 HPS::Exchange::CommonMeasurementOperator::units

protected

---

The documentation for this class was generated from the following file:

• sprk_exchange.h