EditorNode3DGizmoPlugin

type Advanced = class

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

type Expanded = MoreArgs

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

type ID Object.ID

type Implementation = implementation

type Instance [1]gdclass.EditorNode3DGizmoPlugin

type Interface interface {
	// Override this method to define which Node3D nodes have a gizmo from this plugin. Whenever a [Node3D] node is added to a scene this method is called, if it returns true the node gets a generic [EditorNode3DGizmo] assigned and is added to this plugin's list of active gizmos.
	//
	// [EditorNode3DGizmo]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo
	// [Node3D]: https://pkg.go.dev/graphics.gd/classdb/Node3D
	HasGizmo(for_node_3d Node3D.Instance) bool
	// Override this method to return a custom [EditorNode3DGizmo] for the 3D nodes of your choice, return null for the rest of nodes. See also [HasGizmo].
	//
	// [EditorNode3DGizmo]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo
	// [HasGizmo]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmoPlugin#Interface
	CreateGizmo(for_node_3d Node3D.Instance) EditorNode3DGizmo.Instance
	// Override this method to provide the name that will appear in the gizmo visibility menu.
	GetGizmoName() string
	// Override this method to set the gizmo's priority. Gizmos with higher priority will have precedence when processing inputs like handles or subgizmos selection.
	//
	// All built-in editor gizmos return a priority of -1. If not overridden, this method will return 0, which means custom gizmos will automatically get higher priority than built-in gizmos.
	GetPriority() int
	// Override this method to define whether the gizmos handled by this plugin can be hidden or not. Returns true if not overridden.
	CanBeHidden() bool
	// Override this method to define whether Node3D with this gizmo should be selectable even when the gizmo is hidden.
	IsSelectableWhenHidden() bool
	// Override this method to add all the gizmo elements whenever a gizmo update is requested. It's common to call [EditorNode3DGizmo.Clear] at the beginning of this method and then add visual elements depending on the node's properties.
	//
	// [EditorNode3DGizmo.Clear]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Instance.Clear
	Redraw(gizmo EditorNode3DGizmo.Instance)
	// Override this method to provide gizmo's handle names. The 'secondary' argument is true when the requested handle is secondary (see [EditorNode3DGizmo.AddHandles] for more information). Called for this plugin's active gizmos.
	//
	// [EditorNode3DGizmo.AddHandles]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Instance.AddHandles
	GetHandleName(gizmo EditorNode3DGizmo.Instance, handle_id int, secondary bool) string
	// Override this method to return true whenever to given handle should be highlighted in the editor. The 'secondary' argument is true when the requested handle is secondary (see [EditorNode3DGizmo.AddHandles] for more information). Called for this plugin's active gizmos.
	//
	// [EditorNode3DGizmo.AddHandles]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Instance.AddHandles
	IsHandleHighlighted(gizmo EditorNode3DGizmo.Instance, handle_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 [EditorNode3DGizmo.AddHandles] for more information).
	//
	// Called for this plugin's active gizmos.
	//
	// [CommitHandle]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmoPlugin#Interface
	// [EditorNode3DGizmo.AddHandles]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Instance.AddHandles
	GetHandleValue(gizmo EditorNode3DGizmo.Instance, handle_id int, secondary bool) any
	BeginHandleAction(gizmo EditorNode3DGizmo.Instance, handle_id int, secondary bool)
	// Override this method to update the node's properties when the user drags a gizmo handle (previously added with [EditorNode3DGizmo.AddHandles]). The provided 'screen_pos' 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 [EditorNode3DGizmo.AddHandles] for more information).
	//
	// Called for this plugin's active gizmos.
	//
	// [EditorNode3DGizmo.AddHandles]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Instance.AddHandles
	SetHandle(gizmo EditorNode3DGizmo.Instance, handle_id int, secondary bool, camera Camera3D.Instance, screen_pos Vector2.XY)
	// Override this method to commit a handle being edited (handles must have been previously added by [EditorNode3DGizmo.AddHandles] during [Redraw]). 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 [EditorNode3DGizmo.AddHandles] for more information).
	//
	// Called for this plugin's active gizmos.
	//
	// [EditorNode3DGizmo.AddHandles]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmo#Instance.AddHandles
	// [Redraw]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmoPlugin#Interface
	// [UndoRedo]: https://pkg.go.dev/graphics.gd/classdb/UndoRedo
	CommitHandle(gizmo EditorNode3DGizmo.Instance, handle_id int, secondary bool, restore any, cancel bool)
	// Override this method to allow selecting subgizmos using mouse clicks. Given a 'camera' and a 'screen_pos' 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]. Called for this plugin's active gizmos.
	//
	// [CommitSubgizmos]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmoPlugin#Interface
	// [GetSubgizmoTransform]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmoPlugin#Interface
	SubgizmosIntersectRay(gizmo EditorNode3DGizmo.Instance, camera Camera3D.Instance, screen_pos Vector2.XY) int
	// Override this method to allow selecting subgizmos using mouse drag box selection. Given a 'camera' and 'frustum_planes', this method should return which subgizmos are contained within the frustums. The 'frustum_planes' 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, these identifiers can have any non-negative value and will be used in other virtual methods like [GetSubgizmoTransform] or [CommitSubgizmos]. Called for this plugin's active gizmos.
	//
	// [CommitSubgizmos]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmoPlugin#Interface
	// [GetSubgizmoTransform]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmoPlugin#Interface
	// [Plane.NormalD]: https://pkg.go.dev/graphics.gd/variant/Plane#NormalD
	SubgizmosIntersectFrustum(gizmo EditorNode3DGizmo.Instance, camera Camera3D.Instance, frustum_planes []Plane.NormalD) []int32
	// Override this method to return the current transform of a subgizmo. As with all subgizmo methods, the transform should be in local space respect to the gizmo's Node3D. This transform will be requested at the start of an edit and used in the restore argument in [CommitSubgizmos]. Called for this plugin's active gizmos.
	//
	// [CommitSubgizmos]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmoPlugin#Interface
	GetSubgizmoTransform(gizmo EditorNode3DGizmo.Instance, subgizmo_id int) Transform3D.BasisOrigin
	// 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. Called for this plugin's active gizmos.
	//
	// [SubgizmosIntersectFrustum]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmoPlugin#Interface
	// [SubgizmosIntersectRay]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmoPlugin#Interface
	SetSubgizmoTransform(gizmo EditorNode3DGizmo.Instance, subgizmo_id int, transform 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. As with all subgizmo methods, transforms are given in local space respect to the gizmo's Node3D. Called for this plugin's active gizmos.
	//
	// [SubgizmosIntersectFrustum]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmoPlugin#Interface
	// [SubgizmosIntersectRay]: https://pkg.go.dev/graphics.gd/classdb/EditorNode3DGizmoPlugin#Interface
	// [UndoRedo]: https://pkg.go.dev/graphics.gd/classdb/UndoRedo
	CommitSubgizmos(gizmo EditorNode3DGizmo.Instance, ids []int32, restores []Transform3D.BasisOrigin, cancel bool)
}

type MoreArgs [1]gdclass.EditorNode3DGizmoPlugin