Inheritance diagram for HPS.Operator:
HPS.Sprocket HPS.Object HPS.AnnotationOperator HPS.AxisTriadOperator HPS.ConstructRectangleOperator HPS.Exchange.CommonMeasurementOperator HPS.FlyOperator HPS.HandlesOperator HPS.MarkupOperator HPS.MouseWheelOperator HPS.NavigationCubeOperator HPS.OrbitOperator HPS.PanOperator HPS.PanOrbitZoomOperator HPS.RelativeOrbitOperator HPS.SelectOperator HPS.TurntableOperator HPS.ZoomFitTouchOperator HPS.ZoomOperator

Public Types

enum  Priority { Low = 0, Default = 1, High = 2 }
 

Public Member Functions

virtual void Assign (HPS.Operator in_that)
 
void DetachView ()
 
override void Dispose ()
 
delegate void DtorDelegate (IntPtr cPtr)
 
override bool Equals (System.Object obj)
 
virtual bool Equals (HPS.Operator in_that)
 
HPS.View GetAttachedView ()
 
override int GetHashCode ()
 
HPS.ModifierKeys GetModifierTrigger ()
 
HPS.MouseButtons GetMouseTrigger ()
 
virtual string GetName ()
 
virtual bool IsMouseTriggered (HPS.MouseState in_state)
 
override HPS.Type ObjectType ()
 
virtual bool OnKeyDown (HPS.KeyboardState in_state)
 
virtual bool OnKeyUp (HPS.KeyboardState in_state)
 
virtual void OnModelAttached ()
 
virtual void OnModelDetached ()
 
virtual bool OnMouseDown (HPS.MouseState in_state)
 
virtual bool OnMouseEnter (HPS.MouseState in_state)
 
virtual bool OnMouseLeave (HPS.MouseState in_state)
 
virtual bool OnMouseMove (HPS.MouseState in_state)
 
virtual bool OnMouseUp (HPS.MouseState in_state)
 
virtual bool OnMouseWheel (HPS.MouseState in_state)
 
virtual bool OnTextInput (string in_text)
 
virtual bool OnTimerTick (HPS.TimerTickEvent in_event)
 
virtual bool OnTouchDown (HPS.TouchState in_state)
 
virtual bool OnTouchMove (HPS.TouchState in_state)
 
virtual bool OnTouchUp (HPS.TouchState in_state)
 
virtual void OnViewAttached (HPS.View in_attached_view)
 
virtual void OnViewDetached (HPS.View in_detached_view)
 
 Operator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 Operator (HPS.MouseButtons in_mouse_trigger)
 
 Operator (HPS.Operator in_that)
 
delegate void RemoveCacheItemDelegate (IntPtr cPtr)
 
void SetModifierTrigger (HPS.ModifierKeys in_modifiers)
 
void SetMouseTrigger (HPS.MouseButtons in_buttons)
 
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static bool operator!= (HPS.Operator a, HPS.Operator b)
 
static bool operator== (HPS.Operator a, HPS.Operator b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
virtual bool DerivedClassHasMethod (string methodName, System.Type[] methodTypes)
 
override IntPtr GetNonDirectorClassID ()
 
virtual bool IsUserDerived ()
 
- Protected Member Functions inherited from HPS.Sprocket
override void deleteCptr ()
 

Protected Attributes

HandleRef sptr
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Static Protected Attributes

static Dictionary< IntPtr, OperatorcachedObjects = 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

◆ Assign()

virtual void HPS.Operator.Assign ( HPS.Operator  in_that)
inlinevirtual

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

◆ DetachView()

void HPS.Operator.DetachView ( )
inline

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

◆ Equals()

virtual bool HPS.Operator.Equals ( HPS.Operator  in_that)
inlinevirtual

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

◆ GetAttachedView()

HPS.View HPS.Operator.GetAttachedView ( )
inline

Returns the View the Operator is currently attached to.

◆ GetModifierTrigger()

HPS.ModifierKeys HPS.Operator.GetModifierTrigger ( )
inline

Gets the modifier trigger associated with this operator.

◆ GetMouseTrigger()

HPS.MouseButtons HPS.Operator.GetMouseTrigger ( )
inline

Gets the mouse trigger associated with this operator.

◆ GetName()

◆ IsMouseTriggered()

virtual bool HPS.Operator.IsMouseTriggered ( HPS.MouseState  in_state)
inlinevirtual

Returns true if the MouseButtons and ModifierKeys are active.

Reimplemented in HPS.SimpleWalkOperator.

◆ ObjectType()

override HPS.Type HPS.Operator.ObjectType ( )
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 ( HPS.KeyboardState  in_state)
inlinevirtual

This function is called whenever HPS receives a KeyboardEvent that signals a key was pressed.

Parameters
in_stateA 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.

◆ OnKeyUp()

virtual bool HPS.Operator.OnKeyUp ( HPS.KeyboardState  in_state)
inlinevirtual

This function is called whenever HPS receives a KeyboardEvent that signals a key was released.

Parameters
in_stateA 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 ( )
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.MouseWheelOperator, HPS.WalkOperator, HPS.SimpleWalkOperator, and HPS.CuttingSectionOperator.

◆ 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 ( HPS.MouseState  in_state)
inlinevirtual

◆ OnMouseEnter()

virtual bool HPS.Operator.OnMouseEnter ( HPS.MouseState  in_state)
inlinevirtual

This function is called whenever HPS receives a MouseEvent that signals the mouse entered the window.

Parameters
in_stateA 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 ( HPS.MouseState  in_state)
inlinevirtual

This function is called whenever HPS receives a MouseEvent that signals the mouse left the window.

Parameters
in_stateA 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 ( HPS.MouseState  in_state)
inlinevirtual

This function is called whenever HPS receives a MouseEvent that signals the mouse moved

Parameters
in_stateA MouseState object describing the current mouse state.
Returns
true if the input event was handled, false otherwise.

Reimplemented in HPS.Exchange.MeasurementOperator, HPS.HandlesOperator, HPS.CuttingSectionOperator, HPS.SimpleWalkOperator, 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.

◆ OnMouseUp()

virtual bool HPS.Operator.OnMouseUp ( HPS.MouseState  in_state)
inlinevirtual

◆ OnMouseWheel()

virtual bool HPS.Operator.OnMouseWheel ( HPS.MouseState  in_state)
inlinevirtual

This function is called whenever HPS receives a MouseEvent that signals the mouse wheel was scrolled.

Parameters
in_stateA 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.

◆ OnTimerTick()

virtual bool HPS.Operator.OnTimerTick ( HPS.TimerTickEvent  in_event)
inlinevirtual

This function is called whenever HPS receives a TimerTickEvent.

Parameters
in_eventA 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.

◆ OnTouchDown()

virtual bool HPS.Operator.OnTouchDown ( HPS.TouchState  in_state)
inlinevirtual

◆ OnTouchMove()

virtual bool HPS.Operator.OnTouchMove ( HPS.TouchState  in_state)
inlinevirtual

This function is called whenever HPS receives a TouchEvent that signals a point of contact has moved.

Parameters
in_stateA 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.HandlesOperator, HPS.CuttingSectionOperator, 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.

◆ OnTouchUp()

virtual bool HPS.Operator.OnTouchUp ( HPS.TouchState  in_state)
inlinevirtual

◆ OnViewAttached()

virtual void HPS.Operator.OnViewAttached ( HPS.View  in_attached_view)
inlinevirtual

◆ OnViewDetached()

virtual void HPS.Operator.OnViewDetached ( HPS.View  in_detached_view)
inlinevirtual

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

Parameters
in_detached_viewThe 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.

◆ SetModifierTrigger()

void HPS.Operator.SetModifierTrigger ( HPS.ModifierKeys  in_modifiers)
inline

Sets the modifier trigger associated with this operator.

Parameters
in_modifiersThe modifier keys that are used to trigger this operator.

◆ SetMouseTrigger()

void HPS.Operator.SetMouseTrigger ( HPS.MouseButtons  in_buttons)
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