EditorSpatialGizmo

    Custom gizmo for editing Spatial objects.

    Custom gizmo that is used for providing custom visualization and editing (handles) for 3D Spatial objects. See for more information.

    Adds the specified to the gizmo’s collision shape for picking. Call this function during .

    • void add_handles ( handles, Material material, billboard=false, bool secondary=false )

    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 .

    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.

    • void add_mesh ( mesh, bool billboard=false, skeleton=null, Material material=null )

    Adds a mesh to the gizmo with the specified billboard state, skeleton and material. If is true, the mesh will rotate to always face the camera. Call this function during .

    • void add_unscaled_billboard ( Material material, default_scale=1, Color modulate=Color( 1, 1, 1, 1 ) )

    Adds an unscaled billboard for visualization. Call this function during .

    • void clear ( )

    Removes everything in the gizmo including meshes, collisions and handles.

    • void commit_handle ( int index, restore, bool cancel=false ) virtual

    Commit a handle being edited (handles must have been previously added by ).

    If the cancel parameter is true, an option to restore the edited value to the original is provided.

    • String get_handle_name ( index ) virtual

    Gets the name of an edited handle (handles must have been previously added by add_handles).

    Handles can be named for reference to the user when editing.

    • get_handle_value ( int index ) virtual

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

    Returns the EditorSpatialGizmoPlugin that owns this gizmo. It’s useful to retrieve materials using .

    • Spatial get_spatial_node ( ) const

    Returns the Spatial node associated with this gizmo.

    • is_handle_highlighted ( int index ) virtual

    Returns if the handle at index index is highlighted by being hovered with the mouse.

    • void redraw ( ) virtual

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

    • void set_handle ( index, Camera camera, point ) virtual

    This function is used when the user drags a gizmo handle (previously added with add_handles) in screen coordinates.

    The is also provided so screen coordinates can be converted to raycasts.

    • void set_hidden ( bool hidden )

    Sets the gizmo’s hidden state. If true, the gizmo will be hidden. If false, it will be shown.

    • void set_spatial_node ( node )