The HandlesOperator class defines an operator which allows the user to move geometry. This Operator works for both mouse- and touch-driven devices.To operate this operator on a mouse-driven device: Double click on a piece of geometry to activate the handles Click and drag the handles to move the selected geometry Click on the background to dismiss the handlesTo operate this operator on a touch-driven device: Double tap on a piece of geometry to activate the handles Tap and drag the handles to move the selected geometry Tap on the background to dismiss the handlesThis operator works on the segment containing the geometry selected. An event of type GeometryTransformedEvent in injected after the handles are dismissed, containing the information on which segment was affected and what transform was applied to it. More...

Classes | |
class | GeometryTransformedEvent |
Public Member Functions | |
override void | Dispose () |
void | GetHandlesAppearance (out float out_length, out float out_radius, out float out_offset, out float out_angle, out ulong out_handles_points, out float out_tip_size) |
HPS.MaterialKit[] | GetHandlesColors () |
HPS.RGBAColor | GetHighlightColor () |
override string | GetName () |
Returns the name of the operator. More... | |
bool | GetTrailingGeometry () |
HandlesOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger) | |
HandlesOperator (HPS.MouseButtons in_mouse_trigger) | |
HandlesOperator (HPS.HandlesOperator in_that) | |
delegate int | HandlesOperatorDelegate_0 (int ret_maxsize, IntPtr ret_str) |
delegate void | HandlesOperatorDelegate_1 () |
delegate void | HandlesOperatorDelegate_10 (IntPtr in_that) |
delegate bool | HandlesOperatorDelegate_11 (IntPtr in_that) |
delegate bool | HandlesOperatorDelegate_12 (IntPtr in_state) |
delegate bool | HandlesOperatorDelegate_13 (IntPtr in_state) |
delegate bool | HandlesOperatorDelegate_14 (IntPtr in_state) |
delegate bool | HandlesOperatorDelegate_15 (IntPtr in_state) |
delegate bool | HandlesOperatorDelegate_16 (IntPtr in_state) |
delegate bool | HandlesOperatorDelegate_17 (string in_text) |
delegate bool | HandlesOperatorDelegate_18 (IntPtr in_event) |
delegate void | HandlesOperatorDelegate_19 () |
delegate void | HandlesOperatorDelegate_2 () |
delegate void | HandlesOperatorDelegate_20 () |
delegate bool | HandlesOperatorDelegate_21 (IntPtr in_state) |
delegate bool | HandlesOperatorDelegate_22 () |
delegate void | HandlesOperatorDelegate_23 () |
delegate bool | HandlesOperatorDelegate_3 (IntPtr in_state) |
delegate bool | HandlesOperatorDelegate_4 (IntPtr in_state) |
delegate bool | HandlesOperatorDelegate_5 (IntPtr in_state) |
delegate bool | HandlesOperatorDelegate_6 (IntPtr in_state) |
delegate bool | HandlesOperatorDelegate_7 (IntPtr in_state) |
delegate bool | HandlesOperatorDelegate_8 (IntPtr in_state) |
delegate HPS.Type | HandlesOperatorDelegate_9 () |
override bool | OnMouseDown (HPS.MouseState in_state) |
This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed. If the user double clicks on a piece of geometry, handles will be inserted there. If the user clicks on a handle, the segment containing that handle will be translated or rotated appropriately. The user can click on the background to remove the handles. More... | |
override bool | OnMouseMove (HPS.MouseState in_state) |
This function is called whenever HPS receives a MouseEvent that signals the mouse moved When users click and drag a handle, the associated geometry will be translated or rotated as appropriate. More... | |
override bool | OnMouseUp (HPS.MouseState in_state) |
This function is called whenever HPS receives a MouseEvent that signals a mouse button was released More... | |
override bool | OnTouchDown (HPS.TouchState in_state) |
This function is called whenever HPS receives a TouchEvent that signals the device was touched. If the user double taps a piece of geometry, handles will be inserted there. If the user taps on a handle, the segment containing that handle will be translated or rotated appropriately. The user can tap on the background to remove the handles. 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. When users click and drag a handle, the associated geometry will be translated or rotated as appropriate. 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. More... | |
override void | OnViewAttached () |
This function is called whenever a view is attached to this operator. More... | |
override void | OnViewDetached () |
This function is called whenever a view is detached from this operator. More... | |
void | SetHandlesAppearance (float in_length, float in_radius, float in_offset, float in_angle, ulong in_handles_points, float in_tip_size) |
void | SetHandlesAppearance (float in_length, float in_radius, float in_offset, float in_angle, ulong in_handles_points) |
void | SetHandlesAppearance (float in_length, float in_radius, float in_offset, float in_angle) |
void | SetHandlesAppearance (float in_length, float in_radius, float in_offset) |
void | SetHandlesAppearance (float in_length, float in_radius) |
void | SetHandlesAppearance (float in_length) |
void | SetHandlesAppearance () |
void | SetHandlesColors (HPS.MaterialKit[] in_colors) |
This function is used to provide a set of colors which will be applied to the handles. The changes will take effect the next time the handles are inserted. The materials need to contain a diffuse color, and will be applied as follows: Entry 0 - translation handle in the x direction Entry 1 - translation handle in the y direction Entry 2 - translation handle in the z direction Entry 3 - rotation handle in the x direction Entry 4 - rotation handle in the y direction Entry 5 - rotation handle in the z direction More... | |
void | SetHighlightColor (HPS.RGBAColor in_highlight_color) |
void | SetTrailingGeometry (bool in_state) |
![]() | |
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... | |
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 () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
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 | 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... | |
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 () |
delegate void | OperatorDelegate_1 (IntPtr in_that) |
delegate bool | OperatorDelegate_10 (IntPtr in_state) |
delegate bool | OperatorDelegate_11 (IntPtr in_state) |
delegate bool | OperatorDelegate_12 (IntPtr in_state) |
delegate bool | OperatorDelegate_13 (IntPtr in_state) |
delegate bool | OperatorDelegate_14 (IntPtr in_state) |
delegate bool | OperatorDelegate_15 (string in_text) |
delegate bool | OperatorDelegate_16 (IntPtr in_event) |
delegate void | OperatorDelegate_17 () |
delegate void | OperatorDelegate_18 () |
delegate void | OperatorDelegate_19 () |
delegate bool | OperatorDelegate_2 (IntPtr in_that) |
delegate void | OperatorDelegate_20 () |
delegate bool | OperatorDelegate_21 (IntPtr in_state) |
delegate bool | OperatorDelegate_22 () |
delegate void | OperatorDelegate_23 () |
delegate int | OperatorDelegate_3 (int ret_maxsize, IntPtr ret_str) |
delegate bool | OperatorDelegate_4 (IntPtr in_state) |
delegate bool | OperatorDelegate_5 (IntPtr in_state) |
delegate bool | OperatorDelegate_6 (IntPtr in_state) |
delegate bool | OperatorDelegate_7 (IntPtr in_state) |
delegate bool | OperatorDelegate_8 (IntPtr in_state) |
delegate bool | OperatorDelegate_9 (IntPtr in_state) |
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... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
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... | |
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 IntPtr | GetNonDirectorClassID () |
![]() | |
void | DtorCallback (IntPtr p) |
Additional Inherited Members | |
![]() | |
enum | Priority { Low = 0, Default = 1, High = 2 } |
![]() | |
static bool | operator!= (HPS.Operator a, HPS.Operator b) |
static bool | operator== (HPS.Operator a, HPS.Operator b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
HandleRef | sptr |
HandleRef | wptr |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
![]() | |
static Dictionary< IntPtr, Operator > | cachedObjects = new Dictionary<IntPtr, Operator>() |
static Dictionary< IntPtr, WeakReference > | weakRefs = new Dictionary<IntPtr, WeakReference>() |
Detailed Description
The HandlesOperator class defines an operator which allows the user to move geometry. This Operator works for both mouse- and touch-driven devices.To operate this operator on a mouse-driven device: Double click on a piece of geometry to activate the handles Click and drag the handles to move the selected geometry Click on the background to dismiss the handlesTo operate this operator on a touch-driven device: Double tap on a piece of geometry to activate the handles Tap and drag the handles to move the selected geometry Tap on the background to dismiss the handlesThis operator works on the segment containing the geometry selected. An event of type GeometryTransformedEvent in injected after the handles are dismissed, containing the information on which segment was affected and what transform was applied to it.
Member Function Documentation
|
inlinevirtual |
Returns the name of the operator.
Reimplemented from HPS.Operator.
|
inlinevirtual |
This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed. If the user double clicks on a piece of geometry, handles will be inserted there. If the user clicks on a handle, the segment containing that handle will be translated or rotated appropriately. The user can click on the background to remove the handles.
- Parameters
-
in_state A MouseState object describing the current mouse state.
- Returns
- true if the input event was handled, false otherwise.
Reimplemented from HPS.Operator.
|
inlinevirtual |
This function is called whenever HPS receives a MouseEvent that signals the mouse moved When users click and drag a handle, the associated geometry will be translated or rotated as appropriate.
- Parameters
-
in_state A MouseState object describing the current mouse state.
- Returns
- true if the input event was handled, false otherwise.
Reimplemented from HPS.Operator.
|
inlinevirtual |
This function is called whenever HPS receives a MouseEvent that signals a mouse button was released
- Parameters
-
in_state A MouseState object describing the current mouse state.
- Returns
- true if the input event was handled, false otherwise.
Reimplemented from HPS.Operator.
|
inlinevirtual |
This function is called whenever HPS receives a TouchEvent that signals the device was touched. If the user double taps a piece of geometry, handles will be inserted there. If the user taps on a handle, the segment containing that handle will be translated or rotated appropriately. The user can tap on the background to remove the handles.
- Parameters
-
in_state A TouchState object describing the current touch state.
- Returns
- true if the input event was handled, false otherwise.
Reimplemented from HPS.Operator.
|
inlinevirtual |
This function is called whenever HPS receives a TouchEvent that signals a point of contact has moved. When users click and drag a handle, the associated geometry will be translated or rotated as appropriate.
- Parameters
-
in_state A TouchState object describing the current touch state.
- Returns
- true if the input event was handled, false otherwise.
Reimplemented from HPS.Operator.
|
inlinevirtual |
This function is called whenever HPS receives a TouchEvent that signals a point of contact has been released.
- Parameters
-
in_state A TouchState object describing the current touch state.
- Returns
- true if the input event was handled, false otherwise.
Reimplemented from HPS.Operator.
|
inlinevirtual |
This function is called whenever a view is attached to this operator.
Reimplemented from HPS.Operator.
|
inlinevirtual |
This function is called whenever a view is detached from this operator.
Reimplemented from HPS.Operator.
|
inline |
This function is used to provide a set of colors which will be applied to the handles. The changes will take effect the next time the handles are inserted. The materials need to contain a diffuse color, and will be applied as follows: Entry 0 - translation handle in the x direction Entry 1 - translation handle in the y direction Entry 2 - translation handle in the z direction Entry 3 - rotation handle in the x direction Entry 4 - rotation handle in the y direction Entry 5 - rotation handle in the z direction
- Parameters
-
in_colors An array of materials to be applied to the handles.
The documentation for this class was generated from the following file:
- internals/hps_sprk_ops/source/cs/HPS.HandlesOperator.cs