Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

EditorNode3DGizmoPlugin

Inherits: Resource < RefCounted < Object

A class used by the editor to define Node3D gizmo types.

Description

EditorNode3DGizmoPlugin allows you to define a new type of Gizmo. There are two main ways to do so: extending EditorNode3DGizmoPlugin for the simpler gizmos, or creating a new EditorNode3DGizmo type. See the tutorial in the documentation for more info.

To use EditorNode3DGizmoPlugin, register it using the EditorPlugin.add_node_3d_gizmo_plugin method first.

Tutorials

Methods

void

_begin_handle_action ( EditorNode3DGizmo gizmo, int handle_id, bool secondary ) virtual

bool

_can_be_hidden ( ) virtual const

void

_commit_handle ( EditorNode3DGizmo gizmo, int handle_id, bool secondary, Variant restore, bool cancel ) virtual

void

_commit_subgizmos ( EditorNode3DGizmo gizmo, PackedInt32Array ids, Transform3D[] restores, bool cancel ) virtual

EditorNode3DGizmo

_create_gizmo ( Node3D for_node_3d ) virtual const

String

_get_gizmo_name ( ) virtual const

String

_get_handle_name ( EditorNode3DGizmo gizmo, int handle_id, bool secondary ) virtual const

Variant

_get_handle_value ( EditorNode3DGizmo gizmo, int handle_id, bool secondary ) virtual const

int

_get_priority ( ) virtual const

Transform3D

_get_subgizmo_transform ( EditorNode3DGizmo gizmo, int subgizmo_id ) virtual const

bool

_has_gizmo ( Node3D for_node_3d ) virtual const

bool

_is_handle_highlighted ( EditorNode3DGizmo gizmo, int handle_id, bool secondary ) virtual const

bool

_is_selectable_when_hidden ( ) virtual const

void

_redraw ( EditorNode3DGizmo gizmo ) virtual

void

_set_handle ( EditorNode3DGizmo gizmo, int handle_id, bool secondary, Camera3D camera, Vector2 screen_pos ) virtual

void

_set_subgizmo_transform ( EditorNode3DGizmo gizmo, int subgizmo_id, Transform3D transform ) virtual

PackedInt32Array

_subgizmos_intersect_frustum ( EditorNode3DGizmo gizmo, Camera3D camera, Plane[] frustum_planes ) virtual const

int

_subgizmos_intersect_ray ( EditorNode3DGizmo gizmo, Camera3D camera, Vector2 screen_pos ) virtual const

void

add_material ( String name, StandardMaterial3D material )

void

create_handle_material ( String name, bool billboard=false, Texture2D texture=null )

void

create_icon_material ( String name, Texture2D texture, bool on_top=false, Color color=Color(1, 1, 1, 1) )

void

create_material ( String name, Color color, bool billboard=false, bool on_top=false, bool use_vertex_color=false )

StandardMaterial3D

get_material ( String name, EditorNode3DGizmo gizmo=null )


Method Descriptions

void _begin_handle_action ( EditorNode3DGizmo gizmo, int handle_id, bool secondary ) virtual

There is currently no description for this method. Please help us by contributing one!


bool _can_be_hidden ( ) virtual const

Override this method to define whether the gizmos handled by this plugin can be hidden or not. Returns true if not overridden.


void _commit_handle ( EditorNode3DGizmo gizmo, int handle_id, bool secondary, Variant restore, bool cancel ) virtual

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

Called for this plugin's active gizmos.


void _commit_subgizmos ( EditorNode3DGizmo gizmo, PackedInt32Array ids, Transform3D[] restores, bool cancel ) virtual

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