REFERENCE MANUAL
The Operator class is the base class for classes which handle under input and operate on the scene. More...
Public Types | |
enum | Priority { Low = 0, Normal = 1, High = 2 } |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
Public Member Functions | |
virtual void | Assign (HPS.Operator in_that) |
void | DetachView () |
Detaches the Operator from the View it was previously attached to. More... | |
override void | Dispose () |
delegate void | DtorDelegate (IntPtr cPtr) |
override bool | Equals (System.Object obj) |
virtual bool | Equals (HPS.Operator in_that) |
HPS.View | GetAttachedView () |
Returns the View the Operator is currently attached to. More... | |
override int | GetHashCode () |
HPS.ModifierKeys | GetModifierTrigger () |
Gets the modifier trigger associated with this operator. More... | |
HPS.MouseButtons | GetMouseTrigger () |
Gets the mouse trigger associated with this operator. More... | |
virtual string | GetName () |
Returns the name of the Operator. More... | |
virtual bool | IsMouseTriggered (HPS.MouseState in_state) |
Returns true if the MouseButtons and ModifierKeys are active. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
virtual bool | OnKeyDown (HPS.KeyboardState in_state) |
This function is called whenever HPS receives a KeyboardEvent that signals a key was pressed. More... | |
virtual bool | OnKeyUp (HPS.KeyboardState in_state) |
This function is called whenever HPS receives a KeyboardEvent that signals a key was released. 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... | |
virtual bool | OnMouseDown (HPS.MouseState in_state) |
This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed. More... | |
virtual bool | OnMouseEnter (HPS.MouseState in_state) |
This function is called whenever HPS receives a MouseEvent that signals the mouse entered the window. More... | |
virtual bool | OnMouseLeave (HPS.MouseState in_state) |
This function is called whenever HPS receives a MouseEvent that signals the mouse left the window. More... | |
virtual bool | OnMouseMove (HPS.MouseState in_state) |
This function is called whenever HPS receives a MouseEvent that signals the mouse moved More... | |
virtual bool | OnMouseUp (HPS.MouseState in_state) |
This function is called whenever HPS receives a MouseEvent that signals a mouse button was released. More... | |
virtual bool | OnMouseWheel (HPS.MouseState in_state) |
This function is called whenever HPS receives a MouseEvent that signals the mouse wheel was scrolled. More... | |
virtual bool | OnTimerTick (HPS.TimerTickEvent in_event) |
This function is called whenever HPS receives a TimerTickEvent. More... | |
virtual bool | OnTouchDown (HPS.TouchState in_state) |
This function is called whenever HPS receives a TouchEvent that signals the device was touched. More... | |
virtual bool | OnTouchMove (HPS.TouchState in_state) |
This function is called whenever HPS receives a TouchEvent that signals a point of contact has moved. More... | |
virtual bool | OnTouchUp (HPS.TouchState 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 void | OnViewDetached () |
This function is called whenever a view is detached from this operator. More... | |
Operator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger) | |
Operator (HPS.MouseButtons in_mouse_trigger) | |
Operator (HPS.Operator in_that) | |
delegate HPS.Type | OperatorDelegate_0 () |
delegate void | OperatorDelegate_1 (IntPtr in_that) |
delegate bool | OperatorDelegate_10 (IntPtr in_state) |
delegate bool | OperatorDelegate_11 (IntPtr in_state) |
delegate bool | OperatorDelegate_12 (IntPtr in_state) |
delegate bool | OperatorDelegate_13 (IntPtr in_state) |
delegate bool | OperatorDelegate_14 (IntPtr in_state) |
delegate bool | OperatorDelegate_15 (IntPtr in_event) |
delegate void | OperatorDelegate_16 () |
delegate void | OperatorDelegate_17 () |
delegate void | OperatorDelegate_18 () |
delegate void | OperatorDelegate_19 () |
delegate bool | OperatorDelegate_2 (IntPtr in_that) |
delegate bool | OperatorDelegate_20 (IntPtr in_state) |
delegate bool | OperatorDelegate_21 () |
delegate void | OperatorDelegate_22 () |
delegate int | OperatorDelegate_3 (int ret_maxsize, IntPtr ret_str) |
delegate bool | OperatorDelegate_4 (IntPtr in_state) |
delegate bool | OperatorDelegate_5 (IntPtr in_state) |
delegate bool | OperatorDelegate_6 (IntPtr in_state) |
delegate bool | OperatorDelegate_7 (IntPtr in_state) |
delegate bool | OperatorDelegate_8 (IntPtr in_state) |
delegate bool | OperatorDelegate_9 (IntPtr in_state) |
void | SetModifierTrigger (HPS.ModifierKeys in_modifiers) |
Sets the modifier trigger associated with this operator. More... | |
void | SetMouseTrigger (HPS.MouseButtons in_buttons) |
Sets the mouse trigger for this operator More... | |
![]() | |
override void | Dispose () |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.Operator a, HPS.Operator b) |
static bool | operator== (HPS.Operator a, HPS.Operator b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
void | DtorCallback (IntPtr p) |
override IntPtr | GetNonDirectorClassID () |
![]() | |
override void | deleteCptr () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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
HPS.ModifierKeys HPS.Operator.GetModifierTrigger | ( | ) |
Gets the modifier trigger associated with this operator.
HPS.MouseButtons HPS.Operator.GetMouseTrigger | ( | ) |
Gets the mouse trigger associated with this operator.
|
virtual |
Returns the name of the Operator.
Reimplemented in HPS.CuttingSectionOperator, HPS.MouseWheelOperator, HPS.WalkOperator, HPS.HighlightOperator, HPS.ConstructRectangleOperator, HPS.SelectAreaOperator, HPS.SelectOperator, HPS.HighlightAreaOperator, HPS.RelativeOrbitOperator, HPS.FlyOperator, HPS.OrbitOperator, HPS.PanOperator, HPS.PanOrbitZoomOperator, HPS.SimpleWalkOperator, HPS.TurntableOperator, HPS.ZoomOperator, HPS.AxisTriadOperator, HPS.NavigationCubeOperator, HPS.ZoomBoxOperator, and HPS.ZoomFitTouchOperator.
|
virtual |
Returns true if the MouseButtons and ModifierKeys are active.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
virtual |
This function is called whenever HPS receives a KeyboardEvent that signals a key was pressed.
in_state | A KeyboardState object describing the current keyboard state. |
Reimplemented in HPS.FlyOperator, and HPS.SimpleWalkOperator.
|
virtual |
This function is called whenever HPS receives a KeyboardEvent that signals a key was released.
in_state | A KeyboardState object describing the current keyboard state. |
Reimplemented in HPS.FlyOperator, and HPS.SimpleWalkOperator.
|
virtual |
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.FlyOperator, HPS.NavigationCubeOperator, HPS.MouseWheelOperator, and HPS.CuttingSectionOperator.
|
virtual |
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.
|
virtual |
This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed.
in_state | A MouseState object describing the current mouse state. |
Reimplemented in HPS.CuttingSectionOperator, HPS.SimpleWalkOperator, HPS.FlyOperator, HPS.ConstructRectangleOperator, HPS.HighlightOperator, HPS.OrbitOperator, HPS.PanOperator, HPS.PanOrbitZoomOperator, HPS.TurntableOperator, HPS.ZoomOperator, HPS.SelectOperator, HPS.RelativeOrbitOperator, HPS.AxisTriadOperator, and HPS.NavigationCubeOperator.
|
virtual |
This function is called whenever HPS receives a MouseEvent that signals the mouse entered the window.
in_state | A MouseState object describing the current mouse state. |
|
virtual |
This function is called whenever HPS receives a MouseEvent that signals the mouse left the window.
in_state | A MouseState object describing the current mouse state. |
|
virtual |
This function is called whenever HPS receives a MouseEvent that signals the mouse moved
in_state | A MouseState object describing the current mouse state. |
Reimplemented in HPS.CuttingSectionOperator, HPS.FlyOperator, HPS.SimpleWalkOperator, HPS.OrbitOperator, HPS.PanOperator, HPS.PanOrbitZoomOperator, HPS.TurntableOperator, HPS.ZoomOperator, HPS.ConstructRectangleOperator, HPS.AxisTriadOperator, HPS.NavigationCubeOperator, and HPS.RelativeOrbitOperator.
|
virtual |
This function is called whenever HPS receives a MouseEvent that signals a mouse button was released.
in_state | A MouseState object describing the current mouse state. |
Reimplemented in HPS.CuttingSectionOperator, HPS.SimpleWalkOperator, HPS.FlyOperator, HPS.ConstructRectangleOperator, HPS.OrbitOperator, HPS.PanOperator, HPS.PanOrbitZoomOperator, HPS.TurntableOperator, HPS.ZoomOperator, HPS.AxisTriadOperator, HPS.NavigationCubeOperator, HPS.SelectAreaOperator, HPS.RelativeOrbitOperator, HPS.HighlightAreaOperator, and HPS.ZoomBoxOperator.
|
virtual |
This function is called whenever HPS receives a MouseEvent that signals the mouse wheel was scrolled.
in_state | A MouseState object describing the current mouse state. |
Reimplemented in HPS.FlyOperator, HPS.TurntableOperator, HPS.SimpleWalkOperator, and HPS.MouseWheelOperator.
|
virtual |
This function is called whenever HPS receives a TimerTickEvent.
in_event | A TimerTickEvent object describing the current event state. |
Reimplemented in HPS.FlyOperator, HPS.CuttingSectionOperator, HPS.SimpleWalkOperator, and HPS.WalkOperator.
|
virtual |
This function is called whenever HPS receives a TouchEvent that signals the device was touched.
in_state | A TouchState object describing the current touch state. |
Reimplemented in HPS.CuttingSectionOperator, HPS.FlyOperator, HPS.SimpleWalkOperator, HPS.TurntableOperator, HPS.OrbitOperator, HPS.PanOperator, HPS.PanOrbitZoomOperator, HPS.ZoomOperator, HPS.ConstructRectangleOperator, HPS.AxisTriadOperator, HPS.NavigationCubeOperator, HPS.RelativeOrbitOperator, HPS.HighlightOperator, HPS.SelectOperator, and HPS.ZoomFitTouchOperator.
|
virtual |
This function is called whenever HPS receives a TouchEvent that signals a point of contact has moved.
in_state | A TouchState object describing the current touch state. |
Reimplemented in HPS.CuttingSectionOperator, HPS.FlyOperator, HPS.SimpleWalkOperator, HPS.TurntableOperator, HPS.OrbitOperator, HPS.PanOperator, HPS.PanOrbitZoomOperator, HPS.ZoomOperator, HPS.AxisTriadOperator, HPS.NavigationCubeOperator, HPS.ConstructRectangleOperator, and HPS.RelativeOrbitOperator.
|
virtual |
This function is called whenever HPS receives a TouchEvent that signals a point of contact has been released.
in_state | A TouchState object describing the current touch state. |
Reimplemented in HPS.SimpleWalkOperator, HPS.CuttingSectionOperator, HPS.FlyOperator, HPS.TurntableOperator, HPS.OrbitOperator, HPS.PanOperator, HPS.PanOrbitZoomOperator, HPS.AxisTriadOperator, HPS.NavigationCubeOperator, HPS.ConstructRectangleOperator, HPS.RelativeOrbitOperator, HPS.SelectAreaOperator, HPS.HighlightAreaOperator, HPS.ZoomBoxOperator, and HPS.ZoomFitTouchOperator.
|
virtual |
This function is called whenever a view is attached to this operator.
Reimplemented in HPS.FlyOperator, HPS.AxisTriadOperator, HPS.NavigationCubeOperator, HPS.CuttingSectionOperator, HPS.WalkOperator, HPS.ConstructRectangleOperator, HPS.SelectAreaOperator, and HPS.HighlightAreaOperator.
|
virtual |
This function is called whenever a view is detached from this operator.
Reimplemented in HPS.FlyOperator, HPS.AxisTriadOperator, HPS.NavigationCubeOperator, and HPS.CuttingSectionOperator.
void HPS.Operator.SetModifierTrigger | ( | HPS.ModifierKeys | in_modifiers | ) |
Sets the modifier trigger associated with this operator.
in_modifiers | The modifier keys that are used to trigger this operator. |
void HPS.Operator.SetMouseTrigger | ( | HPS.MouseButtons | in_buttons | ) |
Sets the mouse trigger for this operator