Class BoxGeometry

长方体几何体

Hierarchy (View Summary)

Geometry
- BoxGeometry

Index

Constructors

constructor

Accessors

isDirty normals revision tangents tangents1

Constructors

constructor

new BoxGeometry(params?: BoxGeometryParameters): BoxGeometry
Parameters
- params: BoxGeometryParameters = {}
  创建对象的属性参数。可包含此类的所有属性。
  
  params.width: box的宽度
  
  params.height: box的高度
  
  params.depth: box的深度
  
  params.widthSegments: 水平分割面的数量
  
  params.heightSegments: 垂直分割面的数量
  
  params.depthSegments: 深度分割面的数量
Returns BoxGeometry
Overrides Geometry.constructor
- Defined in geometry/BoxGeometry.ts:57

Properties

`Readonly`className

className: string = 'BoxGeometry'

colors

colors: GeometryData | null = null

color 数据

currentIndicesCount

currentIndicesCount: number = 0

currentVerticesCount

currentVerticesCount: number = 0

depth

depth: number = 1

box的深度

depthSegments

depthSegments: number = 1

深度分割面的数量

height

height: number = 1

box的高度

heightSegments

heightSegments: number = 1

垂直分割面的数量

`Readonly`id

id: string

indices

indices: GeometryData | null = null

顶点索引数据

isBoxGeometry

isBoxGeometry: boolean = true

`Readonly`isGeometry

isGeometry: true

`Readonly`isMorphGeometry

isMorphGeometry: boolean = false

isStatic

isStatic: boolean = true

是否是静态

mode

mode: number = TRIANGLES

绘制模式

normalDecodeMat

normalDecodeMat: number[] | Float32Array<ArrayBufferLike> | null = null

positionDecodeMat

positionDecodeMat: number[] | Float32Array<ArrayBufferLike> | null = null

skinIndices

skinIndices: GeometryData | null = null

骨骼索引

skinWeights

skinWeights: GeometryData | null = null

骨骼权重数据

useAABBRaycast

useAABBRaycast: boolean = false

使用 aabb 碰撞检测

userData

userData: unknown = null

用户数据

uv1DecodeMat

uv1DecodeMat: number[] | Float32Array<ArrayBufferLike> | null = null

uvDecodeMat

uvDecodeMat: number[] | Float32Array<ArrayBufferLike> | null = null

uvs

uvs: GeometryData | null = null

uv 数据

uvs1

uvs1: GeometryData | null = null

uv1 数据

vertices

vertices: GeometryData | null = null

顶点数据

width

width: number = 1

box的宽度

widthSegments

widthSegments: number = 1

水平分割面的数量

Accessors

isDirty

get isDirty(): boolean
Returns boolean
Inherited from Geometry.isDirty
- Defined in geometry/Geometry.ts:257
set isDirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Geometry.isDirty
- Defined in geometry/Geometry.ts:260

normals

get normals(): GeometryData | null
法向量数据，如果没有的话会自动生成

Returns GeometryData | null
Inherited from Geometry.normals
- Defined in geometry/Geometry.ts:301
set normals(data: GeometryData | null): void
法向量数据，如果没有的话会自动生成
Parameters
- data: GeometryData | null
Returns void
Inherited from Geometry.normals
- Defined in geometry/Geometry.ts:310

revision

get revision(): number
Monotonic geometry-state revision observed independently by every backend.

Returns number
Inherited from Geometry.revision
- Defined in geometry/Geometry.ts:254

tangents

get tangents(): GeometryData | null
切线向量数据，如果没有的话会自动生成

Returns GeometryData | null
Inherited from Geometry.tangents
- Defined in geometry/Geometry.ts:356
set tangents(data: GeometryData | null): void
切线向量数据，如果没有的话会自动生成
Parameters
- data: GeometryData | null
Returns void
Inherited from Geometry.tangents
- Defined in geometry/Geometry.ts:365

tangents1

get tangents1(): GeometryData | null
切线向量数据，如果没有的话会自动生成

Returns GeometryData | null
Inherited from Geometry.tangents1
- Defined in geometry/Geometry.ts:371
set tangents1(data: GeometryData | null): void
切线向量数据，如果没有的话会自动生成
Parameters
- data: GeometryData | null
Returns void
Inherited from Geometry.tangents1
- Defined in geometry/Geometry.ts:380

Methods

_aabbRaycast

_aabbRaycast(ray: Ray): Vector3[] | null
检测 aabb 碰撞
Parameters
- ray: Ray
Returns Vector3[] | null
Inherited from Geometry._aabbRaycast
- Defined in geometry/Geometry.ts:974

_raycast

_raycast(ray: Ray, side: number): Vector3[] | null
_raycast，子类可覆盖实现
Parameters
- ray: Ray
- side: number
Returns Vector3[] | null
Overrides Geometry._raycast
- Defined in geometry/BoxGeometry.ts:324

addFace

addFace(p1: Point3, p2: Point3, p3: Point3): void
添加一个三角形 ABC
Parameters
- p1: Point3
  点A，如 [x, y, z]
- p2: Point3
  点B
- p3: Point3
  点C
Returns void
Inherited from Geometry.addFace
- Defined in geometry/Geometry.ts:708

addIndices

addIndices(...indices: number[]): void
添加顶点索引
Parameters
- ...indices: number[]
  顶点索引，如 addIndices(0, 1, 2)
Returns void
Inherited from Geometry.addIndices
- Defined in geometry/Geometry.ts:685

addLine

addLine(p1: Point3, p2: Point3): void
添加一条线
Parameters
- p1: Point3
  起点坐标，如 [x, y, z]
- p2: Point3
  终点坐标
Returns void
Inherited from Geometry.addLine
- Defined in geometry/Geometry.ts:698

addPoints

addPoints(...points: Point3[]): number
添加顶点
Parameters
- ...points: Point3[]
  顶点坐标，如 addPoints([x, y, z], [x, y, z])
Returns number
Inherited from Geometry.addPoints
- Defined in geometry/Geometry.ts:670

addRect

addRect(p1: Point3, p2: Point3, p3: Point3, p4: Point3): void
添加一个矩形 ABCD
Parameters
- p1: Point3
  点A，如 [x, y, z]
- p2: Point3
  点B
- p3: Point3
  点C
- p4: Point3
  点D
Returns void
Inherited from Geometry.addRect
- Defined in geometry/Geometry.ts:719

build

build(): void
Returns void
- Defined in geometry/BoxGeometry.ts:225

buildWithSegments

buildWithSegments(): void
Returns void
- Defined in geometry/BoxGeometry.ts:66

calculateNormals

calculateNormals(): void
Returns void
Inherited from Geometry.calculateNormals
- Defined in geometry/Geometry.ts:314

clone

clone(): Geometry
clone当前Geometry

Returns Geometry
返回clone的Geometry
Inherited from Geometry.clone
- Defined in geometry/Geometry.ts:921

convertToLinesMode

convertToLinesMode(): void
将三角形模式转换为线框模式，即 Material 中的 wireframe

Returns void
Inherited from Geometry.convertToLinesMode
- Defined in geometry/Geometry.ts:486

convertToNoIndices

convertToNoIndices(verticesItemLen?: 3 | 4): void
将 Geometry 转换成无 indices
Parameters
- verticesItemLen: 3 | 4 = 3
  转换结果的顶点数据的位数(3 or 4)，如果为4会补1
Returns void
Inherited from Geometry.convertToNoIndices
- Defined in geometry/Geometry.ts:853

getBounds

getBounds(matrix?: Matrix4, bounds?: Bounds): Bounds
获取指定matrix变化后的包围盒数据
Parameters
- Optionalmatrix: Matrix4
  matrix 需要变换的矩阵
- Optionalbounds: Bounds
  包围盒数据，传入的话会改变他
Returns Bounds
包围盒数据
Inherited from Geometry.getBounds
- Defined in geometry/Geometry.ts:767

getLocalBounds

getLocalBounds(force?: boolean): Bounds
获取本地包围盒
Parameters
- force: boolean = false
  是否强制刷新
Returns Bounds
Inherited from Geometry.getLocalBounds
- Defined in geometry/Geometry.ts:810

getLocalSphereBounds

getLocalSphereBounds(force?: boolean): Sphere
获取本地球面包围盒
Parameters
- force: boolean = false
  是否强制刷新
Returns Sphere
Inherited from Geometry.getLocalSphereBounds
- Defined in geometry/Geometry.ts:833

getRenderOption

getRenderOption(opt?: ShaderOptions): ShaderOptions
Parameters
- opt: ShaderOptions = {}
Returns ShaderOptions
Inherited from Geometry.getRenderOption
- Defined in geometry/Geometry.ts:1062

getShaderKey

getShaderKey(): string
Returns string
Inherited from Geometry.getShaderKey
- Defined in geometry/Geometry.ts:1096

getSize

getSize(): number
获取数据的内存大小，只处理顶点数据，单位为字节

Returns number
内存占用大小
Inherited from Geometry.getSize
- Defined in geometry/Geometry.ts:1106

getSphereBounds

getSphereBounds(matrix?: Matrix4): Sphere
获取球面包围盒
Parameters
- Optionalmatrix: Matrix4
Returns Sphere
Inherited from Geometry.getSphereBounds
- Defined in geometry/Geometry.ts:820

isSegments

isSegments(): boolean
Returns boolean
- Defined in geometry/BoxGeometry.ts:248

merge

merge(geometry: Geometry, matrix?: Matrix4): this
合并两个 geometry
Parameters
- geometry: Geometry
- Optionalmatrix: Matrix4
  合并的矩阵
Returns this
this
Inherited from Geometry.merge
- Defined in geometry/Geometry.ts:598

normalizePrimitiveTopology

normalizePrimitiveTopology(): boolean
Converts primitive modes that WebGPU cannot represent into explicit indexed lists.

Both rendering backends call this method before creating backend resources, so LINE_LOOP and TRIANGLE_FAN have one canonical CPU representation and identical draw semantics. Existing unsigned index width is preserved; non-indexed geometry receives the smallest unsigned index type that can address all of its vertices.

Returns boolean
Whether the geometry topology was converted.
Inherited from Geometry.normalizePrimitiveTopology
- Defined in geometry/Geometry.ts:445

raycast

raycast(ray: Ray, side: number, sort?: boolean): Vector3[] | null
raycast
Parameters
- ray: Ray
- side: number
- sort: boolean = true
  是否按距离排序
Returns Vector3[] | null
Inherited from Geometry.raycast
- Defined in geometry/Geometry.ts:1050

rotate

rotate(x?: number, y?: number, z?: number): this
旋转
Parameters
- x: number = 0
  旋转角度x
- y: number = 0
  旋转角度y
- z: number = 0
  旋转角度z
Returns this
this
Inherited from Geometry.rotate
- Defined in geometry/Geometry.ts:550

scale

scale(x?: number, y?: number, z?: number): this
缩放
Parameters
- x: number = 1
- y: number = 1
- z: number = 1
Returns this
this
Inherited from Geometry.scale
- Defined in geometry/Geometry.ts:539

setAllRectUV

setAllRectUV(uv: readonly UV[]): this
设置所有面的uv，不支持设置带有 widthSegments heightSegments depthSegments 的实例
Parameters
- uv: readonly UV[]
  uv数据，如 [
  [[0, 1], [1, 1], [1, 0], [0, 0]],
  [[0, 1], [1, 1], [1, 0], [0, 0]],
  [[0, 1], [1, 1], [1, 0], [0, 0]],
  [[0, 1], [1, 1], [1, 0], [0, 0]],
  [[0, 1], [1, 1], [1, 0], [0, 0]],
  [[0, 1], [1, 1], [1, 0], [0, 0]]
  ]
Returns this
- Defined in geometry/BoxGeometry.ts:317

setBackUV

setBackUV(uv: readonly UV[]): void
设置朝后面的uv，不支持设置带有 widthSegments heightSegments depthSegments 的实例
Parameters
- uv: readonly UV[]
  uv数据，如 [[0, 1], [1, 1], [1, 0], [0, 0]]
Returns void
- Defined in geometry/BoxGeometry.ts:277

setBottomUV

setBottomUV(uv: readonly UV[]): void
设置底部面的uv，不支持设置带有 widthSegments heightSegments depthSegments 的实例
Parameters
- uv: readonly UV[]
  uv数据，如 [[0, 1], [1, 1], [1, 0], [0, 0]]
Returns void
- Defined in geometry/BoxGeometry.ts:301

setFaceUV

setFaceUV(start: number, p1: Point2, p2: Point2, p3: Point2): void
设置三角形ABC的uv
Parameters
- start: number
  开始的顶点索引
- p1: Point2
  点A的uv，如 [0, 0]
- p2: Point2
  点B的uv
- p3: Point2
  点C的uv
Returns void
Inherited from Geometry.setFaceUV
- Defined in geometry/Geometry.ts:746

setFrontUV

setFrontUV(uv: readonly UV[]): void
设置朝前面的uv，不支持设置带有 widthSegments heightSegments depthSegments 的实例
Parameters
- uv: readonly UV[]
  uv数据，如 [[0, 1], [1, 1], [1, 0], [0, 0]]
Returns void
- Defined in geometry/BoxGeometry.ts:261

setLeftUV

setLeftUV(uv: readonly UV[]): void
设置左侧面的uv，不支持设置带有 widthSegments heightSegments depthSegments 的实例
Parameters
- uv: readonly UV[]
  uv数据，如 [[0, 1], [1, 1], [1, 0], [0, 0]]
Returns void
- Defined in geometry/BoxGeometry.ts:285

setRectUV

setRectUV(start: number, p1: Point2, p2: Point2, p3: Point2, p4: Point2): void
设置矩形ABCD的uv
Parameters
- start: number
  开始的顶点索引
- p1: Point2
  点A的uv，如 [0, 0]
- p2: Point2
  点B的uv
- p3: Point2
  点C的uv
- p4: Point2
  点D的uv
Returns void
Inherited from Geometry.setRectUV
- Defined in geometry/Geometry.ts:757

setRightUV

setRightUV(uv: readonly UV[]): void
设置右侧面的uv，不支持设置带有 widthSegments heightSegments depthSegments 的实例
Parameters
- uv: readonly UV[]
  uv数据，如 [[0, 1], [1, 1], [1, 0], [0, 0]]
Returns void
- Defined in geometry/BoxGeometry.ts:269

setTopUV

setTopUV(uv: readonly UV[]): void
设置顶部面的uv，不支持设置带有 widthSegments heightSegments depthSegments 的实例
Parameters
- uv: readonly UV[]
  uv数据，如 [[0, 1], [1, 1], [1, 0], [0, 0]]
Returns void
- Defined in geometry/BoxGeometry.ts:293

setVertexUV

setVertexUV(start: number, uvs: readonly Point2[]): void
设置顶点对应的uv坐标
Parameters
- start: number
  开始的顶点索引
- uvs: readonly Point2[]
  uv坐标数据，如 [[0, 0], [1, 0]]
Returns void
Inherited from Geometry.setVertexUV
- Defined in geometry/Geometry.ts:729

transformMat4

transformMat4(mat4: Matrix4): this
Transforms the geometry with a mat4.
Parameters
- mat4: Matrix4
Returns this
this
Inherited from Geometry.transformMat4
- Defined in geometry/Geometry.ts:560

translate

translate(x?: number, y?: number, z?: number): this
平移
Parameters
- x: number = 0
- y: number = 0
- z: number = 0
Returns this
this
Inherited from Geometry.translate
- Defined in geometry/Geometry.ts:528

Class BoxGeometry

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BoxGeometry

Properties

ReadonlyclassName

colors

currentIndicesCount

currentVerticesCount

depth

depthSegments

height

heightSegments

Readonlyid

indices

isBoxGeometry

ReadonlyisGeometry

ReadonlyisMorphGeometry

isStatic

mode

normalDecodeMat

positionDecodeMat

skinIndices

skinWeights

useAABBRaycast

userData

uv1DecodeMat

uvDecodeMat

uvs

uvs1

vertices

width

widthSegments

Accessors

isDirty

Returns boolean

Parameters

Returns void

normals

Returns GeometryData | null

Parameters

Returns void

revision

Returns number

tangents

Returns GeometryData | null

Parameters

Returns void

tangents1

Returns GeometryData | null

Parameters

Returns void

Methods

_aabbRaycast

Parameters

Returns Vector3[] | null

_raycast

Parameters

Returns Vector3[] | null

addFace

Parameters

Returns void

addIndices

Parameters

Returns void

addLine

Parameters

Returns void

addPoints

Parameters

Returns number

addRect

Parameters

`Readonly`className

`Readonly`id

`Readonly`isGeometry

`Readonly`isMorphGeometry