VisualInstance3D

Inherits: Node3D < Node < Object

Inherited By: Decal, FogVolume, GPUParticlesAttractor3D, GPUParticlesCollision3D, GeometryInstance3D, Light3D, LightmapGI, ReflectionProbe, RootMotionView, VisibleOnScreenNotifier3D, VoxelGI

Parent of all visual 3D nodes.

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.

Properties

int

layers

1

Methods

AABB

get_aabb ( ) const

RID

get_base ( ) const

RID

get_instance ( ) const

bool

get_layer_mask_value ( int layer_number ) const

AABB

get_transformed_aabb ( ) const

void

set_base ( RID base )

void

set_layer_mask_value ( int layer_number, bool value )

Property Descriptions

Default

1

Setter

set_layer_mask(value)

Getter

get_layer_mask()

The render layer(s) this VisualInstance3D is drawn on.

This object will only be visible for Camera3Ds whose cull mask includes the render object this VisualInstance3D is set to.

Method Descriptions

  • AABB get_aabb ( ) const

Returns the AABB (also known as the bounding box) for this VisualInstance3D. See also get_transformed_aabb.


  • RID get_base ( ) const

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.


  • RID get_instance ( ) const

Returns the RID of this instance. This RID is the same as the RID returned by RenderingServer.instance_create. This RID is needed if you want to call RenderingServer functions directly on this VisualInstance3D.


  • bool get_layer_mask_value ( int layer_number ) const

Returns whether or not the specified layer of the layers is enabled, given a layer_number between 1 and 20.


  • AABB get_transformed_aabb ( ) const

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 Transform3D. See also get_aabb.


  • void set_base ( RID base )

Sets the resource that is instantiated by this VisualInstance3D, which changes how the engine handles the VisualInstance3D under the hood. Equivalent to RenderingServer.instance_set_base.


  • void set_layer_mask_value ( int layer_number, bool value )

Based on value, enables or disables the specified layer in the layers, given a layer_number between 1 and 20.