Class: PlaneGeometry

Plane geometry

Hierarchy

• GeometryBase

  ↳ PlaneGeometry

Constructors

• constructor

Properties

• instanceID
• name
• subGeometries
• morphTargetsRelative
• morphTargetDictionary
• skinNames
• bindPose
• blendShapeData
• vertexDim
• vertexCount
• width
• height
• segmentW
• segmentH
• up

Accessors

• indicesBuffer
• vertexBuffer
• vertexAttributes
• vertexAttributeMap
• geometryType
• bounds

Methods

• addSubGeometry
• generate
• setIndices
• setAttribute
• getAttribute
• hasAttribute
• genWireframe
• compute
• computeNormals
• isPrimitive
• destroy

Constructors

constructor

• new PlaneGeometry(width, height, segmentW?, segmentH?, up?): PlaneGeometry

Parameters

Name	Type	Default value	Description
width	number	undefined	Width of the plane
height	number	undefined	Height of the plane
segmentW	number	1	Number of width segments of a plane
segmentH	number	1	Number of height segments of a plane
up	Vector3	Vector3.Y_AXIS	Define the normal vector of a plane

Returns

PlaneGeometry

Overrides

GeometryBase.constructor

Defined in

src/shape/PlaneGeometry.ts:41

Properties

instanceID

• instanceID: string

Inherited from

GeometryBase.instanceID

Defined in

src/core/geometry/GeometryBase.ts:39

---

name

• name: string

Inherited from

GeometryBase.name

Defined in

src/core/geometry/GeometryBase.ts:40

---

subGeometries

• subGeometries: SubGeometry[] = []

Inherited from

GeometryBase.subGeometries

Defined in

src/core/geometry/GeometryBase.ts:41

---

morphTargetsRelative

• morphTargetsRelative: boolean

Inherited from

GeometryBase.morphTargetsRelative

Defined in

src/core/geometry/GeometryBase.ts:42

---

morphTargetDictionary

• morphTargetDictionary: Object

Index signature

▪ [blenderName: string]: number

Inherited from

GeometryBase.morphTargetDictionary

Defined in

src/core/geometry/GeometryBase.ts:43

---

skinNames

• skinNames: string[]

Inherited from

GeometryBase.skinNames

Defined in

src/core/geometry/GeometryBase.ts:44

---

bindPose

• bindPose: Matrix4[]

Inherited from

GeometryBase.bindPose

Defined in

src/core/geometry/GeometryBase.ts:45

---

blendShapeData

• blendShapeData: BlendShapeData

Inherited from

GeometryBase.blendShapeData

Defined in

src/core/geometry/GeometryBase.ts:46

---

vertexDim

• vertexDim: number

Inherited from

GeometryBase.vertexDim

Defined in

src/core/geometry/GeometryBase.ts:47

---

vertexCount

• vertexCount: number = 0

Inherited from

GeometryBase.vertexCount

Defined in

src/core/geometry/GeometryBase.ts:48

---

width

• width: number

Width of the plane

Defined in

src/shape/PlaneGeometry.ts:14

---

height

• height: number

Height of the plane

Defined in

src/shape/PlaneGeometry.ts:18

---

segmentW

• segmentW: number

Number of width segments of a plane

Defined in

src/shape/PlaneGeometry.ts:22

---

segmentH

• segmentH: number

Number of height segments of a plane

Defined in

src/shape/PlaneGeometry.ts:26

---

up

• up: Vector3

Define the normal vector of a plane

Defined in

src/shape/PlaneGeometry.ts:30

Accessors

indicesBuffer

• get indicesBuffer(): GeometryIndicesBuffer

Returns

GeometryIndicesBuffer

Inherited from

GeometryBase.indicesBuffer

Defined in

src/core/geometry/GeometryBase.ts:69

---

vertexBuffer

• get vertexBuffer(): GeometryVertexBuffer

Returns

GeometryVertexBuffer

Inherited from

GeometryBase.vertexBuffer

Defined in

src/core/geometry/GeometryBase.ts:73

---

vertexAttributes

• get vertexAttributes(): string[]

Returns

string[]

Inherited from

GeometryBase.vertexAttributes

Defined in

src/core/geometry/GeometryBase.ts:77

---

vertexAttributeMap

• get vertexAttributeMap(): Map<string, VertexAttributeData>

Returns

Map<string, VertexAttributeData>

Inherited from

GeometryBase.vertexAttributeMap

Defined in

src/core/geometry/GeometryBase.ts:81

---

geometryType

• get geometryType(): GeometryVertexType

Returns

GeometryVertexType

Inherited from

GeometryBase.geometryType

Defined in

src/core/geometry/GeometryBase.ts:85

• set geometryType(value): void

Parameters

Name	Type
value	GeometryVertexType

Returns

void

Inherited from

GeometryBase.geometryType

Defined in

src/core/geometry/GeometryBase.ts:88

---

bounds

• get bounds(): BoundingBox

Returns

BoundingBox

Inherited from

GeometryBase.bounds

Defined in

src/core/geometry/GeometryBase.ts:92

• set bounds(value): void

Parameters

Name	Type
value	BoundingBox

Returns

void

Inherited from

GeometryBase.bounds

Defined in

src/core/geometry/GeometryBase.ts:135

Methods

addSubGeometry

▸ addSubGeometry(...lodLevels): SubGeometry

add subGeometry from lod level

Parameters

Name	Type
...lodLevels	LODDescriptor[]

Returns

SubGeometry

See

LODDescriptor

Inherited from

GeometryBase.addSubGeometry

Defined in

src/core/geometry/GeometryBase.ts:144

---

generate

▸ generate(shaderReflection): void

create geometry by shaderReflection

Parameters

Name	Type	Description
shaderReflection	ShaderReflection	ShaderReflection

Returns

void

Inherited from

GeometryBase.generate

Defined in

src/core/geometry/GeometryBase.ts:155

---

setIndices

▸ setIndices(data): void

Parameters

Name	Type
data	ArrayBufferData

Returns

void

Inherited from

GeometryBase.setIndices

Defined in

src/core/geometry/GeometryBase.ts:165

---

setAttribute

▸ setAttribute(attribute, data): void

Parameters

Name	Type
attribute	string
data	ArrayBufferData

Returns

void

Inherited from

GeometryBase.setAttribute

Defined in

src/core/geometry/GeometryBase.ts:177

---

getAttribute

▸ getAttribute(attribute): VertexAttributeData

Parameters

Name	Type
attribute	string

Returns

VertexAttributeData

Inherited from

GeometryBase.getAttribute

Defined in

src/core/geometry/GeometryBase.ts:190

---

hasAttribute

▸ hasAttribute(attribute): boolean

Parameters

Name	Type
attribute	string

Returns

boolean

Inherited from

GeometryBase.hasAttribute

Defined in

src/core/geometry/GeometryBase.ts:194

---

genWireframe

▸ genWireframe(): Vector3[]

Returns

Vector3[]

Inherited from

GeometryBase.genWireframe

Defined in

src/core/geometry/GeometryBase.ts:198

---

compute

▸ compute(): void

Returns

void

Inherited from

GeometryBase.compute

Defined in

src/core/geometry/GeometryBase.ts:251

---

computeNormals

▸ computeNormals(): this

Returns

this

Inherited from

GeometryBase.computeNormals

Defined in

src/core/geometry/GeometryBase.ts:270

---

isPrimitive

▸ isPrimitive(): boolean

Returns

boolean

Inherited from

GeometryBase.isPrimitive

Defined in

src/core/geometry/GeometryBase.ts:312

---

destroy

▸ destroy(force?): void

Parameters

Name	Type
force?	boolean

Returns

void

Inherited from

GeometryBase.destroy

Defined in

src/core/geometry/GeometryBase.ts:316