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

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 )