HPS::ZoomBoxOperator Class Reference

#include <sprk_ops.h>

Inheritance diagram for HPS::ZoomBoxOperator:

Collaboration diagram for HPS::ZoomBoxOperator:

Public Types
enum	Priority {   Priority::Low,   Priority::Default,   Priority::High }

Public Member Functions
	ZoomBoxOperator (MouseButtons in_mouse_trigger=MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger=ModifierKeys())
virtual HPS::UTF8	GetName () const
	Returns the name of the Operator. 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	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 void	OnViewAttached ()
	This function is called whenever a view is attached to this operator. 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	OnMouseMove (MouseState const &in_state)
	This function is called whenever HPS receives a MouseEvent that signals the mouse moved. 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	OnTouchMove (TouchState const &in_state)
	This function is called whenever HPS receives a TouchEvent that signals a point of contact has moved. More...
bool	IsRectangleValid () const
HPS::Rectangle	GetWindowRectangle () const
	Returns the rectangle associated with this operator in window coordinates. More...
HPS::Rectangle	GetInnerWindowRectangle () const
	Returns the rectangle associated with this operator in inner window coordinates. More...
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	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	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	OnViewDetached ()
	This function is called whenever a view is detached from this operator. 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
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 Attributes
HPS::MouseButtons	mouse_trigger
HPS::ModifierKeys	modifier_trigger

Private Member Functions
bool	ZoomCommon (HPS::WindowKey const &in_window, HPS::KeyPath const &in_event_path)

Member Enumeration Documentation

Priority

enum HPS::Operator::Priority

stronginherited

Enumerator
Low
Default
High

Constructor & Destructor Documentation

ZoomBoxOperator()

HPS::ZoomBoxOperator::ZoomBoxOperator	(	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.

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.

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.

GetInnerWindowRectangle()

HPS::Rectangle HPS::ConstructRectangleOperator::GetInnerWindowRectangle ( ) const

inlineinherited

Returns the rectangle associated with this operator in inner window coordinates.

If there is only one view, this is the same as GetWindowRectangle(). If there are multiple views, this is useful for operations done on the inner window level, such as drawing.

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.

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::ZoomBoxOperator::GetName ( ) const

inlinevirtual

Returns the name of the Operator.

Reimplemented from HPS::ConstructRectangleOperator.

GetWindowRectangle()

HPS::Rectangle HPS::ConstructRectangleOperator::GetWindowRectangle ( ) const

inlineinherited

Returns the rectangle associated with this operator in window coordinates.

If there is only one view, this is the same as GetInnerWindowRectangle(). If there are multiple views, this is useful for operations done on the window level, such as selection.

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:

IsRectangleValid()

bool HPS::ConstructRectangleOperator::IsRectangleValid ( ) const

inlineinherited

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::ConstructRectangleOperator::OnMouseDown ( MouseState const &  in_state )

virtualinherited

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 from HPS::Operator.

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::ConstructRectangleOperator::OnMouseMove ( MouseState const &  in_state )

virtualinherited

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 from HPS::Operator.

OnMouseUp()

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

virtual

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 from HPS::ConstructRectangleOperator.

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::ConstructRectangleOperator::OnTouchDown ( TouchState const &  in_state )

virtualinherited

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 from HPS::Operator.

OnTouchMove()

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

virtualinherited

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 from HPS::Operator.

OnTouchUp()

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

virtual

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 from HPS::ConstructRectangleOperator.

OnViewAttached()

virtual void HPS::ConstructRectangleOperator::OnViewAttached ( )

virtualinherited

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

Reimplemented from HPS::Operator.

Reimplemented in HPS::HighlightAreaOperator, and HPS::SelectAreaOperator.

OnViewDetached()

virtual void HPS::Operator::OnViewDetached ( )

inlinevirtualinherited

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

Reimplemented in HPS::Exchange::MeasurementOperator, HPS::Exchange::CommonMeasurementOperator, HPS::NavigationCubeOperator, HPS::HandlesOperator, HPS::AnnotationOperator, HPS::MarkupOperator, HPS::CuttingSectionOperator, and HPS::FlyOperator.

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.

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.

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.

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.

ZoomCommon()

bool HPS::ZoomBoxOperator::ZoomCommon ( HPS::WindowKey const &  in_window, HPS::KeyPath const &  in_event_path  )

private

Member Data Documentation

modifier_trigger

HPS::ModifierKeys HPS::Operator::modifier_trigger

protectedinherited

mouse_trigger

HPS::MouseButtons HPS::Operator::mouse_trigger

protectedinherited

staticType

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

staticinherited

---

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

• sprk_ops.h