#include <sprk.h>
|
enum | Priority { Low,
Default,
High
} |
|
|
static const HPS::Type | staticType = HPS::Type::Operator |
|
static const HPS::Type | staticType = HPS::Type::None |
|
|
template<typename T > |
static intptr_t | ClassID () |
|
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
◆ Assign()
virtual void HPS::Operator::Assign |
( |
Operator const & |
in_that | ) |
|
|
virtual |
Assigns the parameter in_that to this operator, resulting in a clone.
◆ DetachView()
void HPS::Operator::DetachView |
( |
| ) |
|
Detaches the Operator from the View it was previously attached to.
◆ Equals()
virtual bool HPS::Operator::Equals |
( |
Operator const & |
in_that | ) |
const |
|
virtual |
◆ GetAttachedView()
View HPS::Operator::GetAttachedView |
( |
| ) |
const |
◆ GetModifierTrigger()
Gets the modifier trigger associated with this operator.
◆ GetMouseTrigger()
Gets the mouse trigger associated with this operator.
◆ GetName()
virtual UTF8 HPS::Operator::GetName |
( |
| ) |
const |
|
inlinevirtual |
Returns the name of the Operator.
Reimplemented in HPS::Exchange::MeasurementOperator, HPS::Exchange::CommonMeasurementOperator, HPS::NavigationCubeOperator, HPS::AxisTriadOperator, HPS::HandlesOperator, HPS::AnnotationOperator, HPS::MarkupOperator, HPS::CuttingSectionOperator, HPS::SimpleWalkOperator, HPS::WalkOperator, HPS::FlyOperator, HPS::ZoomFitTouchOperator, HPS::TurntableOperator, HPS::MouseWheelOperator, HPS::HighlightOperator, HPS::SelectOperator, HPS::HighlightAreaOperator, HPS::SelectAreaOperator, HPS::ZoomBoxOperator, HPS::ConstructRectangleOperator, HPS::ZoomOperator, HPS::RelativeOrbitOperator, HPS::OrbitOperator, HPS::PanOperator, HPS::PanOrbitZoomOperator, and SpaceMouseOperator.
◆ IsMouseTriggered()
virtual bool HPS::Operator::IsMouseTriggered |
( |
MouseState const & |
in_state | ) |
|
|
inlinevirtual |
◆ ObjectType()
HPS::Type HPS::Operator::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
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.
Reimplemented from HPS::Object.
◆ OnKeyDown()
virtual bool HPS::Operator::OnKeyDown |
( |
KeyboardState const & |
in_state | ) |
|
|
inlinevirtual |
◆ OnKeyUp()
virtual bool HPS::Operator::OnKeyUp |
( |
KeyboardState const & |
in_state | ) |
|
|
inlinevirtual |
◆ OnModelAttached()
virtual void HPS::Operator::OnModelAttached |
( |
| ) |
|
|
inlinevirtual |
◆ OnModelDetached()
virtual void HPS::Operator::OnModelDetached |
( |
| ) |
|
|
inlinevirtual |
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 | ) |
|
|
inlinevirtual |
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 | ) |
|
|
inlinevirtual |
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 | ) |
|
|
inlinevirtual |
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 | ) |
|
|
inlinevirtual |
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 | ) |
|
|
inlinevirtual |
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 | ) |
|
|
inlinevirtual |
◆ OnTextInput()
virtual bool HPS::Operator::OnTextInput |
( |
HPS::UTF8 const & |
in_text | ) |
|
|
inlinevirtual |
◆ OnTimerTick()
◆ OnTouchDown()
virtual bool HPS::Operator::OnTouchDown |
( |
TouchState const & |
in_state | ) |
|
|
inlinevirtual |
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 | ) |
|
|
inlinevirtual |
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 | ) |
|
|
inlinevirtual |
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::Operator::OnViewAttached |
( |
HPS::View const & |
in_attached_view | ) |
|
|
inlinevirtual |
This function is called whenever a view is attached to this operator.
- Parameters
-
in_attached_view | The view attached to this operator. |
Reimplemented in HPS::Exchange::MeasurementOperator, HPS::Exchange::CommonMeasurementOperator, HPS::NavigationCubeOperator, HPS::AxisTriadOperator, HPS::HandlesOperator, HPS::AnnotationOperator, HPS::MarkupOperator, HPS::CuttingSectionOperator, HPS::SimpleWalkOperator, HPS::WalkOperator, HPS::FlyOperator, HPS::MouseWheelOperator, HPS::HighlightAreaOperator, HPS::SelectAreaOperator, HPS::ConstructRectangleOperator, and SpaceMouseOperator.
◆ OnViewDetached()
virtual void HPS::Operator::OnViewDetached |
( |
HPS::View const & |
in_detached_view | ) |
|
|
inlinevirtual |
◆ operator!=()
virtual bool HPS::Operator::operator!= |
( |
Operator const & |
in_that | ) |
const |
|
virtual |
Tests this operator for non-equality against the parameter in_that.
◆ operator==()
virtual bool HPS::Operator::operator== |
( |
Operator const & |
in_that | ) |
const |
|
virtual |
Tests this operator for equality against the parameter in_that. Same as Operator::Equals.
◆ SetModifierTrigger()
void HPS::Operator::SetModifierTrigger |
( |
ModifierKeys |
in_modifiers | ) |
|
|
inline |
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 | ) |
|
|
inline |
Sets the mouse trigger for this operator
The documentation for this class was generated from the following file: