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

Public Types

enum  ZoomType { ZoomType.Fast = 0, ZoomType.Accurate = 1 }
 
- Public Types inherited from HPS.Operator
enum  Priority { Low = 0, Default = 1, High = 2 }
 

Public Member Functions

override void Dispose ()
 
override string GetName ()
 
 MouseWheelOperator (HPS.MouseWheelOperator.ZoomType in_default_type, HPS.ModifierKeys in_alternate_type_modifiers)
 
 MouseWheelOperator (HPS.MouseWheelOperator.ZoomType in_default_type)
 
 MouseWheelOperator ()
 
 MouseWheelOperator (HPS.MouseWheelOperator in_that)
 
override void OnModelAttached ()
 
override bool OnMouseWheel (HPS.MouseState in_state)
 
override void OnViewAttached (HPS.View in_attached_view)
 
void UpdateZoomLimit ()
 
- Public Member Functions inherited from HPS.Operator
virtual void Assign (HPS.Operator in_that)
 
void DetachView ()
 
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 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 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 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 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
 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 ()
 

Protected Member Functions

override void deleteCptr ()
 
override bool DerivedClassHasMethod (string methodName, System.Type[] methodTypes)
 
override IntPtr GetNonDirectorClassID ()
 
override bool IsUserDerived ()
 

Additional Inherited Members

- 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, OperatorcachedObjects = new Dictionary<IntPtr, Operator>()
 
static Dictionary< IntPtr, WeakReference > cachedWeakRefs = new Dictionary<IntPtr, WeakReference>()
 
static ReaderWriterLockSlim mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion)
 

Member Enumeration Documentation

◆ ZoomType

Enumerator
Fast 

The operator optimizes for time. It is possible to zoom through geometry.

Accurate 

The operator optimizes zooming so that it is not possible to zoom through geometry.

Constructor & Destructor Documentation

◆ MouseWheelOperator() [1/3]

HPS.MouseWheelOperator.MouseWheelOperator ( HPS.MouseWheelOperator.ZoomType  in_default_type,
HPS.ModifierKeys  in_alternate_type_modifiers 
)
inline

Constructor for MouseWheelOperator

Parameters
in_default_typeThe default zoom type for this operator.
in_alternate_type_modifiersThe modifier button that, when pressed, will activate the zoom type opposite to that specified in in_default_type. Passing an empty ModifierKey object prevents the zoom type from being anything but what was specified in in_default_type.

◆ MouseWheelOperator() [2/3]

HPS.MouseWheelOperator.MouseWheelOperator ( HPS.MouseWheelOperator.ZoomType  in_default_type)
inline

Constructor for MouseWheelOperator

Parameters
in_default_typeThe default zoom type for this operator.

◆ MouseWheelOperator() [3/3]

HPS.MouseWheelOperator.MouseWheelOperator ( )
inline

Constructor for MouseWheelOperator

Member Function Documentation

◆ GetName()

override string HPS.MouseWheelOperator.GetName ( )
inlinevirtual

Returns the name of the Operator.

Reimplemented from HPS.Operator.

◆ OnModelAttached()

override void HPS.MouseWheelOperator.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.

◆ OnMouseWheel()

override bool HPS.MouseWheelOperator.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 from HPS.Operator.

◆ OnViewAttached()

override void HPS.MouseWheelOperator.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.

◆ UpdateZoomLimit()

void HPS.MouseWheelOperator.UpdateZoomLimit ( )
inline

Call when scene bounds changes to update the mouse wheel zoom limit


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