EditorNode3DGizmo

package
v0.0.0-...-e10d1cd Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 17, 2025 License: MIT Imports: 35 Imported by: 0

Documentation

Overview

Gizmo that is used for providing custom visualization and editing (handles and subgizmos) for Node3D objects. Can be overridden to create custom gizmos, but for simple gizmos creating an EditorNode3DGizmoPlugin is usually recommended.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsEditorNode3DGizmo() Instance
}

type Expanded

type Expanded = MoreArgs

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this [Extension]See Interface for methods that can be overridden by T.

func (*Extension[T]) AsEditorNode3DGizmo

func (self *Extension[T]) AsEditorNode3DGizmo() Instance

func (*Extension[T]) AsNode3DGizmo

func (self *Extension[T]) AsNode3DGizmo() Node3DGizmo.Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

type ID

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Implementation

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance

type Instance [1]gdclass.EditorNode3DGizmo

Instance of the class with convieniently typed arguments and results.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AddCollisionSegments

func (self Instance) AddCollisionSegments(segments []Vector3.XYZ)

Adds the specified 'segments' to the gizmo's collision shape for picking. Call this method during Redraw.

func (Instance) AddCollisionTriangles

func (self Instance) AddCollisionTriangles(triangles TriangleMesh.Instance)

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

func (Instance) AddHandles

func (self Instance) AddHandles(handles []Vector3.XYZ, material Material.Instance, ids []int32)

Adds a list of handles (points) which can be used to edit the properties of the gizmo's Node3D. The 'ids' argument can be used to specify a custom identifier for each handle, if an empty array is passed, the ids will be assigned automatically from the 'handles' argument order.

The 'secondary' argument marks the added handles as secondary, meaning they will normally have lower selection priority than regular handles. When the user is holding the shift key secondary handles will switch to have higher priority than regular handles. This change in priority can be used to place multiple handles at the same point while still giving the user control on their selection.

There are virtual methods which will be called upon editing of these handles. Call this method during Redraw.

func (Instance) AddLines

func (self Instance) AddLines(lines []Vector3.XYZ, material Material.Instance)

Adds lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this method during Redraw.

func (Instance) AddMesh

func (self Instance) AddMesh(mesh Mesh.Instance)

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

func (Instance) AddUnscaledBillboard

func (self Instance) AddUnscaledBillboard(material Material.Instance)

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

func (Instance) AsEditorNode3DGizmo

func (self Instance) AsEditorNode3DGizmo() Instance

func (Instance) AsNode3DGizmo

func (self Instance) AsNode3DGizmo() Node3DGizmo.Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) Clear

func (self Instance) Clear()

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

func (Instance) GetNode3d

func (self Instance) GetNode3d() Node3D.Instance

Returns the Node3D node associated with this gizmo.

func (Instance) GetSubgizmoSelection

func (self Instance) GetSubgizmoSelection() []int32

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

func (Instance) ID

func (self Instance) ID() ID

func (Instance) IsSubgizmoSelected

func (self Instance) IsSubgizmoSelected(id int) bool

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

func (Instance) MoreArgs

func (self Instance) MoreArgs() MoreArgs

MoreArgs enables certain functions to be called with additional 'optional' arguments.

func (Instance) SetHidden

func (self Instance) SetHidden(hidden bool)

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

func (Instance) SetNode3d

func (self Instance) SetNode3d(node Node.Instance)

Sets the reference Node3D node for the gizmo. 'node' must inherit from Node3D.

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

type Interface

type Interface interface {
	// Override this method to add all the gizmo elements whenever a gizmo update is requested. It's common to call [Clear] at the beginning of this method and then add visual elements depending on the node's properties.
	//
	// [Clear]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Instance.Clear
	Redraw()
	// Override this method to return 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.
	//
	// The 'secondary' argument is true when the requested handle is secondary (see [AddHandles] for more information).
	//
	// [AddHandles]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Instance.AddHandles
	GetHandleName(id int, secondary bool) string
	// 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 [AddHandles] for more information).
	//
	// [AddHandles]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Instance.AddHandles
	IsHandleHighlighted(id int, secondary bool) bool
	// 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 [CommitHandle].
	//
	// The 'secondary' argument is true when the requested handle is secondary (see [AddHandles] for more information).
	//
	// [AddHandles]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Instance.AddHandles
	// [CommitHandle]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Interface
	GetHandleValue(id int, secondary bool) any
	BeginHandleAction(id int, secondary bool)
	// Override this method to update the node properties when the user drags a gizmo handle (previously added with [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 [AddHandles] for more information).
	//
	// [AddHandles]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Instance.AddHandles
	SetHandle(id int, secondary bool, camera Camera3D.Instance, point Vector2.XY)
	// Override this method to commit a handle being edited (handles must have been previously added by [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 [AddHandles] for more information).
	//
	// [AddHandles]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Instance.AddHandles
	// [UndoRedo]: https://pkg.go.dev/graphics.gd/classdb/UndoRedo
	CommitHandle(id int, secondary bool, restore any, cancel bool)
	// 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 [GetSubgizmoTransform] or [CommitSubgizmos].
	//
	// [CommitSubgizmos]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Interface
	// [GetSubgizmoTransform]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Interface
	SubgizmosIntersectRay(camera Camera3D.Instance, point Vector2.XY) int
	// 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 [Plane.NormalD]s 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 [GetSubgizmoTransform] or [CommitSubgizmos].
	//
	// [CommitSubgizmos]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Interface
	// [GetSubgizmoTransform]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Interface
	// [Plane.NormalD]: https://pkg.go.dev/graphics.gd/variant/Plane#NormalD
	SubgizmosIntersectFrustum(camera Camera3D.Instance, frustum []Plane.NormalD) []int32
	// Override this method to update the node properties during subgizmo editing (see [SubgizmosIntersectRay] and [SubgizmosIntersectFrustum]). The 'transform' is given in the [Node3D]'s local coordinate system.
	//
	// [Node3D]: https://pkg.go.dev/graphics.gd/classdb/Node3D
	// [SubgizmosIntersectFrustum]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Interface
	// [SubgizmosIntersectRay]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Interface
	SetSubgizmoTransform(id int, transform Transform3D.BasisOrigin)
	// 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 [CommitSubgizmos].
	//
	// [CommitSubgizmos]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Interface
	GetSubgizmoTransform(id int) Transform3D.BasisOrigin
	// Override this method to commit a group of subgizmos being edited (see [SubgizmosIntersectRay] and [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.
	//
	// [SubgizmosIntersectFrustum]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Interface
	// [SubgizmosIntersectRay]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Interface
	// [UndoRedo]: https://pkg.go.dev/graphics.gd/classdb/UndoRedo
	CommitSubgizmos(ids []int32, restores []Transform3D.BasisOrigin, cancel bool)
}

type MoreArgs

type MoreArgs [1]gdclass.EditorNode3DGizmo

MoreArgs is a container for Instance functions with additional 'optional' arguments.

func (MoreArgs) AddHandles

func (self MoreArgs) AddHandles(handles []Vector3.XYZ, material Material.Instance, ids []int32, billboard bool, secondary bool)

Adds a list of handles (points) which can be used to edit the properties of the gizmo's Node3D. The 'ids' argument can be used to specify a custom identifier for each handle, if an empty array is passed, the ids will be assigned automatically from the 'handles' argument order.

The 'secondary' argument marks the added handles as secondary, meaning they will normally have lower selection priority than regular handles. When the user is holding the shift key secondary handles will switch to have higher priority than regular handles. This change in priority can be used to place multiple handles at the same point while still giving the user control on their selection.

There are virtual methods which will be called upon editing of these handles. Call this method during Redraw.

func (MoreArgs) AddLines

func (self MoreArgs) AddLines(lines []Vector3.XYZ, material Material.Instance, billboard bool, modulate Color.RGBA)

Adds lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this method during Redraw.

func (MoreArgs) AddMesh

func (self MoreArgs) AddMesh(mesh Mesh.Instance, material Material.Instance, transform Transform3D.BasisOrigin, skeleton SkinReference.Instance)

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

func (MoreArgs) AddUnscaledBillboard

func (self MoreArgs) AddUnscaledBillboard(material Material.Instance, default_scale Float.X, modulate Color.RGBA)

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL