Inherits: Spatial < Node < Object
Inherited By: BakedLightmap, GIProbe, GeometryInstance, Light, ReflectionProbe, RootMotionView
Parent of all visual 3D nodes.
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.
int | layers | 1 |
AABB | get_aabb ( ) const |
RID | get_base ( ) const |
RID | get_instance ( ) const |
bool | get_layer_mask_bit ( int layer ) const |
AABB | get_transformed_aabb ( ) const |
void | set_base ( RID base ) |
void | set_layer_mask_bit ( int layer, bool enabled ) |
Default | 1 |
Setter | set_layer_mask(value) |
Getter | get_layer_mask() |
The render layer(s) this VisualInstance
is drawn on.
This object will only be visible for Cameras whose cull mask includes the render object this VisualInstance
is set to.
Returns the AABB (also known as the bounding box) for this VisualInstance
. See also get_transformed_aabb.
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.
Returns the RID of this instance. This RID is the same as the RID returned by VisualServer.instance_create. This RID is needed if you want to call VisualServer functions directly on this VisualInstance
.
Returns true
when the specified layer is enabled in layers and false
otherwise.
Returns the transformed AABB (also known as the bounding box) for this VisualInstance
.
Transformed in this case means the AABB plus the position, rotation, and scale of the Spatial's Transform. See also get_aabb.
Sets the resource that is instantiated by this VisualInstance
, which changes how the engine handles the VisualInstance
under the hood. Equivalent to VisualServer.instance_set_base.
Enables a particular layer in layers.
© 2014–2020 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
https://docs.godotengine.org/en/3.2/classes/class_visualinstance.html