HPS.CuttingSectionOperator Class Reference
Inheritance diagram for HPS.CuttingSectionOperator:
HPS.SelectOperator HPS.Operator HPS.Sprocket HPS.Object

Public Member Functions

 CuttingSectionOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 CuttingSectionOperator (HPS.MouseButtons in_mouse_trigger)
 
 CuttingSectionOperator (HPS.CuttingSectionOperator in_that)
 
override void Dispose ()
 
float GetIndicatorScale ()
 
bool GetIndicatorVisibility ()
 
bool GetMouseOverHighlighting ()
 
override string GetName ()
 
HPS.HighlightOptionsKit GetPlaneHighlightOptions ()
 
HPS.MaterialMappingKit GetPlaneMaterial ()
 
HPS.Plane [] GetPlanes ()
 
bool GetPlaneVisibility ()
 
bool GetSectioning ()
 
override void OnModelAttached ()
 
override bool OnMouseDown (HPS.MouseState in_state)
 
override bool OnMouseMove (HPS.MouseState in_state)
 
override bool OnMouseUp (HPS.MouseState in_state)
 
override bool OnTimerTick (HPS.TimerTickEvent in_event)
 
override bool OnTouchDown (HPS.TouchState in_state)
 
override bool OnTouchMove (HPS.TouchState in_state)
 
override bool OnTouchUp (HPS.TouchState in_state)
 
override void OnViewAttached (HPS.View in_attached_view)
 
override void OnViewDetached (HPS.View in_detached_view)
 
void SetIndicatorScale (float in_scale)
 
void SetIndicatorVisibility (bool in_use_indicator)
 
void SetMouseOverHighlighting (bool in_enable_mouse_over_highlighting)
 
void SetPlaneHighlightOptions (HPS.HighlightOptionsKit in_highlight_options)
 
void SetPlaneMaterial (HPS.MaterialMappingKit in_plane_material)
 
void SetPlanes (HPS.Plane[] in_planes)
 
void SetPlaneVisibility (bool in_visibility)
 
void SetSectioning (bool in_sectioning)
 
- Public Member Functions inherited from HPS.SelectOperator
override void Dispose ()
 
HPS.SelectionResults GetActiveSelection ()
 
override string GetName ()
 
HPS.SelectionOptionsKit GetSelectionOptions ()
 
override bool OnMouseDown (HPS.MouseState in_state)
 
override bool OnTouchDown (HPS.TouchState in_state)
 
 SelectOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)
 
 SelectOperator (HPS.MouseButtons in_mouse_trigger)
 
 SelectOperator ()
 
 SelectOperator (HPS.SelectOperator in_that)
 
void SetSelectionOptions (HPS.SelectionOptionsKit in_options)
 
- 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 OnMouseEnter (HPS.MouseState in_state)
 
virtual bool OnMouseLeave (HPS.MouseState in_state)
 
virtual bool OnMouseWheel (HPS.MouseState in_state)
 
virtual bool OnTextInput (string in_text)
 
 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 ()
 
- Protected Member Functions inherited from HPS.SelectOperator
override void deleteCptr ()
 
override bool DerivedClassHasMethod (string methodName, System.Type[] methodTypes)
 
override IntPtr GetNonDirectorClassID ()
 
override bool IsUserDerived ()
 

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

Detailed Description

Member Function Documentation

◆ GetIndicatorScale()

float HPS.CuttingSectionOperator.GetIndicatorScale ( )
inline

Returns the scale used for the normal indicator displayed while mousing over the model when the operator is first started.

Returns
The scale of the normal indicator.

◆ GetIndicatorVisibility()

bool HPS.CuttingSectionOperator.GetIndicatorVisibility ( )
inline

Whether the plane normal indicator is visible

Returns
true if the plane normal indicator is visible, false otherwise.

◆ GetMouseOverHighlighting()

bool HPS.CuttingSectionOperator.GetMouseOverHighlighting ( )
inline

Whether mouse-over highlighting is enabled

Returns
true if mouse-over highlighting is enabled, false otherwise.

◆ GetName()

override string HPS.CuttingSectionOperator.GetName ( )
inlinevirtual

Returns the name of the operator.

Reimplemented from HPS.Operator.

◆ GetPlaneHighlightOptions()

HPS.HighlightOptionsKit HPS.CuttingSectionOperator.GetPlaneHighlightOptions ( )
inline

Returns the highlight options kit used when hovering over geometry, when mouse-over highlighting is enabled.

Returns
the highlight options kit used when hovering over geometry, when mouse-over highlighting is enabled.

◆ GetPlaneMaterial()

HPS.MaterialMappingKit HPS.CuttingSectionOperator.GetPlaneMaterial ( )
inline

Returns the material mapping kit applied to the cutting plane geometry.

Returns
The material mapping kit applied to the cutting plane geometry.

◆ GetPlanes()

HPS.Plane [] HPS.CuttingSectionOperator.GetPlanes ( )
inline

This function returns the planes associated with the active cutting sections

Returns
planes associated with the active cutting sections.

◆ GetPlaneVisibility()

bool HPS.CuttingSectionOperator.GetPlaneVisibility ( )
inline

Whether the cutting sections plane representations are visible

Returns
true if the cutting sections plane representations are visible, false otherwise.

◆ GetSectioning()

bool HPS.CuttingSectionOperator.GetSectioning ( )
inline

Whether sectioning is enabled

Returns
true if sectioning is enabled, false otherwise.

◆ OnModelAttached()

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

◆ OnMouseDown()

override bool HPS.CuttingSectionOperator.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. When the operator is first started, this function inserts a cutting section.

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

Reimplemented from HPS.Operator.

◆ OnMouseMove()

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

This function is called whenever HPS receives a MouseEvent that signals the mouse moved When the operator is first started this function displays a normal indicator when the user mouses over geometry. After a cutting section has been inserted this function allows the user to translate a cutting section along its normal

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

Reimplemented from HPS.Operator.

◆ OnMouseUp()

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

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

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

Reimplemented from HPS.Operator.

◆ OnTimerTick()

override bool HPS.CuttingSectionOperator.OnTimerTick ( HPS.TimerTickEvent  in_event)
inlinevirtual

This function is called whenever HPS receives a TimerTickEvent This function moves the camera

Returns
true if the input event was handled, false otherwise.

Reimplemented from HPS.Operator.

◆ OnTouchDown()

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

This function is called whenever HPS receives a TouchEvent that signals the device was touched. This function starts the operator and computes the position of the starting point. When the operator is first started, this function inserts a cutting section.

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

Reimplemented from HPS.Operator.

◆ OnTouchMove()

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

This function is called whenever HPS receives a TouchEvent that signals a point of contact has moved. After a cutting section has been inserted this function allows the user to translate a cutting section along its normal

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

Reimplemented from HPS.Operator.

◆ OnTouchUp()

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

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

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

Reimplemented from HPS.Operator.

◆ OnViewAttached()

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

◆ OnViewDetached()

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

◆ SetIndicatorScale()

void HPS.CuttingSectionOperator.SetIndicatorScale ( float  in_scale)
inline

Sets the scale of the normal indicator displayed while mousing over the model when the operator is first started.

Parameters
in_scaleThe scale of the normal indicator

◆ SetIndicatorVisibility()

void HPS.CuttingSectionOperator.SetIndicatorVisibility ( bool  in_use_indicator)
inline

This function allows the user to pick a cutting sections through the aid of a normal indicator when moving the mouse By default this mode is active when the operator is fist attached to a View

Parameters
in_use_indicatorWhether to insert cutting sections through a normal indicator.

◆ SetMouseOverHighlighting()

void HPS.CuttingSectionOperator.SetMouseOverHighlighting ( bool  in_enable_mouse_over_highlighting)
inline

Sets the mouse-over highlighting behavior

Parameters
in_enable_mouse_over_highlightingWhether to enable mouse-over highlighting.

◆ SetPlaneHighlightOptions()

void HPS.CuttingSectionOperator.SetPlaneHighlightOptions ( HPS.HighlightOptionsKit  in_highlight_options)
inline

Sets the highlight options kit used when hovering over geometry, when mouse-over highlighting is enabled.

Parameters
in_highlight_optionsThe highlight options kit used when hovering over geometry, when mouse-over highlighting is enabled.

◆ SetPlaneMaterial()

void HPS.CuttingSectionOperator.SetPlaneMaterial ( HPS.MaterialMappingKit  in_plane_material)
inline

Sets the material mapping kit applied to the cutting plane geometry.

Parameters
in_plane_materialThe material mapping kit applied to the cutting plane geometry.

◆ SetPlanes()

void HPS.CuttingSectionOperator.SetPlanes ( HPS.Plane []  in_planes)
inline

This function programmatically assigns cutting planes to this operator from plane equations. If this operator has already had cutting planes associated with it, the cutting planes set using this function replace the previous cutting planes.

Parameters
in_planesAn array of Plane objects describing the cutting planes to be inserted.

◆ SetPlaneVisibility()

void HPS.CuttingSectionOperator.SetPlaneVisibility ( bool  in_visibility)
inline

Sets the visibility of cutting sections plane representation The cutting sections plane representation visibility is on by default.

Parameters
in_visibilityWhether to enable the visibility of the cutting sections plane representation.

◆ SetSectioning()

void HPS.CuttingSectionOperator.SetSectioning ( bool  in_sectioning)
inline

Sets the sectioning behavior When sectioning is turned on the cutting planes are grouped together into a section

Parameters
in_sectioningWhether to enable sectioning.

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