VisualInstance

Inherits: CullInstance < Spatial < Node < Object

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

所有可视3D节点的父节点。

描述

VisualInstance用于连接一个资源和一个视觉显示。所有的可视化三维节点都继承自VisualInstance。你不应该直接访问VisualInstance的属性，一般来说，它们是由继承自VisualInstance的节点访问和管理的。VisualInstance是VisualServer实例的节点表示。

属性

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()

绘制此 VisualInstance 的渲染层。

此对象仅对Camera可见，其剔除遮罩包括此VisualInstance设置的渲染对象。

方法说明

  • AABB get_aabb ( ) const

返回此VisualInstance的AABB，也称为边界框。参阅get_transformed_aabb。

  • RID get_base ( ) const

返回与此VisualInstance相关的资源的RID。例如，如果该节点是一个MeshInstance，这将返回相关的Mesh的RID。

  • RID get_instance ( ) const

返回这个实例的RID。这个RID与VisualServer.instance_create所返回的RID相同。如果你想在这个VisualInstance上直接调用VisualServer函数，就需要这个RID。

  • bool get_layer_mask_bit ( int layer ) const

当指定的层在 layers 中被启用时，返回true，否则返回false。

  • AABB get_transformed_aabb ( ) const

返回此VisualInstance的变换后的AABB，也称为边界框。

这里的变换是指AABB加上Spatial的Transform的位置、旋转和缩放。参阅get_aabb。

  • void set_base ( RID base )

设置由该VisualInstance实例化的资源，这将改变引擎对该VisualInstance的处理方式。相当于VisualServer.instance_set_base。

  • void set_layer_mask_bit ( int layer, bool enabled )

启用 layers 中的特定层。