2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2021-03-23 13:40:34 +01:00
<class name= "VisualInstance" inherits= "Spatial" version= "3.3" >
2017-09-12 22:42:36 +02:00
<brief_description >
2020-01-14 22:27:14 +01:00
Parent of all visual 3D nodes.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2020-01-23 11:14:14 +01:00
The [VisualInstance] is used to connect a resource to a visual representation. All visual 3D nodes inherit from the [VisualInstance]. In general, you should not access the [VisualInstance] properties directly as they are accessed and managed by the nodes that inherit from [VisualInstance]. [VisualInstance] is the node representation of the [VisualServer] instance.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "get_aabb" qualifiers= "const" >
2017-11-17 03:09:00 +01:00
<return type= "AABB" >
2017-09-12 22:42:36 +02:00
</return>
<description >
2020-09-16 15:53:10 +02:00
Returns the [AABB] (also known as the bounding box) for this [VisualInstance]. See also [method get_transformed_aabb].
2017-09-12 22:42:36 +02:00
</description>
</method>
2019-04-23 21:39:09 +02:00
<method name= "get_base" qualifiers= "const" >
<return type= "RID" >
</return>
<description >
2020-01-23 11:14:14 +01:00
Returns the RID of the resource associated with this [VisualInstance]. For example, if the Node is a [MeshInstance], this will return the RID of the associated [Mesh].
2019-04-23 21:39:09 +02:00
</description>
</method>
<method name= "get_instance" qualifiers= "const" >
<return type= "RID" >
</return>
<description >
2020-01-23 11:14:14 +01:00
Returns the RID of this instance. This RID is the same as the RID returned by [method VisualServer.instance_create]. This RID is needed if you want to call [VisualServer] functions directly on this [VisualInstance].
2019-04-23 21:39:09 +02:00
</description>
</method>
2018-08-21 00:35:30 +02:00
<method name= "get_layer_mask_bit" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "layer" type= "int" >
</argument>
<description >
2020-01-14 22:27:14 +01:00
Returns [code]true[/code] when the specified layer is enabled in [member layers] and [code]false[/code] otherwise.
2018-08-21 00:35:30 +02:00
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "get_transformed_aabb" qualifiers= "const" >
2017-11-17 03:09:00 +01:00
<return type= "AABB" >
2017-09-12 22:42:36 +02:00
</return>
<description >
2020-01-23 11:14:14 +01:00
Returns the transformed [AABB] (also known as the bounding box) for this [VisualInstance].
2020-09-16 15:53:10 +02:00
Transformed in this case means the [AABB] plus the position, rotation, and scale of the [Spatial]'s [Transform]. See also [method get_aabb].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "set_base" >
<return type= "void" >
</return>
<argument index= "0" name= "base" type= "RID" >
</argument>
<description >
2020-01-23 11:14:14 +01:00
Sets the resource that is instantiated by this [VisualInstance], which changes how the engine handles the [VisualInstance] under the hood. Equivalent to [method VisualServer.instance_set_base].
2017-09-12 22:42:36 +02:00
</description>
</method>
2018-08-21 00:35:30 +02:00
<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 >
2020-01-14 22:27:14 +01:00
Enables a particular layer in [member layers].
2018-08-21 00:35:30 +02:00
</description>
</method>
2017-09-12 22:42:36 +02:00
</methods>
<members >
2019-06-29 12:38:01 +02:00
<member name= "layers" type= "int" setter= "set_layer_mask" getter= "get_layer_mask" default= "1" >
2020-01-23 11:14:14 +01:00
The render layer(s) this [VisualInstance] is drawn on.
This object will only be visible for [Camera]s whose cull mask includes the render object this [VisualInstance] is set to.
2017-09-12 22:42:36 +02:00
</member>
</members>
<constants >
</constants>
</class>