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

407 lines
13 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" ?>
<class name="Spatial" inherits="Node" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Most basic 3D game object, parent of all 3D related nodes.
</brief_description>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Most basic 3D game object, with a 3D [Transform] and visibility settings. All other 3D game objects inherit from Spatial. Use Spatial as a parent node to move, scale, rotate and show/hide children in a 3D project.
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>
<demos>
</demos>
<methods>
<method name="get_gizmo" qualifiers="const">
<return type="SpatialGizmo">
</return>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Returns the SpatialGizmo for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor.
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_global_transform" qualifiers="const">
<return type="Transform">
</return>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Returns the global transform, relative to worldspace.
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_parent_spatial" qualifiers="const">
<return type="Spatial">
</return>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Returns the parent [Spatial], or an empty [Object] if no parent exists or parent is not of type [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>
<method name="get_rotation" qualifiers="const">
<return type="Vector3">
</return>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Returns the rotation (in radians).
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_rotation_deg" qualifiers="const">
<return type="Vector3">
</return>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Returns the rotation (in degrees).
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_scale" qualifiers="const">
<return type="Vector3">
</return>
<description>
</description>
</method>
<method name="get_transform" qualifiers="const">
<return type="Transform">
</return>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Returns the local transform, relative to the bone parent.
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_translation" qualifiers="const">
<return type="Vector3">
</return>
<description>
</description>
</method>
<method name="get_world" qualifiers="const">
<return type="World">
</return>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Returns the current [World] resource this Spatial node is registered to.
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="global_rotate">
<return type="void">
</return>
<argument index="0" name="normal" type="Vector3">
</argument>
<argument index="1" name="radians" type="float">
</argument>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Rotates the current node along normal [Vector3] by angle in radians in Global space.
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="global_translate">
<return type="void">
</return>
<argument index="0" name="offset" type="Vector3">
</argument>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Moves the node by [Vector3] offset in Global space.
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="hide">
<return type="void">
</return>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Disables rendering of this node. Change Spatial Visible property to 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
</description>
</method>
<method name="is_local_transform_notification_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Returns whether node notifies about its local transformation changes. Spatial will not propagate this by default.
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="is_set_as_toplevel" qualifiers="const">
<return type="bool">
</return>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Returns whether this node is set as Toplevel, that is whether it ignores its parent nodes transformations.
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="is_transform_notification_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Returns whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default.
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="is_visible" qualifiers="const">
<return type="bool">
</return>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Returns whether the node is set to be visible.
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="is_visible_in_tree" qualifiers="const">
<return type="bool">
</return>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Returns whether the node is visible, taking into consideration that its parents visibility.
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="look_at">
<return type="void">
</return>
<argument index="0" name="target" type="Vector3">
</argument>
<argument index="1" name="up" type="Vector3">
</argument>
<description>
Rotates itself to point into direction of target position. Operations take place in global space.
</description>
</method>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
<method name="look_at_from_position">
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
<return type="void">
</return>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
<argument index="0" name="position" type="Vector3">
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>
<argument index="1" name="target" type="Vector3">
</argument>
<argument index="2" name="up" type="Vector3">
</argument>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Moves the node to specified position and then rotates itself to point into direction of target position. Operations take place in global space.
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="orthonormalize">
<return type="void">
</return>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Resets this node's transformations (like scale, skew and taper) preserving its rotation and translation. Performs orthonormalization on this node [Transform3D].
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="rotate">
<return type="void">
</return>
<argument index="0" name="normal" type="Vector3">
</argument>
<argument index="1" name="radians" type="float">
</argument>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Rotates the node in local space on given normal [Vector3] by angle in radians.
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="rotate_x">
<return type="void">
</return>
<argument index="0" name="radians" type="float">
</argument>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Rotates the node in local space on X axis by angle in radians.
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="rotate_y">
<return type="void">
</return>
<argument index="0" name="radians" type="float">
</argument>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Rotates the node in local space on Y axis by angle in radians.
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="rotate_z">
<return type="void">
</return>
<argument index="0" name="radians" type="float">
</argument>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Rotates the node in local space on Z axis by angle in radians.
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_as_toplevel">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
[DOCS] Fix a few typos.
2017-10-14 10:45:26 +00:00
Makes the node ignore its parents transformations. Node transformations are only in global space.
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_gizmo">
<return type="void">
</return>
<argument index="0" name="gizmo" type="SpatialGizmo">
</argument>
<description>
Set [SpatialGizmo] for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor.
</description>
</method>
<method name="set_global_transform">
<return type="void">
</return>
<argument index="0" name="global" type="Transform">
</argument>
<description>
Set the transform globally, relative to world space.
</description>
</method>
<method name="set_identity">
<return type="void">
</return>
<description>
[DOCS] Fix a few typos.
2017-10-14 10:45:26 +00:00
Reset all transformations for this node. Set its [Transform3D] to identity matrix.
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_ignore_transform_notification">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Set whether the node ignores notification that its transformation (global or local) changed.
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_notify_local_transform">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Set whether the node notifies about its local transformation changes. Spatial will not propagate this by default.
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_notify_transform">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Set whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default.
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_rotation">
<return type="void">
</return>
<argument index="0" name="rotation_rad" type="Vector3">
</argument>
<description>
Set the rotation (in radians).
</description>
</method>
<method name="set_rotation_deg">
<return type="void">
</return>
<argument index="0" name="rotation_deg" type="Vector3">
</argument>
<description>
Set the rotation (in degrees).
</description>
</method>
<method name="set_scale">
<return type="void">
</return>
<argument index="0" name="scale" type="Vector3">
</argument>
<description>
Set the scale.
</description>
</method>
<method name="set_transform">
<return type="void">
</return>
<argument index="0" name="local" type="Transform">
</argument>
<description>
Set the transform locally, relative to the parent spatial node.
</description>
</method>
<method name="set_translation">
<return type="void">
</return>
<argument index="0" name="translation" type="Vector3">
</argument>
<description>
</description>
</method>
<method name="set_visible">
<return type="void">
</return>
<argument index="0" name="visible" type="bool">
</argument>
<description>
</description>
</method>
<method name="show">
<return type="void">
</return>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Enables rendering of this node. Change Spatial Visible property to "True".
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="to_global" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="local_point" type="Vector3">
</argument>
<description>
[DOCS] Fix a few typos.
2017-10-14 10:45:26 +00:00
Transforms [Vector3] "local_point" from this node's local space to world space.
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="to_local" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="global_point" type="Vector3">
</argument>
<description>
[DOCS] Fix a few typos.
2017-10-14 10:45:26 +00:00
Transforms [Vector3] "global_point" from world space to this node's local space.
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="translate">
<return type="void">
</return>
<argument index="0" name="offset" type="Vector3">
</argument>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Changes the node's position by given offset [Vector3].
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="update_gizmo">
<return type="void">
</return>
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Updates the [SpatialGizmo] of this node.
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>
<members>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="global_transform" type="Transform" setter="set_global_transform" getter="get_global_transform">
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
World space (global) [Transform] of this node.
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="rotation" type="Vector3" setter="set_rotation" getter="get_rotation">
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
Local euler rotation in radians of this node.
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="rotation_deg" type="Vector3" setter="set_rotation_deg" getter="get_rotation_deg">
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
Local euler rotation in degrees of this node.
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="scale" type="Vector3" setter="set_scale" getter="get_scale">
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
Local scale of this node.
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="transform" type="Transform" setter="set_transform" getter="get_transform">
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
Local space [Transform] of this node.
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="translation" type="Vector3" setter="set_translation" getter="get_translation">
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
Local translation of this node.
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="visible" type="bool" setter="set_visible" getter="is_visible">
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
Visibility of this node. Toggles if this node is rendered.
</member>
</members>
<signals>
<signal name="visibility_changed">
<description>
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Emitted when node visibility changes.
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>
</signal>
</signals>
<constants>
<constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29" enum="">
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Spatial nodes receives this notification when their global transform changes. This means that either the current or a parent node changed its transform.
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
In order for NOTIFICATION_TRANSFORM_CHANGED to work user first needs to ask for it, with set_notify_transform(true).
</constant>
<constant name="NOTIFICATION_ENTER_WORLD" value="41" enum="">
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Spatial nodes receives this notification when they are registered to new [World] resource.
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
</constant>
<constant name="NOTIFICATION_EXIT_WORLD" value="42" enum="">
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Spatial nodes receives this notification when they are unregistered from current [World] resource.
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
</constant>
<constant name="NOTIFICATION_VISIBILITY_CHANGED" value="43" enum="">
Spatial, Transform and Transform2D documentation tweaks
2017-09-14 05:42:21 +00:00
Spatial nodes receives this notification when their visibility changes.
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
</constant>
</constants>
</class>