Operator

class Operator : public HPS::Sprocket

The Operator class is the base class for classes which handle under input and operate on the scene. This class handles GUI events such as key presses, mouse movement and clicks, and touches

Subclassed by HPS::AnnotationOperator, HPS::AxisTriadOperator, HPS::ConstructRectangleOperator, HPS::Exchange::CommonMeasurementOperator, HPS::FlyOperator, HPS::HandlesOperator, HPS::MarkupOperator, HPS::MeasurementOperator, HPS::MouseWheelOperator, HPS::NavigationCubeOperator, HPS::OrbitOperator, HPS::PanOperator, HPS::PanOrbitZoomOperator, HPS::RelativeOrbitOperator, HPS::SelectOperator, HPS::TurntableOperator, HPS::ZoomFitTouchOperator, HPS::ZoomOperator, SpaceMouseOperator

Public Types

enum class Priority

Values:

enumerator Low

enumerator Default

enumerator High

Public Functions

virtual void Assign(Operator const &in_that)

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

void DetachView()

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

virtual bool Equals(Operator const &in_that) const

Tests this operator for equality against the parameter in_that. Same as Operator::operator==

View GetAttachedView() const

Returns the View the Operator is currently attached to.

inline ModifierKeys GetModifierTrigger() const

Gets the modifier trigger associated with this operator.

inline MouseButtons GetMouseTrigger() const

Gets the mouse trigger associated with this operator.

inline virtual UTF8 GetName() const

Returns the name of the Operator.

inline virtual bool IsMouseTriggered(MouseState const &in_state)

Returns true if the MouseButtons and ModifierKeys are active.

inline virtual HPS::Type ObjectType() const

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns:

The declared type of the object in question, which may differ from the true, underlying type.

inline virtual bool OnKeyDown(KeyboardState const &in_state)

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.

inline virtual bool OnKeyUp(KeyboardState const &in_state)

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.

inline virtual void OnModelAttached()

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.

inline virtual void OnModelDetached()

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.

inline virtual bool OnMouseDown(MouseState const &in_state)

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.

inline virtual bool OnMouseEnter(MouseState const &in_state)

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.

inline virtual bool OnMouseLeave(MouseState const &in_state)

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.

inline virtual bool OnMouseMove(MouseState const &in_state)

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.

inline virtual bool OnMouseUp(MouseState const &in_state)

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.

inline virtual bool OnMouseWheel(MouseState const &in_state)

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.

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

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.

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

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.

inline virtual bool OnTouchDown(TouchState const &in_state)

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.

inline virtual bool OnTouchMove(TouchState const &in_state)

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.

inline 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.

Parameters:

in_state – A TouchState object describing the current touch state.

Returns:

true if the input event was handled, false otherwise.

inline virtual void OnViewAttached(HPS::View const &in_attached_view)

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

Parameters:

in_attached_view – The view attached to this operator.

inline virtual void OnViewDetached(HPS::View const &in_detached_view)

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

Parameters:

in_detached_view – The view detached from this operator.

Operator(MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys())

Operator(Operator const &in_that)

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

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

virtual Operator &operator=(Operator const &in_that)

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

Tests this operator for equality against the parameter in_that. Same as Operator::Equals.

inline void SetModifierTrigger(ModifierKeys in_modifiers)

Sets the modifier trigger associated with this operator.

Parameters:

in_modifiers – The modifier keys that are used to trigger this operator.

inline void SetMouseTrigger(MouseButtons in_buttons)

Sets the mouse trigger for this operator

virtual ~Operator()

Public Static Attributes

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