Operator

class HPS.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

Public Types

enum Priority

Values:

Low

Default

High

Public Functions

void Assign (HPS.Operator 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.

override void Dispose ()

delegate void DtorDelegate (IntPtr cPtr)

bool Equals (HPS.Operator in_that): Tests this operator for equality against the parameter in_that. Same as Operator.operator==

override bool Equals (Object obj)

HPS.View GetAttachedView (): Returns the View the Operator is currently attached to.

override int GetHashCode ()

HPS.ModifierKeys GetModifierTrigger (): Gets the modifier trigger associated with this operator.

HPS.MouseButtons GetMouseTrigger (): Gets the mouse trigger associated with this operator.

string GetName (): Returns the name of the Operator.

bool IsMouseTriggered (HPS.MouseState in_state): Returns true if the MouseButtons and ModifierKeys are active.

override HPS.Type ObjectType ()

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

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

bool OnKeyDown (HPS.KeyboardState in_state)

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

Param in_state: A KeyboardState object describing the current keyboard state.
Return: true if the input event was handled, false otherwise.

bool OnKeyUp (HPS.KeyboardState in_state)

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

Param in_state: A KeyboardState object describing the current keyboard state.
Return: true if the input event was handled, false otherwise.

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.

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.

bool OnMouseDown (HPS.MouseState in_state)

This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed.

Param in_state: A MouseState object describing the current mouse state.
Return: true if the input event was handled, false otherwise.

bool OnMouseEnter (HPS.MouseState in_state)

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

Param in_state: A MouseState object describing the current mouse state.
Return: true if the input event was handled, false otherwise.

bool OnMouseLeave (HPS.MouseState in_state)

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

Param in_state: A MouseState object describing the current mouse state.
Return: true if the input event was handled, false otherwise.

bool OnMouseMove (HPS.MouseState in_state)

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

Param in_state: A MouseState object describing the current mouse state.
Return: true if the input event was handled, false otherwise.

bool OnMouseUp (HPS.MouseState in_state)

This function is called whenever HPS receives a MouseEvent that signals a mouse button was released.

Param in_state: A MouseState object describing the current mouse state.
Return: true if the input event was handled, false otherwise.

bool OnMouseWheel (HPS.MouseState in_state)

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

Param in_state: A MouseState object describing the current mouse state.
Return: true if the input event was handled, false otherwise.

bool OnTextInput (string in_text)

bool OnTimerTick (HPS.TimerTickEvent in_event)

This function is called whenever HPS receives a TimerTickEvent.

Param in_event: A TimerTickEvent object describing the current event state.
Return: true if the input event was handled, false otherwise.

bool OnTouchDown (HPS.TouchState in_state)

This function is called whenever HPS receives a TouchEvent that signals the device was touched.

Param in_state: A TouchState object describing the current touch state.
Return: true if the input event was handled, false otherwise.

bool OnTouchMove (HPS.TouchState in_state)

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

Param in_state: A TouchState object describing the current touch state.
Return: true if the input event was handled, false otherwise.

bool OnTouchUp (HPS.TouchState in_state)

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

Param in_state: A TouchState object describing the current touch state.
Return: true if the input event was handled, false otherwise.

void OnViewAttached (HPS.View in_attached_view)

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

Param in_attached_view: The view attached to this operator.

void OnViewDetached (HPS.View in_detached_view)

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

Param in_detached_view: The view detached from this operator.

Operator ()

Operator (HPS.MouseButtons in_mouse_trigger)

Operator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)

Operator (HPS.Operator in_that)

delegate void RemoveCacheItemDelegate (IntPtr cPtr)

void SetModifierTrigger (HPS.ModifierKeys in_modifiers)

Sets the modifier trigger associated with this operator.

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

void SetMouseTrigger (HPS.MouseButtons in_buttons): Sets the mouse trigger for this operator

Public Static Functions

bool operator!= (HPS.Operator a, HPS.Operator b)

bool operator== (HPS.Operator a, HPS.Operator b)