Class PlaneGeometry

平面几何体

Hierarchy

Geometry
- PlaneGeometry

Index

Constructors

Properties

__class__ assetId assetType attributes emitter height indexBuffer name scaleU scaleV segmentsH segmentsW width yUp

Accessors

bounding geometryInfo numTriangles numVertex

Methods

addGeometry applyTransformation beforeRender buildGeometry clear clone cloneFrom getFaces getVertices invalidateBounds invalidateGeometry raycast updateGrometry create getDefault setDefault

Constructors

constructor

new PlaneGeometry(param?: gPartial<PlaneGeometry>): PlaneGeometry
Parameters
- Optional param: gPartial<PlaneGeometry>
Returns PlaneGeometry
Overrides Geometry.constructor
- Defined in src/3d/geometrys/PlaneGeometry.ts:63

Properties

class

__class__: "PlaneGeometry"

assetId

assetId: string

资源编号

assetType

assetType: AssetType = AssetType.geometry

attributes

attributes: {
[key: string]: AttributeBuffer;
} = {}

属性数据列表

Type declaration

[key: string]: AttributeBuffer

`Readonly` emitter

emitter: EventEmitter<GeometryEventMap> = ...

事件发射器。

height

height: number = 1

高度

indexBuffer

indexBuffer: ElementBuffer

顶点索引缓冲

name

name: string = 'Plane'

scaleU

scaleU: number = 1

纹理U缩放，默认为1。

scaleV

scaleV: number = 1

纹理V缩放，默认为1。

segmentsH

segmentsH: number = 1

纵向分割数

segmentsW

segmentsW: number = 1

横向分割数

width

width: number = 1

宽度

yUp

yUp: boolean = true

是否朝上

Accessors

bounding

get bounding(): Box3
Returns Box3
Inherited from Geometry.bounding
- Defined in src/3d/geometrys/Geometry.ts:250

geometryInfo

get geometryInfo(): string
几何体信息

Returns string
Inherited from Geometry.geometryInfo
- Defined in src/3d/geometrys/Geometry.ts:79

numTriangles

get numTriangles(): number
三角形数量

Returns number
Inherited from Geometry.numTriangles
- Defined in src/3d/geometrys/Geometry.ts:136

numVertex

get numVertex(): number
顶点数量

Returns number
Inherited from Geometry.numVertex
- Defined in src/3d/geometrys/Geometry.ts:124

Methods

addGeometry

addGeometry(geometry: Geometry, transform?: Matrix4x4): void
添加几何体
Parameters
- geometry: Geometry
  
  被添加的几何体
- Optional transform: Matrix4x4
  
  变换矩阵，把克隆被添加几何体的数据变换后再添加到该几何体中
Returns void
Inherited from Geometry.addGeometry
- Defined in src/3d/geometrys/Geometry.ts:148

applyTransformation

applyTransformation(transform: Matrix4x4): void
应用变换矩阵
Parameters
- transform: Matrix4x4
  
  变换矩阵
Returns void
Inherited from Geometry.applyTransformation
- Defined in src/3d/geometrys/Geometry.ts:212

beforeRender

beforeRender(renderAtomic: RenderAtomic): void
Parameters
- renderAtomic: RenderAtomic
Returns void
Inherited from Geometry.beforeRender
- Defined in src/3d/geometrys/Geometry.ts:348

`Protected` buildGeometry

buildGeometry(): void
构建几何体数据

Returns void
Overrides Geometry.buildGeometry
- Defined in src/3d/geometrys/PlaneGeometry.ts:77

clear

clear(): void
清理数据

Returns void
Inherited from Geometry.clear
- Defined in src/3d/geometrys/Geometry.ts:379

clone

clone(): Geometry
克隆一个几何体

Returns Geometry
Inherited from Geometry.clone
- Defined in src/3d/geometrys/Geometry.ts:314

cloneFrom

cloneFrom(geometry: Geometry): void
从一个几何体中克隆数据
Parameters
- geometry: Geometry
Returns void
Inherited from Geometry.cloneFrom
- Defined in src/3d/geometrys/Geometry.ts:326

getFaces

getFaces(result?: number[][]): number[][]
Parameters
- result: number[][] = []
Returns number[][]
Inherited from Geometry.getFaces
- Defined in src/3d/geometrys/Geometry.ts:300

getVertices

getVertices(result?: Vector3[]): Vector3[]
获取顶点列表
Parameters
- result: Vector3[] = []
Returns Vector3[]
Inherited from Geometry.getVertices
- Defined in src/3d/geometrys/Geometry.ts:289

invalidateBounds

invalidateBounds(): void
包围盒失效

Returns void
Inherited from Geometry.invalidateBounds
- Defined in src/3d/geometrys/Geometry.ts:244

invalidateGeometry

invalidateGeometry(): void
标记需要更新几何体，在更改几何体数据后需要调用该函数。

Returns void
Inherited from Geometry.invalidateGeometry
- Defined in src/3d/geometrys/Geometry.ts:95

raycast

raycast(ray: Ray3, shortestCollisionDistance?: number, cullFace?: CullFace): {
    index: number;
    localNormal: Vector3;
    localPosition: Vector3;
    rayEntryDistance: number;
    uv: Vector2;
}
射线投影几何体
Parameters
- ray: Ray3
  
  射线
- shortestCollisionDistance: number = Number.MAX_VALUE
  
  当前最短碰撞距离
- cullFace: CullFace = 'NONE'
  
  裁剪面枚举
Returns {
    index: number;
    localNormal: Vector3;
    localPosition: Vector3;
    rayEntryDistance: number;
    uv: Vector2;
}
- index: number
- localNormal: Vector3
- localPosition: Vector3
- rayEntryDistance: number
- uv: Vector2
Inherited from Geometry.raycast
- Defined in src/3d/geometrys/Geometry.ts:273

updateGrometry

updateGrometry(): void
更新几何体

Returns void
Inherited from Geometry.updateGrometry
- Defined in src/3d/geometrys/Geometry.ts:105

`Static` create

create<K>(geometry: K, params?: gPartial<GeometryMap[K]>): GeometryMap[K]
构造几何体。

Returns
几何体实例。
Type Parameters
- K extends keyof GeometryMap
Parameters
- geometry: K
  
  几何体名称。
- Optional params: gPartial<GeometryMap[K]>
  
  几何体参数。
Returns GeometryMap[K]
Inherited from Geometry.create
- Defined in src/3d/geometrys/Geometry.ts:396

`Static` getDefault

getDefault<K>(name: K): DefaultGeometryMap[K]
获取默认几何体
Type Parameters
- K extends keyof DefaultGeometryMap
Parameters
- name: K
  
  默认几何体名称
Returns DefaultGeometryMap[K]
Inherited from Geometry.getDefault
- Defined in src/3d/geometrys/Geometry.ts:422

`Static` setDefault

setDefault<K>(name: K, geometry: DefaultGeometryMap[K], param?: gPartial<DefaultGeometryMap[K]>): void
设置默认几何体
Type Parameters
- K extends keyof DefaultGeometryMap
Parameters
- name: K
  
  默认几何体名称
- geometry: DefaultGeometryMap[K]
  
  默认几何体
- Optional param: gPartial<DefaultGeometryMap[K]>
Returns void
Inherited from Geometry.setDefault
- Defined in src/3d/geometrys/Geometry.ts:409

Generated using TypeDoc