Class: CylinderGeometry

Cylinder geometry

Hierarchy

• GeometryBase

  ↳ CylinderGeometry

Constructors

• constructor

Properties

• instanceID
• name
• subGeometries
• morphTargetsRelative
• morphTargetDictionary
• skinNames
• bindPose
• blendShapeData
• vertexDim
• vertexCount
• radiusTop
• radiusBottom
• height
• radialSegments
• heightSegments
• openEnded
• thetaStart
• thetaLength

Accessors

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

Methods

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

Constructors

constructor

• new CylinderGeometry(radiusTop?, radiusBottom?, height?, radialSegments?, heightSegments?, openEnded?, thetaStart?, thetaLength?): CylinderGeometry

Parameters

Name	Type	Default value
radiusTop	number	1
radiusBottom	number	1
height	number	1
radialSegments	number	8
heightSegments	number	8
openEnded	boolean	false
thetaStart	number	0
thetaLength	number	undefined

Returns

CylinderGeometry

Overrides

GeometryBase.constructor

Defined in

src/shape/CylinderGeometry.ts:57

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

---

radiusTop

• radiusTop: number

The radius of the top of the cylinder

Defined in

src/shape/CylinderGeometry.ts:15

---

radiusBottom

• radiusBottom: number

The radius of the bottom of the cylinder

Defined in

src/shape/CylinderGeometry.ts:19

---

height

• height: number

The height of the cylinder

Defined in

src/shape/CylinderGeometry.ts:23

---

radialSegments

• radialSegments: number

Number of segments around the side of the cylinder

Defined in

src/shape/CylinderGeometry.ts:27

---

heightSegments

• heightSegments: number

The number of segments along the height of the cylindrical side

Defined in

src/shape/CylinderGeometry.ts:31

---

openEnded

• openEnded: boolean

Indicate whether the bottom surface of the cone is open or capped. The default value is false, which means that the bottom surface is capped by default.

Defined in

src/shape/CylinderGeometry.ts:35

---

thetaStart

• thetaStart: number

Starting angle of the first segment

Defined in

src/shape/CylinderGeometry.ts:39

---

thetaLength

• thetaLength: number

The center angle of the circular sector on the bottom of the cylinder, with a default value of 2 * PI, makes it a complete cylinder.

Defined in

src/shape/CylinderGeometry.ts:43

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