Index · Object → RefCounted → Node3DGizmo → EditorNode3DGizmo

EditorNode3DGizmo

Gizmo for editing Node3D objects.

Class Description

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.

Methods

func _begin_handle_action(id: int, secondary: bool) -> void
func _commit_handle(id: int, secondary: bool, restore: Variant, cancel: bool) -> void

Override this method to commit a handle being edited (handles must have been previously added by add_handles()). 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 add_handles() for more information).

func _commit_subgizmos(ids: PackedInt32Array, restores: Transform3D[], cancel: bool) -> void

Override this method to commit a group of subgizmos being edited (see _subgizmos_intersect_ray() and _subgizmos_intersect_frustum()). 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.

func _get_handle_name(id: int, secondary: bool) -> String

Override this method to return 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.

The secondary argument is true when the requested handle is secondary (see add_handles() for more information).

func _get_handle_value(id: int, secondary: bool) -> Variant

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 _commit_handle().

The secondary argument is true when the requested handle is secondary (see add_handles() for more information).

func _get_subgizmo_transform(id: int) -> Transform3D

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 _commit_subgizmos().

func _is_handle_highlighted(id: int, secondary: bool) -> bool

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 add_handles() for more information).

func _redraw() -> void

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.

func _set_handle(id: int, secondary: bool, camera: Camera3D, point: Vector2) -> void

Override this method to update the node properties when the user drags a gizmo handle (previously added with add_handles()). 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 add_handles() for more information).

func _set_subgizmo_transform(id: int, transform: Transform3D) -> void

Override this method to update the node properties during subgizmo editing (see _subgizmos_intersect_ray() and _subgizmos_intersect_frustum()). The transform is given in the Node3D's local coordinate system.

func _subgizmos_intersect_frustum(camera: Camera3D, frustum: Plane[]) -> PackedInt32Array

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 _get_subgizmo_transform() or _commit_subgizmos().

func _subgizmos_intersect_ray(camera: Camera3D, point: Vector2) -> int

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 _get_subgizmo_transform() or _commit_subgizmos().

func add_collision_segments(segments: PackedVector3Array) -> void

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

func add_collision_triangles(triangles: TriangleMesh) -> void

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

func add_handles(handles: PackedVector3Array, material: Material, ids: PackedInt32Array, billboard: bool = false, secondary: bool = false) -> void

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 add_lines(lines: PackedVector3Array, material: Material, billboard: bool = false, modulate: Color = Color(1, 1, 1, 1)) -> void

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 add_mesh(mesh: Mesh, material: Material = null, transform: Transform3D = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0), skeleton: SkinReference = null) -> void

Adds a mesh to the gizmo with the specified material, local transform and skeleton. Call this method during _redraw().

func add_unscaled_billboard(material: Material, default_scale: float = 1, modulate: Color = Color(1, 1, 1, 1)) -> void

Adds an unscaled billboard for visualization and selection. Call this method during _redraw().

func clear() -> void

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

func get_node_3d() -> Node3D

Returns the Node3D node associated with this gizmo.

func get_plugin() -> EditorNode3DGizmoPlugin

Returns the EditorNode3DGizmoPlugin that owns this gizmo. It's useful to retrieve materials using EditorNode3DGizmoPlugin.get_material().

func get_subgizmo_selection() -> PackedInt32Array

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

func is_subgizmo_selected(id: int) -> bool

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

func set_hidden(hidden: bool) -> void

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

func set_node_3d(node: Node) -> void

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

Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Object (2)