From 9ee65942db48be85da2196f5b0f3b3b9df90f22c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Przemys=C5=82aw=20Go=C5=82=C4=85b=20=28n-pigeon=29?= Date: Sat, 9 Sep 2017 15:55:10 +0200 Subject: Documented Spatial node. --- doc/base/classes.xml | 49 +++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 45 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/base/classes.xml b/doc/base/classes.xml index a097470306..ae8cb56a03 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -45473,16 +45473,17 @@ - Base class for all 3D nodes. + Most basic 3D game object, parent of all 3D related nodes. - Spatial is the base for every type of 3D [Node]. It contains a 3D [Transform] which can be set or get as local or global. If a Spatial [Node] has Spatial children, their transforms will be relative to the parent. + Most basic 3D game object, with a 3D [Transform] and visibility settings. All 3D physics nodes and sprites inherit from Spatial. Use Spatial as a parent node to move, scale, rotate and show/hide children in a 3D project. + Return the SpatialGizmo for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor. @@ -45536,6 +45537,7 @@ + Return current [World] resource this Spatial node is registered to. @@ -45546,6 +45548,7 @@ + Rotate current node along normal [Vector3] by angle in radians in Global space. @@ -45554,42 +45557,49 @@ + Move current node by [Vector3] offset in Global space. + Disable rendering of this node. Change Spatial Visible property to false. + Returns whether node sends notification that its local transformation changed. Spatial will not propagate this by default. + Returns whether this node is set as Toplevel, ignoring its parent node transformations. + Returns whether node sends notification that its transformation changed. Spatial will not propagate this by default. + Returns whether this node is set to be visible. + Returns whether this node is visible, taking into consideration that its parents visibility. @@ -45600,6 +45610,7 @@ + Rotates itself to point into direction of target position. Operations take place in global space. @@ -45612,12 +45623,14 @@ + Moves itself to specified position and then rotates itself to point into direction of target position. Operations take place in global space. + Reset this node transformations (like scale, skew and taper) preserving its rotation and translation. Performs orthonormalization on this node [Transform3D]. @@ -45628,6 +45641,7 @@ + Rotates node in local space on given normal [Vector3] by angle in radians. @@ -45636,6 +45650,7 @@ + Rotates node in local space on X axis by angle in radians. @@ -45644,6 +45659,7 @@ + Rotates node in local space on Y axis by angle in radians. @@ -45652,6 +45668,7 @@ + Rotates node in local space on Z axis by angle in radians. @@ -45660,6 +45677,7 @@ + Makes this node ignore its parents tranformations. Node tranformations are only in global space. @@ -45668,6 +45686,7 @@ + Set [SpatialGizmo] for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor. @@ -45676,13 +45695,14 @@ - Set the transform globally, relative to worldspace. + Set the transform globally, relative to world space. + Reset all tranformations for this node. Set its [Transform3D] to identity matrix. @@ -45691,6 +45711,7 @@ + Set whether this node ignores notification that its transformation changed. @@ -45699,6 +45720,7 @@ + Set whether this node sends notification that its local transformation changed. Spatial will not propagate this by default. @@ -45707,6 +45729,7 @@ + Set whether this node sends notification that its transformation changed. Spatial will not propagate this by default. @@ -45733,6 +45756,7 @@ + Set the scale. @@ -45764,6 +45788,7 @@ + Enable rendering of this node. Change Spatial Visible property to false. @@ -45772,6 +45797,7 @@ + Tranform [Vector3] from this node local space to world space. @@ -45780,6 +45806,7 @@ + Tranform [Vector3] from world space to this node local space. @@ -45788,46 +45815,60 @@ + Change node position by given offset [Vector3]. + Update [SpatialGizmo] of this node. + World space (global) [Transform] of this node. + Local euler rotation in radians of this node. + Local euler rotation in degrees of this node. + Local scale of this node. + Local space [Transform] of this node. + Local translation of this node. + Visibility of this node. Toggles if this node is rendered. + Emitted when node visibility changed. - Spatial nodes receive this notification with their global transform changes. This means that either the current or a parent node changed its transform. + Spatial nodes receive this notification when their global transform changes. This means that either the current or a parent node changed its transform. + In order for NOTIFICATION_TRANSFORM_CHANGED to work user first needs to ask for it, with set_notify_transform(true). + Spatial nodes receive this notification when they are registered to new [World] resource. + Spatial nodes receive this notification when they are unregistered from current [World] resource. + Spatial nodes receive this notification when their visibility changes. -- cgit v1.2.3