
Public Types | |
enum | Priority { Low = 0, Default = 1, High = 2 } |
Public Member Functions | |
virtual void | Assign (HPS.Operator in_that) |
Assigns the parameter in_that to this operator, resulting in a clone. More... | |
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) |
Tests this operator for equality against the parameter in_that. Same as Operator.operator== More... | |
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 () |
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. If no view is attached to this operator, this function will not be called. More... | |
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. 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 | OnTextInput (string in_text) |
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 (HPS.View in_attached_view) |
This function is called whenever a view is attached to this operator. More... | |
virtual void | OnViewDetached (HPS.View in_detached_view) |
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 (IntPtr cPtr) |
delegate void | OperatorDelegate_1 (IntPtr cPtr, IntPtr in_that) |
delegate bool | OperatorDelegate_10 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_11 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_12 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_13 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_14 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_15 (IntPtr cPtr, string in_text) |
delegate bool | OperatorDelegate_16 (IntPtr cPtr, IntPtr in_event) |
delegate void | OperatorDelegate_17 (IntPtr cPtr, IntPtr in_attached_view) |
delegate void | OperatorDelegate_18 (IntPtr cPtr, IntPtr in_detached_view) |
delegate void | OperatorDelegate_19 (IntPtr cPtr) |
delegate bool | OperatorDelegate_2 (IntPtr cPtr, IntPtr in_that) |
delegate void | OperatorDelegate_20 (IntPtr cPtr) |
delegate bool | OperatorDelegate_21 (IntPtr cPtr, IntPtr in_state) |
delegate HPS.Type | OperatorDelegate_22 (IntPtr cPtr) |
delegate bool | OperatorDelegate_23 (IntPtr cPtr) |
delegate void | OperatorDelegate_24 (IntPtr cPtr) |
delegate int | OperatorDelegate_3 (IntPtr cPtr, int ret_maxsize, IntPtr ret_str) |
delegate bool | OperatorDelegate_4 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_5 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_6 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_7 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_8 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_9 (IntPtr cPtr, IntPtr in_state) |
delegate void | RemoveCacheItemDelegate (IntPtr cPtr) |
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. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
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. 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 () |
virtual bool | DerivedClassHasMethod (string methodName, System.Type[] methodTypes) |
override IntPtr | GetNonDirectorClassID () |
virtual bool | IsUserDerived () |
![]() | |
override void | deleteCptr () |
Protected Attributes | |
HandleRef | sptr |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Static Protected Attributes | |
static Dictionary< IntPtr, Operator > | cachedObjects = new Dictionary<IntPtr, Operator>() |
static Dictionary< IntPtr, WeakReference > | cachedWeakRefs = new Dictionary<IntPtr, WeakReference>() |
static ReaderWriterLockSlim | mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion) |
Detailed Description
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
Member Function Documentation
|
inlinevirtual |
Assigns the parameter in_that to this operator, resulting in a clone.
|
inline |
|
inlinevirtual |
Tests this operator for equality against the parameter in_that. Same as Operator.operator==
|
inline |
|
inline |
Gets the modifier trigger associated with this operator.
|
inline |
Gets the mouse trigger associated with this operator.
|
inlinevirtual |
Returns the name of the Operator.
Reimplemented in HPS.Exchange.MeasurementOperator, HPS.Exchange.CommonMeasurementOperator, HPS.HandlesOperator, HPS.CuttingSectionOperator, HPS.NavigationCubeOperator, HPS.WalkOperator, HPS.MouseWheelOperator, HPS.SimpleWalkOperator, HPS.HighlightOperator, HPS.MarkupOperator, HPS.ConstructRectangleOperator, HPS.SelectAreaOperator, HPS.SelectOperator, HPS.AnnotationOperator, HPS.HighlightAreaOperator, HPS.RelativeOrbitOperator, HPS.AxisTriadOperator, HPS.FlyOperator, HPS.OrbitOperator, HPS.PanOperator, HPS.PanOrbitZoomOperator, HPS.TurntableOperator, HPS.ZoomOperator, HPS.ZoomBoxOperator, and HPS.ZoomFitTouchOperator.
|
inlinevirtual |
Returns true if the MouseButtons and ModifierKeys are active.
Reimplemented in HPS.SimpleWalkOperator.
|
inlinevirtual |
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.MarkupOperator, HPS.AnnotationOperator, HPS.SimpleWalkOperator, and HPS.FlyOperator.
|
inlinevirtual |
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.
|
inlinevirtual |
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.CuttingSectionOperator, HPS.MouseWheelOperator, HPS.WalkOperator, and HPS.SimpleWalkOperator.
|
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.
|
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.CuttingSectionOperator, HPS.SimpleWalkOperator, HPS.HandlesOperator, HPS.NavigationCubeOperator, HPS.FlyOperator, HPS.MarkupOperator, HPS.AnnotationOperator, HPS.ConstructRectangleOperator, HPS.HighlightOperator, HPS.AxisTriadOperator, HPS.OrbitOperator, HPS.PanOperator, HPS.PanOrbitZoomOperator, HPS.TurntableOperator, HPS.ZoomOperator, HPS.SelectOperator, and HPS.RelativeOrbitOperator.
|
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.
|
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.
|
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.CuttingSectionOperator, HPS.SimpleWalkOperator, HPS.HandlesOperator, HPS.NavigationCubeOperator, HPS.FlyOperator, HPS.MarkupOperator, HPS.AnnotationOperator, HPS.AxisTriadOperator, HPS.OrbitOperator, HPS.PanOperator, HPS.PanOrbitZoomOperator, HPS.TurntableOperator, HPS.ZoomOperator, HPS.ConstructRectangleOperator, and HPS.RelativeOrbitOperator.
|
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.CuttingSectionOperator, HPS.SimpleWalkOperator, HPS.HandlesOperator, HPS.NavigationCubeOperator, HPS.FlyOperator, HPS.MarkupOperator, HPS.ConstructRectangleOperator, HPS.AxisTriadOperator, HPS.OrbitOperator, HPS.PanOperator, HPS.PanOrbitZoomOperator, HPS.TurntableOperator, HPS.ZoomOperator, HPS.SelectAreaOperator, HPS.RelativeOrbitOperator, HPS.HighlightAreaOperator, and HPS.ZoomBoxOperator.
|
inlinevirtual |
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.FlyOperator, HPS.SimpleWalkOperator, HPS.TurntableOperator, and HPS.MouseWheelOperator.
|
inlinevirtual |
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.SimpleWalkOperator, HPS.CuttingSectionOperator, HPS.FlyOperator, and HPS.WalkOperator.
|
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.SimpleWalkOperator, HPS.CuttingSectionOperator, HPS.HandlesOperator, HPS.FlyOperator, HPS.NavigationCubeOperator, HPS.MarkupOperator, HPS.TurntableOperator, HPS.AnnotationOperator, HPS.AxisTriadOperator, HPS.OrbitOperator, HPS.PanOperator, HPS.PanOrbitZoomOperator, HPS.ZoomOperator, HPS.ConstructRectangleOperator, HPS.RelativeOrbitOperator, HPS.HighlightOperator, HPS.SelectOperator, and HPS.ZoomFitTouchOperator.
|
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.CuttingSectionOperator, HPS.SimpleWalkOperator, HPS.HandlesOperator, HPS.FlyOperator, HPS.NavigationCubeOperator, HPS.MarkupOperator, HPS.TurntableOperator, HPS.AnnotationOperator, HPS.AxisTriadOperator, HPS.OrbitOperator, HPS.PanOperator, HPS.PanOrbitZoomOperator, HPS.ZoomOperator, HPS.ConstructRectangleOperator, and HPS.RelativeOrbitOperator.
|
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.SimpleWalkOperator, HPS.CuttingSectionOperator, HPS.HandlesOperator, HPS.FlyOperator, HPS.NavigationCubeOperator, HPS.MarkupOperator, HPS.TurntableOperator, HPS.AnnotationOperator, HPS.AxisTriadOperator, HPS.OrbitOperator, HPS.PanOperator, HPS.PanOrbitZoomOperator, HPS.ConstructRectangleOperator, HPS.RelativeOrbitOperator, HPS.SelectAreaOperator, HPS.HighlightAreaOperator, HPS.ZoomBoxOperator, and HPS.ZoomFitTouchOperator.
|
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.FlyOperator, HPS.NavigationCubeOperator, HPS.AxisTriadOperator, HPS.HandlesOperator, HPS.CuttingSectionOperator, HPS.MouseWheelOperator, HPS.WalkOperator, HPS.SimpleWalkOperator, HPS.MarkupOperator, HPS.ConstructRectangleOperator, HPS.SelectAreaOperator, HPS.AnnotationOperator, and HPS.HighlightAreaOperator.
|
inlinevirtual |
This function is called whenever a view is detached from this operator.
- Parameters
-
in_detached_view The view detached from this operator.
Reimplemented in HPS.Exchange.MeasurementOperator, HPS.Exchange.CommonMeasurementOperator, HPS.FlyOperator, HPS.NavigationCubeOperator, HPS.HandlesOperator, HPS.CuttingSectionOperator, HPS.MarkupOperator, and HPS.AnnotationOperator.
|
inline |
Sets the modifier trigger associated with this operator.
- Parameters
-
in_modifiers The modifier keys that are used to trigger this operator.
|
inline |
Sets the mouse trigger for this operator
The documentation for this class was generated from the following file:
- internals/hps_sprk/source/cs/HPS.Operator.cs