类 BatchRender

_extra

_id

接口_receiveShadow

_renderElements

_singleton

只读owner

runInEditor

scriptPath

awaked

• get awaked(): boolean

• 返回 boolean

  En

  whether the component has been awakened.

  Zh

  组件是否已经被唤醒。

bounds

• get bounds(): Bounds

• 返回 Bounds

  En

  The bounds. Read-only, do not modify its value.

  Zh

  包围盒。只读，不允许修改其值。

boundsChange

• get boundsChange(): boolean

• 返回 boolean

  En

  Whether the bounds have changed.

  Zh

  包围盒是否更新。

• set boundsChange(value): void

• 参数

  • value: boolean

  返回 void

castShadow

• get castShadow(): boolean

• 返回 boolean

  En

  Whether the object casts shadows.

  Zh

  是否产生阴影。

• set castShadow(value): void

• 参数

  • value: boolean

  返回 void

destroyed

• get destroyed(): boolean

• 返回 boolean

  En

  whether the component has been destroyed.

  Zh

  组件是否已经被销毁。

distanceForSort

• get distanceForSort(): number

• 返回 number

  En

  The distance used for sorting.

  Zh

  排序距离。

• set distanceForSort(value): void

• 参数

  • value: number

  返回 void

enabled

• get enabled(): boolean

• 返回 boolean

  En

  Whether to enable the renderer.

  Zh

  是否启用。

• set enabled(value): void

• 参数

  • value: boolean

  返回 void

  En

  whether the component is enabled.

  Zh

  是否启用组件。

geometryBounds

• get geometryBounds(): Bounds

• 返回 Bounds

  En

  The Geometry Bounds. If this bounds is set, the render bounding box will be updated based on geometryBounds and transform, and the native layer will be sunk.

  Zh

  几何包围盒， 如果设置了此包围盒，渲染包围盒会根据 geometryBounds 和变换来更新，并且原生层会下沉。

• set geometryBounds(value): void

• 参数

  • value: Bounds

  返回 void

hideFlags

• get hideFlags(): number

• 返回 number

  En

  The hide flags that determine the hiding behavior of the component.

  Zh

  确定组件隐藏行为的标志。

• set hideFlags(value): void

• 参数

  • value: number

  返回 void

id

• get id(): number

• 返回 number

  En

  The unique identifier for the component.

  Zh

  组件的唯一标识。

irradientMode

• get irradientMode(): IrradianceMode

• 返回 IrradianceMode

  En

  The irradient mode.

  Zh

  间接光照功能。

lightmapIndex

• get lightmapIndex(): number

• 返回 number

  En

  The lightmap index.

  Zh

  光照贴图的索引。

• set lightmapIndex(value): void

• 参数

  • value: number

  返回 void

lightmapScaleOffset

• get lightmapScaleOffset(): Vector4

• 返回 Vector4

  En

  The lightmap scale and offset.

  Zh

  光照贴图的缩放和偏移。

• set lightmapScaleOffset(value): void

• 参数

  • value: Vector4

  返回 void

lightProbe

• get lightProbe(): VolumetricGI

• 返回 VolumetricGI

  En

  The light probe.

  Zh

  光照探针。

• set lightProbe(volumetricGI): void

• 参数

  • volumetricGI: VolumetricGI

  返回 void

material

• get material(): Material

• 返回 Material

  已被弃用

  请使用shareMaterial接口 返回第一个实例材质,第一次使用会拷贝实例对象。

• set material(value): void

• 参数

  • value: Material

  返回 void

materials

• get materials(): Material[]

• 返回 Material[]

• set materials(value): void

• 参数

  • value: Material[]

  返回 void

probReflection

• set probReflection(value): void

• 参数

  • value: ReflectionProbe

  返回 void

receiveShadow

• get receiveShadow(): boolean

• 返回 boolean

  En

  Whether the object receives shadows.

  Zh

  是否接收阴影属性。

• set receiveShadow(value): void

• 参数

  • value: boolean

  返回 void

reflectionMode

• get reflectionMode(): ReflectionProbeMode

• 返回 ReflectionProbeMode

  En

  The reflection mode.

  Zh

  反射模式。

• set reflectionMode(value): void

• 参数

  • value: ReflectionProbeMode

  返回 void

renderbitFlag

• get renderbitFlag(): number

• 返回 number

  En

  The render bit flag of the render node.

  Zh

  渲染节点的渲染禁用位。

renderNode

• get renderNode(): IBaseRenderNode

• 返回 IBaseRenderNode

  En

  The render node.

  Zh

  渲染节点。

sharedMaterial

• get sharedMaterial(): Material

• 返回 Material

  En

  The first material.

  Zh

  第一个材质。

• set sharedMaterial(value): void

• 参数

  • value: Material

  返回 void

sharedMaterials

• get sharedMaterials(): Material[]

• 返回 Material[]

  En

  All shared materials.

  Zh

  所有渲染材质。

• set sharedMaterials(value): void

• 参数

  • value: Material[]

  返回 void

sortingFudge

• get sortingFudge(): number

• 返回 number

  En

  The sorting fudge value.

  Zh

  排序矫正值。

• set sortingFudge(value): void

• 参数

  • value: number

  返回 void

volume

• get volume(): Volume

• 返回 Volume

  En

  The volume light probe.

  Zh

  体积光探针。

• set volume(value): void

• 参数

  • value: Volume

  返回 void

可选_calculateBoundingBox

• _calculateBoundingBox(): void

• 返回 void

  En

  The function called by the bounding box calculation for each frame.

  Zh

  每一帧计算包围盒会调用的函数

可选_renderUpdate

• _renderUpdate(context3D): void

• 参数

  • context3D: IRenderContext3D

    The 3D rendering context.

  返回 void

  En

  Update the calling function of SpriteShaderData before rendering each frame.

  Zh

  每一帧渲染前更新SpriteShaderData的调用函数。

destroy

• destroy(): void

• 返回 void

  En

  Destroy components

  Zh

  销毁组件

hasHideFlag

• hasHideFlag(flag): boolean

• 参数

  • flag: number

    The hide flag to check for.

  返回 boolean

  En

  Checks if the component has a specific hide flag set.

  Zh

  检查组件是否设置了特定的隐藏标志。

onAdded

• onAdded(): void

• 返回 void

  En

  Called after the component is added to a node. Unlike Awake, onAdded is called even if the node is not active.

  Zh

  组件被添加到节点后调用，与 onAwake 不同的是，即使节点未激活也会调用 onAdded。

  Blueprint Event

onAwake

• onAwake(): void

• 返回 void

  En

  Executed after the component is activated. At this point, all nodes and components have been created. This method is executed only once.

  Zh

  组件被激活后执行，此时所有节点和组件均已创建完毕，此方法只执行一次。

  Blueprint Event

onDestroy

• onDestroy(): void

• 返回 void

  En

  Executed when the node is destroyed manually.

  Zh

  手动调用节点销毁时执行。

  Blueprint Event

onDisable

• onDisable(): void

• 返回 void

  En

  Executed when the component is disabled, such as when the node is removed from the stage.

  Zh

  组件被禁用时执行，比如从节点从舞台移除后。

  Blueprint Event

onEnable

• onEnable(): void

• 返回 void

  En

  Executed after the component is enabled, such as when the node is added to the stage.

  Zh

  组件被启用后执行，比如节点被添加到舞台后。

  Blueprint Event

可选onLateUpdate

• onLateUpdate(): void

• 返回 void

  En

  Executed every frame during the late update phase, after the update phase.

  Zh

  每帧更新时执行，在 late update 阶段，update 阶段之后。

  Blueprint Event

可选onPostRender

• onPostRender(): void

• 返回 void

  En

  Executed after rendering.

  Zh

  渲染之后执行。

  Blueprint Event

可选onReset

• onReset(): void

• 返回 void

  En

  Resets the component's parameters to their default values. If this function is implemented, the component will be reset and automatically recycled for future use. If not reset, it will not be recycled for reuse.

  Zh

  将组件的参数重置为默认值。如果实现了这个函数，组件将被重置并自动回收到对象池，方便下次复用。 如果没有重置，则不会进行回收复用。

可选onStart

• onStart(): void

• 返回 void

  En

  Executed once, before the first update.

  Zh

  在第一次执行 update 之前执行，只会执行一次。

  Blueprint Default Event

可选onUpdate

• onUpdate(): void

• 返回 void

  En

  Executed every frame during the update phase. Avoid writing complex loop logic or using the getComponent method here.

  Zh

  每帧更新时执行，在 update 阶段。尽量不要在这里写大循环逻辑或使用 getComponent 方法。

  Blueprint Event

renderUpdate

• renderUpdate(context): void

• 参数

  • context: RenderContext3D

  返回 void

setNodeCustomData

• setNodeCustomData(dataSlot, data): void

• 设置自定义的渲染数据

  参数

  • dataSlot: ENodeCustomData
  • data: number

  返回 void

setRenderbitFlag

• setRenderbitFlag(flag, pass): void

• 参数

  • flag: number

    The flag to set, refer to RenderBitFlag for related flags or define custom bit flags.
  • pass: boolean

    Whether to set the flag.

  返回 void

  En

  Sets the rendering flag, where each bit represents a different culling reason, 1 indicates LOD culling.

  Zh

  设置渲染标志，每一位都代表不同的淘汰原因，1表示LOD淘汰。

静态changeVertexDefine

• changeVertexDefine(oldMesh, mesh, defineDatas): void

• 参数

  • oldMesh: Mesh

    The old mesh.
  • mesh: Mesh

    The new mesh.
  • defineDatas: ShaderData

    The shader data containing definitions.

  返回 void

  En

  Change vertex shader definitions based on mesh changes.

  Zh

  根据网格变化更改顶点着色器宏定义。

静态shaderValueInit

• shaderValueInit(): void

• 返回 void

  En

  Macro definition initialization

  Zh

  宏定义初始化