API Search || Global Search
HPS.NavigationCubeOperator Class Reference

More...

Inheritance diagram for HPS.NavigationCubeOperator:
HPS.Operator HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override string GetName ()
 Returns the name of the operator. More...
 
double GetTransitionTime ()
 Gets the duration of transitions, specified in seconds. More...
 
 NavigationCubeOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 NavigationCubeOperator (HPS.MouseButtons in_mouse_trigger)
 
 NavigationCubeOperator (HPS.NavigationCubeOperator in_that)
 
delegate int NavigationCubeOperatorDelegate_0 (IntPtr cPtr, int ret_maxsize, IntPtr ret_str)
 
delegate bool NavigationCubeOperatorDelegate_1 (IntPtr cPtr, IntPtr in_state)
 
delegate HPS.Type NavigationCubeOperatorDelegate_10 (IntPtr cPtr)
 
delegate void NavigationCubeOperatorDelegate_11 (IntPtr cPtr, IntPtr in_that)
 
delegate bool NavigationCubeOperatorDelegate_12 (IntPtr cPtr, IntPtr in_that)
 
delegate bool NavigationCubeOperatorDelegate_13 (IntPtr cPtr, IntPtr in_state)
 
delegate bool NavigationCubeOperatorDelegate_14 (IntPtr cPtr, IntPtr in_state)
 
delegate bool NavigationCubeOperatorDelegate_15 (IntPtr cPtr, IntPtr in_state)
 
delegate bool NavigationCubeOperatorDelegate_16 (IntPtr cPtr, IntPtr in_state)
 
delegate bool NavigationCubeOperatorDelegate_17 (IntPtr cPtr, IntPtr in_state)
 
delegate bool NavigationCubeOperatorDelegate_18 (IntPtr cPtr, string in_text)
 
delegate bool NavigationCubeOperatorDelegate_19 (IntPtr cPtr, IntPtr in_event)
 
delegate bool NavigationCubeOperatorDelegate_2 (IntPtr cPtr, IntPtr in_state)
 
delegate void NavigationCubeOperatorDelegate_20 (IntPtr cPtr)
 
delegate bool NavigationCubeOperatorDelegate_21 (IntPtr cPtr, IntPtr in_state)
 
delegate HPS.Type NavigationCubeOperatorDelegate_22 (IntPtr cPtr)
 
delegate bool NavigationCubeOperatorDelegate_23 (IntPtr cPtr)
 
delegate void NavigationCubeOperatorDelegate_24 (IntPtr cPtr)
 
delegate bool NavigationCubeOperatorDelegate_3 (IntPtr cPtr, IntPtr in_state)
 
delegate bool NavigationCubeOperatorDelegate_4 (IntPtr cPtr, IntPtr in_state)
 
delegate bool NavigationCubeOperatorDelegate_5 (IntPtr cPtr, IntPtr in_state)
 
delegate bool NavigationCubeOperatorDelegate_6 (IntPtr cPtr, IntPtr in_state)
 
delegate void NavigationCubeOperatorDelegate_7 (IntPtr cPtr, IntPtr in_attached_view)
 
delegate void NavigationCubeOperatorDelegate_8 (IntPtr cPtr, IntPtr in_attached_view)
 
delegate void NavigationCubeOperatorDelegate_9 (IntPtr cPtr)
 
override 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...
 
override bool OnMouseDown (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed. This function starts the operator and computes the position of the starting point. More...
 
override bool OnMouseMove (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals the mouse moved This function orbits the camera. More...
 
override bool OnMouseUp (HPS.MouseState in_state)
 This function is called whenever HPS receives a MouseEvent that signals a mouse button was released. This function stops the operator. More...
 
override bool OnTouchDown (HPS.TouchState in_state)
 This function is called whenever HPS receives a TouchEvent that signals the device was touched. More...
 
override bool OnTouchMove (HPS.TouchState in_state)
 This function is called whenever HPS receives a TouchEvent that signals a point of contact has moved. This function orbits the camera as needed. More...
 
override bool OnTouchUp (HPS.TouchState in_state)
 This function is called whenever HPS receives a TouchEvent that signals a point of contact has been released. This function stops the operator. More...
 
override void OnViewAttached (HPS.View in_attached_view)
 This function is called whenever a view is attached to this operator. More...
 
override void OnViewDetached (HPS.View in_attached_view)
 This function is called whenever a view is detached from this operator. More...
 
void SetReferenceSegment (HPS.KeyPath in_path_to_segment)
 Sets a key path to the segment used as a reference. All rotations use the transformed bounding of the segment pointed to by the path provided in order to correctly position the camera. By default the reference segment is the View segment. More...
 
void SetReferenceSegment (HPS.KeyPath[] in_path_to_segments)
 Sets a group of key paths to segments to be used as a reference. All rotations happen around the combined bounding box of the reference segments, taking into account transformation sets along their key paths By default the reference segment is the View segment. More...
 
void SetTransitionTime (double in_time)
 Sets how long the navigation cube will take to complete a transition when a user clicks on one of its faces. More...
 
HPS.KeyPath[] ShowReferenceSegment ()
 Returns the key paths to the segments used as a reference for rotations By default the reference segment is the View segment. More...
 
- Public Member Functions inherited from HPS.Operator
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 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 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 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 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...
 
 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...
 
- 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 ()
 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...
 

Protected Member Functions

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

Additional Inherited Members

- Public Types inherited from HPS.Operator
enum  Priority { Low = 0, Default = 1, High = 2 }
 
- Static Public Member Functions inherited from HPS.Operator
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 Attributes inherited from HPS.Operator
HandleRef sptr
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
- Static Protected Attributes inherited from HPS.Operator
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 NavigationCubeOperator class defines an operator which allows the user to interact with the navigation cube.

This Operator works for both mouse- and touch-driven devices.

Mouse-Driver Devices:

Left Button Down:

Snap view to plane

Left Button Down and Move:

Rotates the scene

Touch-Driven Devices:

Tap:

Snaps view to plane

Tap and Move:

Rotates the scene

In order to use the NavigationCubeOperator, it's necessary to call HPS.NavigationCubeControl.SetInteractivity(true) first.

Note

The orientation of the NavigationCubeControl is specified by the model in the associated view. See HPS.Model.SetOrientation().

Member Function Documentation

override string HPS.NavigationCubeOperator.GetName ( )
inlinevirtual

Returns the name of the operator.

Reimplemented from HPS.Operator.

double HPS.NavigationCubeOperator.GetTransitionTime ( )
inline

Gets the duration of transitions, specified in seconds.

Returns
How long it will take the navigation cube to complete a transition when a user clicks on one of its faces, in seconds
override void HPS.NavigationCubeOperator.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 from HPS.Operator.

override bool HPS.NavigationCubeOperator.OnMouseDown ( HPS.MouseState  in_state)
inlinevirtual

This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed. This function starts the operator and computes the position of the starting point.

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

Reimplemented from HPS.Operator.

override bool HPS.NavigationCubeOperator.OnMouseMove ( HPS.MouseState  in_state)
inlinevirtual

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

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

Reimplemented from HPS.Operator.

override bool HPS.NavigationCubeOperator.OnMouseUp ( HPS.MouseState  in_state)
inlinevirtual

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

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

Reimplemented from HPS.Operator.

override bool HPS.NavigationCubeOperator.OnTouchDown ( HPS.TouchState  in_state)
inlinevirtual

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

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

Reimplemented from HPS.Operator.

override bool HPS.NavigationCubeOperator.OnTouchMove ( HPS.TouchState  in_state)
inlinevirtual

This function is called whenever HPS receives a TouchEvent that signals a point of contact has moved. This function orbits the camera as needed.

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

Reimplemented from HPS.Operator.

override bool HPS.NavigationCubeOperator.OnTouchUp ( HPS.TouchState  in_state)
inlinevirtual

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

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

Reimplemented from HPS.Operator.

override void HPS.NavigationCubeOperator.OnViewAttached ( HPS.View  in_attached_view)
inlinevirtual

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

Parameters
in_attached_viewThe view attached to this operator.

Reimplemented from HPS.Operator.

override void HPS.NavigationCubeOperator.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 from HPS.Operator.

void HPS.NavigationCubeOperator.SetReferenceSegment ( HPS.KeyPath  in_path_to_segment)
inline

Sets a key path to the segment used as a reference. All rotations use the transformed bounding of the segment pointed to by the path provided in order to correctly position the camera. By default the reference segment is the View segment.

Parameters
in_path_to_segmentthe key path to the segment to rotate around.
void HPS.NavigationCubeOperator.SetReferenceSegment ( HPS.KeyPath[]  in_path_to_segments)
inline

Sets a group of key paths to segments to be used as a reference. All rotations happen around the combined bounding box of the reference segments, taking into account transformation sets along their key paths By default the reference segment is the View segment.

Parameters
in_path_to_segmentsthe key paths to the segments to rotate around.
void HPS.NavigationCubeOperator.SetTransitionTime ( double  in_time)
inline

Sets how long the navigation cube will take to complete a transition when a user clicks on one of its faces.

Parameters
in_timehow long the navigation cube will take to complete a transition when a user clicks on one of its faces. Specified in seconds.
Returns
A reference to this object. By default the navigation cube will take 0.5 seconds to complete transitions.
HPS.KeyPath [] HPS.NavigationCubeOperator.ShowReferenceSegment ( )
inline

Returns the key paths to the segments used as a reference for rotations By default the reference segment is the View segment.

Returns
the key paths to segments the navigation cube rotates around.

The documentation for this class was generated from the following file:
  • internals/hps_sprk/source/cs/HPS.NavigationCubeOperator.cs