EditorEntity3DGizmo

public void AddCollisionSegments(Vector3[] segments);

Add local segments for editor gizmo picking. This is picking geometry, not a game physics collider. Call during redraw.

public void AddCollisionSegments(ReadOnlySpan<Vector3> segments);

Add local segments for editor gizmo picking. This is picking geometry, not a game physics collider. Call during redraw.

public void AddCollisionTriangles(TriangleMesh triangles);

Adds collision triangles to the gizmo for picking. A TriangleMesh can be generated from a regular Mesh too. Call this method during EditorEntity3DGizmo._Redraw.

public void AddHandles(Vector3[] handles, Material material, int[] ids, bool billboard = false, bool secondary = false);

Add interactive points only for a selected, editable gizmo. Implement update/commit callbacks to change properties; points alone do not change data.

public void AddHandles(ReadOnlySpan<Vector3> handles, Material material, ReadOnlySpan<int> ids, bool billboard, bool secondary);

Add interactive points only for a selected, editable gizmo. Implement update/commit callbacks to change properties; points alone do not change data.

public void AddLines(Vector3[] lines, Material material, bool billboard = false, Color? modulate = default);

Add lines as pairs of local points. Call after Clear() during redraw. Lines alone do not create handles or physics collisions.

public void AddLines(ReadOnlySpan<Vector3> lines, Material material, bool billboard, Color? modulate);

Add lines as pairs of local points. Call after Clear() during redraw. Lines alone do not create handles or physics collisions.

public void AddMesh(Mesh mesh, Material material = null, Transform3D? transform = default, SkinReference skeleton = null);

Adds a mesh to the gizmo with the specified material, local transform and skeleton. Call this method during EditorEntity3DGizmo._Redraw.

public void AddUnscaledBillboard(Material material, float defaultScale = 1f, Color? modulate = default);

Adds an unscaled billboard for visualization and selection. Call this method during EditorEntity3DGizmo._Redraw.

public void Clear();

Clear accumulated gizmo geometry and picking data. Call at the beginning of redraw before adding lines and handles again. This does not delete the Entity.

public Entity3D GetEntity3D();

Return the Entity3D bound to this gizmo instance. Added geometry uses its local coordinates.

public EditorEntity3DGizmoPlugin GetPlugin();

Return the serving handler. Use it to retrieve materials; do not dispose it while registered or in use.

public int[] GetSubgizmoSelection();

Returns a list of the currently selected subgizmos. Can be used to highlight selected elements during EditorEntity3DGizmo._Redraw.

public bool IsSelected();

Read editor gizmo selection state. This is neither Entity visibility nor a physics query.

public bool IsSubgizmoSelected(int id);

Returns true if the given subgizmo is currently selected. Can be used to highlight selected elements during EditorEntity3DGizmo._Redraw.

public void SetEntity3D(Entity node);

Sets the reference Entity3D node for the gizmo. node must inherit from Entity3D.

public void SetHidden(bool hidden);

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

public virtual void _CommitHandle(int id, bool secondary, Variant restore, bool cancel);

Override this method to commit a handle being edited (handles must have been previously added by EditorEntity3DGizmo.AddHandles). This usually means creating an UndoRedo action for the change, using the current handle value as "do" and the restore argument as "undo". If the cancel argument is true, the restore value should be directly set, without any UndoRedo action. The secondary argument is true when the committed handle is secondary (see EditorEntity3DGizmo.AddHandles for more information).

public virtual void _CommitSubgizmos(int[] ids, Reckfell.Collections.Array<Transform3D> restores, bool cancel);

Override this method to commit a group of subgizmos being edited (see EditorEntity3DGizmo._SubgizmosIntersectRay and EditorEntity3DGizmo._SubgizmosIntersectFrustum). This usually means creating an UndoRedo action for the change, using the current transforms as "do" and the restores transforms as "undo". If the cancel argument is true, the restores transforms should be directly set, without any UndoRedo action.

public virtual string _GetHandleName(int id, bool secondary);

Override this method to return the name of an edited handle (handles must have been previously added by EditorEntity3DGizmo.AddHandles). Handles can be named for reference to the user when editing. The secondary argument is true when the requested handle is secondary (see EditorEntity3DGizmo.AddHandles for more information).

public virtual Variant _GetHandleValue(int id, bool secondary);

Override this method to return the current value of a handle. This value will be requested at the start of an edit and used as the restore argument in EditorEntity3DGizmo._CommitHandle. The secondary argument is true when the requested handle is secondary (see EditorEntity3DGizmo.AddHandles for more information).

public virtual Transform3D _GetSubgizmoTransform(int id);

Override this method to return the current transform of a subgizmo. This transform will be requested at the start of an edit and used as the restore argument in EditorEntity3DGizmo._CommitSubgizmos.

public virtual bool _IsHandleHighlighted(int id, bool secondary);

Override this method to return true whenever the given handle should be highlighted in the editor. The secondary argument is true when the requested handle is secondary (see EditorEntity3DGizmo.AddHandles for more information).

public virtual void _Redraw();

Override this method to add all the gizmo elements whenever a gizmo update is requested. It's common to call EditorEntity3DGizmo.Clear at the beginning of this method and then add visual elements depending on the node's properties.

public virtual void _SetHandle(int id, bool secondary, Camera3D camera, Vector2 point);

Override this method to update the node properties when the user drags a gizmo handle (previously added with EditorEntity3DGizmo.AddHandles). The provided point is the mouse position in screen coordinates and the camera can be used to convert it to raycasts. The secondary argument is true when the edited handle is secondary (see EditorEntity3DGizmo.AddHandles for more information).

public virtual void _SetSubgizmoTransform(int id, Transform3D transform);

Override this method to update the node properties during subgizmo editing (see EditorEntity3DGizmo._SubgizmosIntersectRay and EditorEntity3DGizmo._SubgizmosIntersectFrustum). The transform is given in the Entity3D's local coordinate system.

public virtual int[] _SubgizmosIntersectFrustum(Camera3D camera, Reckfell.Collections.Array<Plane> frustum);

Override this method to allow selecting subgizmos using mouse drag box selection. Given a camera and a frustum, this method should return which subgizmos are contained within the frustum. The frustum argument consists of an array with all the Planes that make up the selection frustum. The returned value should contain a list of unique subgizmo identifiers, which can have any non-negative value and will be used in other virtual methods like EditorEntity3DGizmo._GetSubgizmoTransform or EditorEntity3DGizmo._CommitSubgizmos.

public virtual int _SubgizmosIntersectRay(Camera3D camera, Vector2 point);

Override this method to allow selecting subgizmos using mouse clicks. Given a camera and a point in screen coordinates, this method should return which subgizmo should be selected. The returned value should be a unique subgizmo identifier, which can have any non-negative value and will be used in other virtual methods like EditorEntity3DGizmo._GetSubgizmoTransform or EditorEntity3DGizmo._CommitSubgizmos.