EditorSpatialGizmo

Custom gizmo for editing Spatial objects.

Custom gizmo that is used for providing custom visualization and editing (handles) for 3D Spatial objects. These are created by EditorPlugin.createSpatialGizmo.

Members

Aliases

BaseClasses
alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses)
Undocumented in source.

Functions

addCollisionSegments
void addCollisionSegments(PoolVector3Array segments)
addCollisionTriangles
void addCollisionTriangles(TriangleMesh triangles)

Add collision triangles to the gizmo for picking. A TriangleMesh can be generated from a regular Mesh too. Call this function during redraw.

addHandles
void addHandles(PoolVector3Array handles, Material material, bool billboard, bool secondary)

Add 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
void addLines(PoolVector3Array lines, Material material, bool billboard)

Add 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
void addMesh(ArrayMesh mesh, bool billboard, RID skeleton)
addUnscaledBillboard
void addUnscaledBillboard(Material material, double default_scale)

Add an unscaled billboard for visualization. Call this function during redraw.

clear
void clear()
commitHandle
void commitHandle(long index, VariantArg1 restore, bool cancel)

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
String getHandleName(long index)

Get 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
Variant getHandleValue(long index)

Get actual value of a handle. This value can be anything and used for eventually undoing the motion when calling commitHandle

opAssign
EditorSpatialGizmo opAssign(T n)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(EditorSpatialGizmo other)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(typeof(null) n)
Undocumented in source. Be warned that the author may not have intended to support it.
redraw
void redraw()

This function is called when the Spatial this gizmo refers to changes (the Spatial.updateGizmo is called).

setHandle
void setHandle(long index, Camera camera, Vector2 point)

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
void setHidden(bool hidden)
setSpatialNode
void setSpatialNode(GodotObject node)

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Static functions

_new
EditorSpatialGizmo _new()
Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized
bool _classBindingInitialized;
Undocumented in source.

Structs

_classBinding
struct _classBinding
Undocumented in source.

Unions

__anonymous
union __anonymous
Undocumented in source.

Variables

_GODOT_internal_name
enum string _GODOT_internal_name;
Undocumented in source.

Mixed In Members

From mixin baseCasts

as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
ToRef as()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(ToRef)
Undocumented in source.
opCast
void* opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
godot_object opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
bool opCast()
Undocumented in source. Be warned that the author may not have intended to support it.

Meta