Struct EditorSpatialGizmo
Custom gizmo for editing Spatial objects.
struct EditorSpatialGizmo
;
Custom gizmo that is used for providing custom visualization and editing (handles) for 3D Spatial objects. See EditorSpatialGizmoPlugin for more information.
Methods
| Name | Description |
|---|---|
addCollisionSegments
|
|
addCollisionTriangles
|
Adds collision triangles to the gizmo for picking. A TriangleMesh can be generated from a regular Mesh too. Call this function during redraw.
|
addHandles
|
Adds a list of handles (points) which can be used to deform the object being edited.
There are virtual functions which will be called upon editing of these handles. Call this function during redraw.
|
addLines
|
Adds lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during redraw.
|
addMesh
|
|
addUnscaledBillboard
|
Adds an unscaled billboard for visualization. Call this function during redraw.
|
clear
|
|
commitHandle
|
Commit a handle being edited (handles must have been previously added by addHandles).
If the cancel parameter is true, an option to restore the edited value to the original is provided.
|
getHandleName
|
Gets the name of an edited handle (handles must have been previously added by addHandles).
Handles can be named for reference to the user when editing.
|
getHandleValue
|
Gets actual value of a handle. This value can be anything and used for eventually undoing the motion when calling commitHandle.
|
getPlugin
|
Returns the EditorSpatialGizmoPlugin that owns this gizmo. It's useful to retrieve materials using EditorSpatialGizmoPlugin.
|
getSpatialNode
|
Returns the Spatial node associated with this gizmo. |
isHandleHighlighted
|
Gets whether a handle is highlighted or not. |
redraw
|
This function is called when the Spatial this gizmo refers to changes (the Spatial is called).
|
setHandle
|
This function is used when the user drags a gizmo handle (previously added with addHandles) in screen coordinates.
The Camera is also provided so screen coordinates can be converted to raycasts.
|
setHidden
|
|
setSpatialNode
|