diff options
Diffstat (limited to 'doc/classes/EditorNode3DGizmo.xml')
| -rw-r--r-- | doc/classes/EditorNode3DGizmo.xml | 189 |
1 files changed, 189 insertions, 0 deletions
diff --git a/doc/classes/EditorNode3DGizmo.xml b/doc/classes/EditorNode3DGizmo.xml new file mode 100644 index 0000000000..6d695ddeea --- /dev/null +++ b/doc/classes/EditorNode3DGizmo.xml @@ -0,0 +1,189 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorNode3DGizmo" inherits="Node3DGizmo" version="4.0"> + <brief_description> + Custom gizmo for editing Node3D objects. + </brief_description> + <description> + Custom gizmo that is used for providing custom visualization and editing (handles) for Node3D objects. See [EditorNode3DGizmoPlugin] for more information. + </description> + <tutorials> + </tutorials> + <methods> + <method name="add_collision_segments"> + <return type="void"> + </return> + <argument index="0" name="segments" type="PackedVector3Array"> + </argument> + <description> + </description> + </method> + <method name="add_collision_triangles"> + <return type="void"> + </return> + <argument index="0" name="triangles" type="TriangleMesh"> + </argument> + <description> + Adds collision triangles to the gizmo for picking. A [TriangleMesh] can be generated from a regular [Mesh] too. Call this function during [method redraw]. + </description> + </method> + <method name="add_handles"> + <return type="void"> + </return> + <argument index="0" name="handles" type="PackedVector3Array"> + </argument> + <argument index="1" name="material" type="Material"> + </argument> + <argument index="2" name="billboard" type="bool" default="false"> + </argument> + <argument index="3" name="secondary" type="bool" default="false"> + </argument> + <description> + Adds a list of handles (points) which can be used to deform the object being edited. + There are virtual functions which will be called upon editing of these handles. Call this function during [method redraw]. + </description> + </method> + <method name="add_lines"> + <return type="void"> + </return> + <argument index="0" name="lines" type="PackedVector3Array"> + </argument> + <argument index="1" name="material" type="Material"> + </argument> + <argument index="2" name="billboard" type="bool" default="false"> + </argument> + <argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <description> + Adds lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during [method redraw]. + </description> + </method> + <method name="add_mesh"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="ArrayMesh"> + </argument> + <argument index="1" name="billboard" type="bool" default="false"> + </argument> + <argument index="2" name="skeleton" type="SkinReference" default="null"> + </argument> + <argument index="3" name="material" type="Material" default="null"> + </argument> + <description> + </description> + </method> + <method name="add_unscaled_billboard"> + <return type="void"> + </return> + <argument index="0" name="material" type="Material"> + </argument> + <argument index="1" name="default_scale" type="float" default="1"> + </argument> + <argument index="2" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <description> + Adds an unscaled billboard for visualization. Call this function during [method redraw]. + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="commit_handle" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="restore" type="Variant"> + </argument> + <argument index="2" name="cancel" type="bool" default="false"> + </argument> + <description> + Commit a handle being edited (handles must have been previously added by [method add_handles]). + If the [code]cancel[/code] parameter is [code]true[/code], an option to restore the edited value to the original is provided. + </description> + </method> + <method name="get_handle_name" qualifiers="virtual"> + <return type="String"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + Gets the name of an edited handle (handles must have been previously added by [method add_handles]). + Handles can be named for reference to the user when editing. + </description> + </method> + <method name="get_handle_value" qualifiers="virtual"> + <return type="Variant"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + Gets actual value of a handle. This value can be anything and used for eventually undoing the motion when calling [method commit_handle]. + </description> + </method> + <method name="get_plugin" qualifiers="const"> + <return type="EditorNode3DGizmoPlugin"> + </return> + <description> + Returns the [EditorNode3DGizmoPlugin] that owns this gizmo. It's useful to retrieve materials using [method EditorNode3DGizmoPlugin.get_material]. + </description> + </method> + <method name="get_spatial_node" qualifiers="const"> + <return type="Node3D"> + </return> + <description> + Returns the Node3D node associated with this gizmo. + </description> + </method> + <method name="is_handle_highlighted" qualifiers="virtual"> + <return type="bool"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + Gets whether a handle is highlighted or not. + </description> + </method> + <method name="redraw" qualifiers="virtual"> + <return type="void"> + </return> + <description> + This function is called when the Node3D this gizmo refers to changes (the [method Node3D.update_gizmo] is called). + </description> + </method> + <method name="set_handle" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="camera" type="Camera3D"> + </argument> + <argument index="2" name="point" type="Vector2"> + </argument> + <description> + This function is used when the user drags a gizmo handle (previously added with [method add_handles]) in screen coordinates. + The [Camera3D] is also provided so screen coordinates can be converted to raycasts. + </description> + </method> + <method name="set_hidden"> + <return type="void"> + </return> + <argument index="0" name="hidden" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_spatial_node"> + <return type="void"> + </return> + <argument index="0" name="node" type="Node"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> |