类 PixelLineRenderer

En

PixelLineRenderer class for line rendering.

Zh

PixelLineRenderer 类用于线渲染器。

层级 (查看完整内容)

BaseRender
- PixelLineRenderer

属性

_extra

_extra: IComponentExtra

En

Extra data of the node.

Zh

组件的额外数据。IDE内部使用。

Blueprint Ignore

_id

_id: number

En

Unique identifier for the component.

Zh

组件的唯一标识。

`接口`_receiveShadow

_receiveShadow: boolean

_renderElements

_renderElements: RenderElement[] = []

_singleton

_singleton: boolean

En

Whether the component is a singleton, meaning only one instance of this type of script can be added to the same node.

Zh

是否为单例，即同一个节点只能添加此类型的脚本一次。

`只读`owner

owner: Sprite3D

En

Gets the owner Node to which the component belongs.

Zh

获取组件所属的 Node 节点。

runInEditor

runInEditor: boolean

En

Whether the script can run in the IDE environment.

Zh

是否可以在 IDE 环境中运行。

Blueprint Ignore

scriptPath

scriptPath: string

En

The path of the script file.

Zh

脚本文件的路径。

Blueprint Ignore

访问器

awaked

get awaked(): boolean
返回 boolean
En
whether the component has been awakened.

Zh
组件是否已经被唤醒。
继承自 BaseRender.awaked
- 定义于 src/layaAir/laya/components/Component.ts:136

bounds

get bounds(): Bounds
返回 Bounds
En
The bounds of the line renderer.

Zh
线渲染器的包围盒。
重写了 BaseRender.bounds
- 定义于 src/layaAir/laya/d3/core/pixelLine/PixelLineRenderer.ts:55

boundsChange

get boundsChange(): boolean
返回 boolean
En
Whether the bounds have changed.

Zh
包围盒是否更新。
继承自 BaseRender.boundsChange
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:245
set boundsChange(value): void
参数
- value: boolean
返回 void
继承自 BaseRender.boundsChange
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:248

castShadow

get castShadow(): boolean
返回 boolean
En
Whether the object casts shadows.

Zh
是否产生阴影。
继承自 BaseRender.castShadow
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:442
set castShadow(value): void
参数
- value: boolean
返回 void
继承自 BaseRender.castShadow
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:446

destroyed

get destroyed(): boolean
返回 boolean
En
whether the component has been destroyed.

Zh
组件是否已经被销毁。
继承自 BaseRender.destroyed
- 定义于 src/layaAir/laya/components/Component.ts:144

distanceForSort

get distanceForSort(): number
返回 number
En
The distance used for sorting.

Zh
排序距离。
继承自 BaseRender.distanceForSort
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:265
set distanceForSort(value): void
参数
- value: number
返回 void
继承自 BaseRender.distanceForSort
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:268

enabled

get enabled(): boolean
返回 boolean
En
Whether to enable the renderer.

Zh
是否启用。
继承自 BaseRender.enabled
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:214
set enabled(value): void
参数
- value: boolean
返回 void
En
whether the component is enabled.

Zh
是否启用组件。
继承自 BaseRender.enabled
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:217

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 和变换来更新，并且原生层会下沉。
继承自 BaseRender.geometryBounds
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:278
set geometryBounds(value): void
参数
- value: Bounds
返回 void
继承自 BaseRender.geometryBounds
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:281

hideFlags

get hideFlags(): number
返回 number
En
The hide flags that determine the hiding behavior of the component.

Zh
确定组件隐藏行为的标志。
继承自 BaseRender.hideFlags
- 定义于 src/layaAir/laya/components/Component.ts:70
set hideFlags(value): void
参数
- value: number
返回 void
继承自 BaseRender.hideFlags
- 定义于 src/layaAir/laya/components/Component.ts:74

id

get id(): number
返回 number
En
The unique identifier for the component.

Zh
组件的唯一标识。
继承自 BaseRender.id
- 定义于 src/layaAir/laya/components/Component.ts:112

irradientMode

get irradientMode(): IrradianceMode
返回 IrradianceMode
En
The irradient mode.

Zh
间接光照功能。
继承自 BaseRender.irradientMode
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:320

lightmapIndex

get lightmapIndex(): number
返回 number
En
The lightmap index.

Zh
光照贴图的索引。
继承自 BaseRender.lightmapIndex
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:289
set lightmapIndex(value): void
参数
- value: number
返回 void
继承自 BaseRender.lightmapIndex
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:293

lightmapScaleOffset

get lightmapScaleOffset(): Vector4
返回 Vector4
En
The lightmap scale and offset.

Zh
光照贴图的缩放和偏移。
继承自 BaseRender.lightmapScaleOffset
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:328
set lightmapScaleOffset(value): void
参数
- value: Vector4
返回 void
继承自 BaseRender.lightmapScaleOffset
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:332

lightProbe

get lightProbe(): VolumetricGI
返回 VolumetricGI
En
The light probe.

Zh
光照探针。
继承自 BaseRender.lightProbe
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:521
set lightProbe(volumetricGI): void
参数
- volumetricGI: VolumetricGI
返回 void
继承自 BaseRender.lightProbe
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:525

lineCount

get lineCount(): number
返回 number
En
The current number of lines.

Zh
当前线数量。
- 定义于 src/layaAir/laya/d3/core/pixelLine/PixelLineRenderer.ts:100

material

get material(): Material
返回 Material
已被弃用
请使用shareMaterial接口返回第一个实例材质,第一次使用会拷贝实例对象。
继承自 BaseRender.material
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:844
set material(value): void
参数
- value: Material
返回 void
继承自 BaseRender.material
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:858

materials

get materials(): Material[]
返回 Material[]
继承自 BaseRender.materials
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:865
set materials(value): void
参数
- value: Material[]
返回 void
继承自 BaseRender.materials
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:876

maxLineCount

get maxLineCount(): number
返回 number
En
The maximum number of lines.

Zh
最大线数量。
- 定义于 src/layaAir/laya/d3/core/pixelLine/PixelLineRenderer.ts:87
set maxLineCount(value): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/core/pixelLine/PixelLineRenderer.ts:91

pixelLinesDatas

get pixelLinesDatas(): PixelLineData[]
返回 PixelLineData[]
En
The line segment data.

Zh
线段数据。
- 定义于 src/layaAir/laya/d3/core/pixelLine/PixelLineRenderer.ts:67
set pixelLinesDatas(value): void
参数
- value: PixelLineData[]
返回 void
- 定义于 src/layaAir/laya/d3/core/pixelLine/PixelLineRenderer.ts:74

probReflection

set probReflection(value): void
参数
- value: ReflectionProbe
返回 void
继承自 BaseRender.probReflection
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:496

receiveShadow

get receiveShadow(): boolean
返回 boolean
En
Whether the object receives shadows.

Zh
是否接收阴影属性。
继承自 BaseRender.receiveShadow
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:423
set receiveShadow(value): void
参数
- value: boolean
返回 void
继承自 BaseRender.receiveShadow
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:427

reflectionMode

get reflectionMode(): ReflectionProbeMode
返回 ReflectionProbeMode
En
The reflection mode.

Zh
反射模式。
继承自 BaseRender.reflectionMode
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:454
set reflectionMode(value): void
参数
- value: ReflectionProbeMode
返回 void
继承自 BaseRender.reflectionMode
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:458

renderbitFlag

get renderbitFlag(): number
返回 number
En
The render bit flag of the render node.

Zh
渲染节点的渲染禁用位。
继承自 BaseRender.renderbitFlag
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:237

renderNode

get renderNode(): IBaseRenderNode
返回 IBaseRenderNode
En
The render node.

Zh
渲染节点。
继承自 BaseRender.renderNode
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:257

sharedMaterial

get sharedMaterial(): Material
返回 Material
En
The first material.

Zh
第一个材质。
继承自 BaseRender.sharedMaterial
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:341
set sharedMaterial(value): void
参数
- value: Material
返回 void
继承自 BaseRender.sharedMaterial
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:345

sharedMaterials

get sharedMaterials(): Material[]
返回 Material[]
En
All shared materials.

Zh
所有渲染材质。
继承自 BaseRender.sharedMaterials
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:366
set sharedMaterials(value): void
参数
- value: Material[]
返回 void
继承自 BaseRender.sharedMaterials
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:370

sortingFudge

get sortingFudge(): number
返回 number
En
The sorting fudge value.

Zh
排序矫正值。
继承自 BaseRender.sortingFudge
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:226
set sortingFudge(value): void
参数
- value: number
返回 void
继承自 BaseRender.sortingFudge
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:229

volume

get volume(): Volume
返回 Volume
En
The volume light probe.

Zh
体积光探针。
继承自 BaseRender.volume
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:466
set volume(value): void
参数
- value: Volume
返回 void
继承自 BaseRender.volume
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:470

方法

`可选`_calculateBoundingBox

_calculateBoundingBox(): void
返回 void
En
The function called by the bounding box calculation for each frame.

Zh
每一帧计算包围盒会调用的函数
继承自 BaseRender._calculateBoundingBox
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:597

_cloneTo

_cloneTo(dest): void
参数
- dest: PixelLineRenderer
返回 void
重写了 BaseRender._cloneTo
- 定义于 src/layaAir/laya/d3/core/pixelLine/PixelLineRenderer.ts:408

`可选`_renderUpdate

_renderUpdate(context3D): void
参数
- context3D: IRenderContext3D
  The 3D rendering context.
返回 void
En
Update the calling function of SpriteShaderData before rendering each frame.

Zh
每一帧渲染前更新SpriteShaderData的调用函数。
继承自 BaseRender._renderUpdate
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:605

addLine

addLine(startPosition, endPosition, startColor, endColor): void
参数
- startPosition: Vector3
  Initial point position
- endPosition: Vector3
  End point position
- startColor: Color
  Initial point color
- endColor: Color
  End point color
返回 void
En
Add a line.

Zh
增加一条线。
- 定义于 src/layaAir/laya/d3/core/pixelLine/PixelLineRenderer.ts:212

addLines

addLines(lines): void
参数
- lines: PixelLineData[]
  Line segment data
返回 void
En
Add multiple line segments.

Zh
添加多条线段。
- 定义于 src/layaAir/laya/d3/core/pixelLine/PixelLineRenderer.ts:264

addLineWithNormal

addLineWithNormal(startPosition, endPosition, startColor, endColor, startNormal, endNormal): void
参数
- startPosition: Vector3
  Initial point position
- endPosition: Vector3
  End point position
- startColor: Color
  Initial point color
- endColor: Color
  End point color
- startNormal: Vector3
  Initial point normal
- endNormal: Vector3
  End point normal
返回 void
En
Add a line with normal.

Zh
增加一条带有法线的线。
- 定义于 src/layaAir/laya/d3/core/pixelLine/PixelLineRenderer.ts:243

clear

clear(): void
返回 void
En
Clear all line segments.

Zh
清除所有线段。
- 定义于 src/layaAir/laya/d3/core/pixelLine/PixelLineRenderer.ts:395

destroy

destroy(): void
返回 void
En
Destroy components

Zh
销毁组件
继承自 BaseRender.destroy
- 定义于 src/layaAir/laya/components/Component.ts:294

getLine

getLine(index, out): void
参数
- index: number
  Index of the line to get
- out: PixelLineData
  Output line segment data
返回 void
En
Get line segment data.

Zh
获取线段数据。
- 定义于 src/layaAir/laya/d3/core/pixelLine/PixelLineRenderer.ts:374

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
检查组件是否设置了特定的隐藏标志。
继承自 BaseRender.hasHideFlag
- 定义于 src/layaAir/laya/components/Component.ts:104

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
继承自 BaseRender.onAdded
- 定义于 src/layaAir/laya/components/Component.ts:336

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
继承自 BaseRender.onAwake
- 定义于 src/layaAir/laya/components/Component.ts:352

onDestroy

onDestroy(): void
返回 void
En
Executed when the node is destroyed manually.

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

Blueprint Event
继承自 BaseRender.onDestroy
- 定义于 src/layaAir/laya/components/Component.ts:411

onDisable

onDisable(): void
返回 void
En
Executed when the component is disabled, such as when the node is removed from the stage.

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

Blueprint Event
继承自 BaseRender.onDisable
- 定义于 src/layaAir/laya/components/Component.ts:403

onEnable

onEnable(): void
返回 void
En
Executed after the component is enabled, such as when the node is added to the stage.

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

Blueprint Event
继承自 BaseRender.onEnable
- 定义于 src/layaAir/laya/components/Component.ts:360

`可选`onLateUpdate

onLateUpdate(): void
返回 void
En
Executed every frame during the late update phase, after the update phase.

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

Blueprint Event
继承自 BaseRender.onLateUpdate
- 定义于 src/layaAir/laya/components/Component.ts:382

`可选`onPostRender

onPostRender(): void
返回 void
En
Executed after rendering.

Zh
渲染之后执行。

Blueprint Event
继承自 BaseRender.onPostRender
- 定义于 src/layaAir/laya/components/Component.ts:396

`可选`onPreRender

onPreRender(): void
返回 void
En
Executed before rendering.

Zh
渲染之前执行。

Blueprint Event
继承自 BaseRender.onPreRender
- 定义于 src/layaAir/laya/components/Component.ts:389

`可选`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
将组件的参数重置为默认值。如果实现了这个函数，组件将被重置并自动回收到对象池，方便下次复用。如果没有重置，则不会进行回收复用。
继承自 BaseRender.onReset
- 定义于 src/layaAir/laya/components/Component.ts:345

`可选`onStart

onStart(): void
返回 void
En
Executed once, before the first update.

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

Blueprint Default Event
继承自 BaseRender.onStart
- 定义于 src/layaAir/laya/components/Component.ts:368

`可选`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
继承自 BaseRender.onUpdate
- 定义于 src/layaAir/laya/components/Component.ts:375

removeLine

removeLine(index): void
参数
- index: number
  Index of the line to remove
返回 void
En
Remove a line segment.

Zh
移除一条线段。
- 定义于 src/layaAir/laya/d3/core/pixelLine/PixelLineRenderer.ts:288

renderUpdate

renderUpdate(context): void
参数
- context: RenderContext3D
  The render context.
返回 void
En
Update the render context.

Zh
更新渲染上下文。
重写了 BaseRender.renderUpdate
- 定义于 src/layaAir/laya/d3/core/pixelLine/PixelLineRenderer.ts:158

setLine

setLine(index, startPosition, endPosition, startColor, endColor): void
参数
- index: number
  Index of the line to update
- startPosition: Vector3
  Initial point position
- endPosition: Vector3
  End point position
- startColor: Color
  Initial point color
- endColor: Color
  End point color
返回 void
En
Update a line.

Zh
更新线。
- 定义于 src/layaAir/laya/d3/core/pixelLine/PixelLineRenderer.ts:314

setLineWithNormal

setLineWithNormal(index, startPosition, endPosition, startColor, endColor, startNormal, endNormal): void
参数
- index: number
  Index of the line to update
- startPosition: Vector3
  Initial point position
- endPosition: Vector3
  End point position
- startColor: Color
  Initial point color
- endColor: Color
  End point color
- startNormal: Vector3
  Initial point normal
- endNormal: Vector3
  End point normal
返回 void
En
Update a line with normal.

Zh
更新带有法线的线。
- 定义于 src/layaAir/laya/d3/core/pixelLine/PixelLineRenderer.ts:348

setNodeCustomData

setNodeCustomData(dataSlot, data): void
设置自定义的渲染数据
参数
- dataSlot: ENodeCustomData
- data: number
返回 void
继承自 BaseRender.setNodeCustomData
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:553

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淘汰。
继承自 BaseRender.setRenderbitFlag
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:831

`静态`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
根据网格变化更改顶点着色器宏定义。
继承自 BaseRender.changeVertexDefine
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:126

`静态`shaderValueInit

shaderValueInit(): void
返回 void
En
Macro definition initialization

Zh
宏定义初始化
继承自 BaseRender.shaderValueInit
- 定义于 src/layaAir/laya/d3/core/render/BaseRender.ts:145

类 PixelLineRenderer

En

Zh

层级 (查看完整内容)

索引

属性

访问器

方法

属性

_extra

En

Zh

Blueprint Ignore

_id

En

Zh

接口_receiveShadow

_renderElements

_singleton

En

Zh

只读owner

En

Zh

runInEditor

En

Zh

Blueprint Ignore

scriptPath

En

Zh

Blueprint Ignore

访问器

awaked

返回 boolean

En

Zh

bounds

返回 Bounds

En

Zh

boundsChange

返回 boolean

En

Zh

参数

返回 void

castShadow

返回 boolean

En

Zh

参数

返回 void

destroyed

返回 boolean

En

Zh

distanceForSort

返回 number

En

Zh

参数

返回 void

enabled

返回 boolean

En

Zh

参数

返回 void

En

Zh

geometryBounds

返回 Bounds

En

Zh

参数

返回 void

hideFlags

返回 number

En

`接口`_receiveShadow

`只读`owner