godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/EditorSpatialGizmo.xml

195 lines
7.1 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Drop unused 'category' property from header We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
2020-01-26 15:01:49 +00:00
<class name="EditorSpatialGizmo" inherits="SpatialGizmo" version="3.2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Custom gizmo for editing Spatial objects.
</brief_description>
<description>
Minor fixes and documentation for Spatial Gizmos
2019-01-25 11:57:32 +00:00
Custom gizmo that is used for providing custom visualization and editing (handles) for 3D Spatial objects. See [EditorSpatialGizmoPlugin] for more information.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_collision_segments">
<return type="void">
</return>
<argument index="0" name="segments" type="PoolVector3Array">
</argument>
<description>
Document several editor-related classes to 100% completion (cherry picked from commit fb2e4d77ebad5877310b246ebc6279e8409cb6c0)
2020-07-18 15:17:00 +00:00
Adds the specified [code]segments[/code] to the gizmo's collision shape for picking. Call this function during [method redraw].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="add_collision_triangles">
<return type="void">
</return>
<argument index="0" name="triangles" type="TriangleMesh">
</argument>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Adds collision triangles to the gizmo for picking. A [TriangleMesh] can be generated from a regular [Mesh] too. Call this function during [method redraw].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="add_handles">
<return type="void">
</return>
<argument index="0" name="handles" type="PoolVector3Array">
</argument>
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<argument index="1" name="material" type="Material">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<argument index="2" name="billboard" type="bool" default="false">
</argument>
<argument index="3" name="secondary" type="bool" default="false">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Adds a list of handles (points) which can be used to deform the object being edited.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
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="PoolVector3Array">
</argument>
<argument index="1" name="material" type="Material">
</argument>
<argument index="2" name="billboard" type="bool" default="false">
</argument>
doc: Sync classref with current source
2020-01-03 14:09:03 +00:00
<argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
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].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
doc: Sync classref with current source
2019-09-24 13:57:22 +00:00
<argument index="2" name="skeleton" type="SkinReference" default="null">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
doc: Sync classref with current source
2019-02-25 10:21:15 +00:00
<argument index="3" name="material" type="Material" default="null">
</argument>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Document several editor-related classes to 100% completion (cherry picked from commit fb2e4d77ebad5877310b246ebc6279e8409cb6c0)
2020-07-18 15:17:00 +00:00
Adds a mesh to the gizmo with the specified [code]billboard[/code] state, [code]skeleton[/code] and [code]material[/code]. If [code]billboard[/code] is [code]true[/code], the mesh will rotate to always face the camera. Call this function during [method redraw].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
doc: Sync classref with current source
2020-01-03 14:09:03 +00:00
<argument index="2" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Adds an unscaled billboard for visualization. Call this function during [method redraw].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="clear">
<return type="void">
</return>
<description>
Document several editor-related classes to 100% completion (cherry picked from commit fb2e4d77ebad5877310b246ebc6279e8409cb6c0)
2020-07-18 15:17:00 +00:00
Removes everything in the gizmo including meshes, collisions and handles.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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>
[DOCS] Fix a few typos.
2017-10-14 10:45:26 +00:00
Commit a handle being edited (handles must have been previously added by [method add_handles]).
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
If the [code]cancel[/code] parameter is [code]true[/code], an option to restore the edited value to the original is provided.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_handle_name" qualifiers="virtual">
<return type="String">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Gets the name of an edited handle (handles must have been previously added by [method add_handles]).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
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>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Gets actual value of a handle. This value can be anything and used for eventually undoing the motion when calling [method commit_handle].
Minor fixes and documentation for Spatial Gizmos
2019-01-25 11:57:32 +00:00
</description>
</method>
<method name="get_plugin" qualifiers="const">
<return type="EditorSpatialGizmoPlugin">
</return>
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 02:15:43 +00:00
Returns the [EditorSpatialGizmoPlugin] that owns this gizmo. It's useful to retrieve materials using [method EditorSpatialGizmoPlugin.get_material].
Minor fixes and documentation for Spatial Gizmos
2019-01-25 11:57:32 +00:00
</description>
</method>
<method name="get_spatial_node" qualifiers="const">
<return type="Spatial">
</return>
<description>
Returns the Spatial 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>
Document several editor-related classes to 100% completion (cherry picked from commit fb2e4d77ebad5877310b246ebc6279e8409cb6c0)
2020-07-18 15:17:00 +00:00
Returns [code]true[/code] if the handle at index [code]index[/code] is highlighted by being hovered with the mouse.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="redraw" qualifiers="virtual">
<return type="void">
</return>
<description>
Document several editor-related classes to 100% completion (cherry picked from commit fb2e4d77ebad5877310b246ebc6279e8409cb6c0)
2020-07-18 15:17:00 +00:00
This function is called when the [Spatial] this gizmo refers to changes (the [method Spatial.update_gizmo] is called).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</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="Camera">
</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 [Camera] is also provided so screen coordinates can be converted to raycasts.
</description>
</method>
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<method name="set_hidden">
<return type="void">
</return>
<argument index="0" name="hidden" type="bool">
</argument>
<description>
Document several editor-related classes to 100% completion (cherry picked from commit fb2e4d77ebad5877310b246ebc6279e8409cb6c0)
2020-07-18 15:17:00 +00:00
Sets the gizmo's hidden state. If [code]true[/code], the gizmo will be hidden. If [code]false[/code], it will be shown.
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="set_spatial_node">
<return type="void">
</return>
<argument index="0" name="node" type="Node">
</argument>
<description>
Document several editor-related classes to 100% completion (cherry picked from commit fb2e4d77ebad5877310b246ebc6279e8409cb6c0)
2020-07-18 15:17:00 +00:00
Sets the reference [Spatial] node for the gizmo. [code]node[/code] must inherit from [Spatial].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<constants>
</constants>
</class>