HPS.CuttingSectionOperator

class HPS.CuttingSectionOperator : public HPS.SelectOperator

Public Functions

float GetIndicatorScale ()

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

Return

The scale of the normal indicator.

bool GetIndicatorVisibility ()

Whether the plane normal indicator is visible

Return

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

bool GetMouseOverHighlighting ()

Whether mouse-over highlighting is enabled

Return

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

override string GetName ()

Returns the name of the operator.

HPS.HighlightOptionsKit GetPlaneHighlightOptions ()

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

Return

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

HPS.MaterialMappingKit GetPlaneMaterial ()

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

Return

The material mapping kit applied to the cutting plane geometry.

HPS.Plane[] GetPlanes ()

This function returns the planes associated with the active cutting sections

Return

planes associated with the active cutting sections.

bool GetPlaneVisibility ()

Whether the cutting sections plane representations are visible

Return

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

bool GetSectioning ()

Whether sectioning is enabled

Return

true if sectioning is enabled, false otherwise.

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

Param in_state

A MouseState object describing the current mouse state.

Return

true if the input event was handled, false otherwise.

override bool OnMouseMove (HPS.MouseState in_state)

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

Param in_state

A MouseState object describing the current mouse state.

Return

true if the input event was handled, false otherwise.

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

override bool OnTimerTick (HPS.TimerTickEvent in_event)

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

Return

true if the input event was handled, false otherwise.

override bool OnTouchDown (HPS.TouchState in_state)

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.

Param in_state

A TouchState object describing the current touch state.

Return

true if the input event was handled, false otherwise.

override bool OnTouchMove (HPS.TouchState in_state)

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

Param in_state

A TouchState object describing the current touch state.

Return

true if the input event was handled, false otherwise.

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.

Param in_state

A TouchState object describing the current touch state.

Return

true if the input event was handled, false otherwise.

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

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

void SetIndicatorScale (float in_scale)

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

Param in_scale

The scale of the normal indicator

void SetIndicatorVisibility (bool in_use_indicator)

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

Param in_use_indicator

Whether to insert cutting sections through a normal indicator.

void SetMouseOverHighlighting (bool in_enable_mouse_over_highlighting)

Sets the mouse-over highlighting behavior

Param in_enable_mouse_over_highlighting

Whether to enable mouse-over highlighting.

void SetPlaneHighlightOptions (HPS.HighlightOptionsKit in_highlight_options)

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

Param in_highlight_options

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

void SetPlaneMaterial (HPS.MaterialMappingKit in_plane_material)

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

Param in_plane_material

The material mapping kit applied to the cutting plane geometry.

void SetPlanes (HPS.Plane[] in_planes)

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.

Param in_planes

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

void SetPlaneVisibility (bool in_visibility)

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

Param in_visibility

Whether to enable the visibility of the cutting sections plane representation.

void SetSectioning (bool in_sectioning)

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

Param in_sectioning

Whether to enable sectioning.