diff options
Diffstat (limited to 'doc/classes/VisualInstance3D.xml')
| -rw-r--r-- | doc/classes/VisualInstance3D.xml | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/doc/classes/VisualInstance3D.xml b/doc/classes/VisualInstance3D.xml new file mode 100644 index 0000000000..6451b3f330 --- /dev/null +++ b/doc/classes/VisualInstance3D.xml @@ -0,0 +1,79 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualInstance3D" inherits="Node3D" version="4.0"> + <brief_description> + Parent of all visual 3D nodes. + </brief_description> + <description> + The [VisualInstance3D] is used to connect a resource to a visual representation. All visual 3D nodes inherit from the [VisualInstance3D]. In general, you should not access the [VisualInstance3D] properties directly as they are accessed and managed by the nodes that inherit from [VisualInstance3D]. [VisualInstance3D] is the node representation of the [RenderingServer] instance. + </description> + <tutorials> + </tutorials> + <methods> + <method name="get_aabb" qualifiers="const"> + <return type="AABB"> + </return> + <description> + Returns the [AABB] (also known as the bounding box) for this [VisualInstance3D]. + </description> + </method> + <method name="get_base" qualifiers="const"> + <return type="RID"> + </return> + <description> + Returns the RID of the resource associated with this [VisualInstance3D]. For example, if the Node is a [MeshInstance3D], this will return the RID of the associated [Mesh]. + </description> + </method> + <method name="get_instance" qualifiers="const"> + <return type="RID"> + </return> + <description> + Returns the RID of this instance. This RID is the same as the RID returned by [method RenderingServer.instance_create]. This RID is needed if you want to call [RenderingServer] functions directly on this [VisualInstance3D]. + </description> + </method> + <method name="get_layer_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <description> + Returns [code]true[/code] when the specified layer is enabled in [member layers] and [code]false[/code] otherwise. + </description> + </method> + <method name="get_transformed_aabb" qualifiers="const"> + <return type="AABB"> + </return> + <description> + Returns the transformed [AABB] (also known as the bounding box) for this [VisualInstance3D]. + Transformed in this case means the [AABB] plus the position, rotation, and scale of the [Node3D]'s [Transform]. + </description> + </method> + <method name="set_base"> + <return type="void"> + </return> + <argument index="0" name="base" type="RID"> + </argument> + <description> + Sets the resource that is instantiated by this [VisualInstance3D], which changes how the engine handles the [VisualInstance3D] under the hood. Equivalent to [method RenderingServer.instance_set_base]. + </description> + </method> + <method name="set_layer_mask_bit"> + <return type="void"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + Enables a particular layer in [member layers]. + </description> + </method> + </methods> + <members> + <member name="layers" type="int" setter="set_layer_mask" getter="get_layer_mask" default="1"> + The render layer(s) this [VisualInstance3D] is drawn on. + This object will only be visible for [Camera3D]s whose cull mask includes the render object this [VisualInstance3D] is set to. + </member> + </members> + <constants> + </constants> +</class> |