Custom gizmo that is used for providing custom visualization and editing (handles) for 3D Spatial objects. See godot.EditorSpatialGizmoPlugin
for more information.
Constructor
Methods
addCollisionSegments(segments:HaxeArray<Vector3>):Void
Adds the specified segments
to the gizmo's collision shape for picking. Call this function during godot.EditorSpatialGizmo.redraw
.
addCollisionTriangles(triangles:TriangleMesh):Void
Adds collision triangles to the gizmo for picking. A godot.TriangleMesh
can be generated from a regular godot.Mesh
too. Call this function during godot.EditorSpatialGizmo.redraw
.
addHandles(handles:Array<Vector3>, material:Material, ?billboard:Bool, ?secondary:Bool):Void
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 godot.EditorSpatialGizmo.redraw
.
addLines(lines:Array<Vector3>, material:Material, ?billboard:Bool, ?modulate:Color):Void
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 godot.EditorSpatialGizmo.redraw
.
Parameters:
modulate | If the parameter is null, then the default value is new Color(1, 1, 1, 1) |
---|
addMesh(mesh:Mesh, ?billboard:Bool, ?skeleton:SkinReference, ?material:Material):Void
Adds a mesh to the gizmo with the specified billboard
state, skeleton
and material
. If billboard
is true
, the mesh will rotate to always face the camera. Call this function during godot.EditorSpatialGizmo.redraw
.
addUnscaledBillboard(material:Material, ?defaultScale:Single, ?modulate:Color):Void
Adds an unscaled billboard for visualization. Call this function during godot.EditorSpatialGizmo.redraw
.
Parameters:
modulate | If the parameter is null, then the default value is new Color(1, 1, 1, 1) |
---|
commitHandle(index:Int, restore:Dynamic, cancel:Bool):Void
Commit a handle being edited (handles must have been previously added by godot.EditorSpatialGizmo.addHandles
).
If the cancel
parameter is true
, an option to restore the edited value to the original is provided.
getHandleName(index:Int):String
Gets the name of an edited handle (handles must have been previously added by godot.EditorSpatialGizmo.addHandles
).
Handles can be named for reference to the user when editing.
getHandleValue(index:Int):Dynamic
Gets actual value of a handle. This value can be anything and used for eventually undoing the motion when calling godot.EditorSpatialGizmo.commitHandle
.
getPlugin():EditorSpatialGizmoPlugin
Returns the godot.EditorSpatialGizmoPlugin
that owns this gizmo. It's useful to retrieve materials using godot.EditorSpatialGizmoPlugin.getMaterial
.
isHandleHighlighted(index:Int):Bool
Returns true
if the handle at index index
is highlighted by being hovered with the mouse.
redraw():Void
This function is called when the godot.Spatial
this gizmo refers to changes (the godot.Spatial.updateGizmo
is called).
setHandle(index:Int, camera:Camera, point:Vector2):Void
This function is used when the user drags a gizmo handle (previously added with godot.EditorSpatialGizmo.addHandles
) in screen coordinates.
The godot.Camera
is also provided so screen coordinates can be converted to raycasts.
setHidden(hidden:Bool):Void
Sets the gizmo's hidden state. If true
, the gizmo will be hidden. If false
, it will be shown.
setSpatialNode(node:Node):Void
Sets the reference godot.Spatial
node for the gizmo. node
must inherit from godot.Spatial
.