VisualInstance

Inherits: Spatial < Node < Object

Inherited By: BakedLightmap, CSGShape, GIProbe, GeometryInstance, Light, ReflectionProbe, RootMotionView

Category: Core

Brief Description

Properties

intlayers

Methods

AABBget_aabb ( ) const
RIDget_base ( ) const
RIDget_instance ( ) const
boolget_layer_mask_bit ( int layer ) const
AABBget_transformed_aabb ( ) const
voidset_base ( RID base )
voidset_layer_mask_bit ( int layer, bool enabled )

Property Descriptions

Setterset_layer_mask(value)
Getterget_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.

Method Descriptions

  • AABB get_aabb ( ) const

Returns the AABB (also known as the bounding box) for this VisualInstance.

  • RID get_base ( ) const
  • RID get_instance ( ) const
  • bool get_layer_mask_bit ( int layer ) const
  • AABB get_transformed_aabb ( ) const

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 Spatials Transform

  • void set_base ( RID base )

Sets the base of the VisualInstance, which changes how the engine handles the VisualInstance under the hood.

It is recommended to only use set_base if you know what you’re doing.

  • void set_layer_mask_bit ( int layer, bool enabled )