Class CylinderGeometry

This is a superefficent class for geometries because it saves all data in buffers. It reduces memory costs and cpu cycles. But it is not as easy to work with because of all the necessary buffer calculations. It is mainly interesting when working with static objects.

see https://github.com/mrdoob/three.js/blob/master/src/core/BufferGeometry.js|src/core/BufferGeometry.js

Hierarchy

BufferGeometry
- CylinderGeometry
  - ConeGeometry

Constructors

constructor

new CylinderGeometry(radiusTop?: number, radiusBottom?: number, height?: number, radialSegments?: number, heightSegments?: number, openEnded?: boolean, thetaStart?: number, thetaLength?: number): CylinderGeometry
Parameters
- Optional radiusTop: number
  
  — Radius of the cylinder at the top.
- Optional radiusBottom: number
  
  — Radius of the cylinder at the bottom.
- Optional height: number
  
  — Height of the cylinder.
- Optional radialSegments: number
  
  — Number of segmented faces around the circumference of the cylinder.
- Optional heightSegments: number
  
  — Number of rows of faces along the height of the cylinder.
- Optional openEnded: boolean
  
  A Boolean indicating whether or not to cap the ends of the cylinder.
- Optional thetaStart: number
- Optional thetaLength: number
Returns CylinderGeometry
Overrides BufferGeometry.constructor
- Defined in node_modules/@types/three/src/geometries/CylinderGeometry.d.ts:14

Properties

attributes

attributes: {
[name: string]: BufferAttribute | InterleavedBufferAttribute;
}

Default

Type declaration

[name: string]: BufferAttribute | InterleavedBufferAttribute

boundingBox

boundingBox: Box3

Default

null

boundingSphere

boundingSphere: Sphere

Default

null

drawRange

drawRange: {
count: number;
start: number;
}

Default

Type declaration

count: number
start: number

drawcalls

drawcalls: any

Deprecated

Use .groups instead.

groups

groups: {
    count: number;
    materialIndex?: number;
    start: number;
}[]

Default

[]

id

id: number

Unique number of this buffergeometry instance

index

index: BufferAttribute

Default

null

`Readonly` isBufferGeometry

isBufferGeometry: true

morphAttributes

morphAttributes: {
[name: string]: (BufferAttribute | InterleavedBufferAttribute)[];
}

Default

Type declaration

[name: string]: (BufferAttribute | InterleavedBufferAttribute)[]

morphTargetsRelative

morphTargetsRelative: boolean

Default

false

name

name: string

Default

offsets

offsets: any

Deprecated

Use .groups instead.

parameters

parameters: {
    height: number;
    heightSegments: number;
    openEnded: boolean;
    radialSegments: number;
    radiusBottom: number;
    radiusTop: number;
    thetaLength: number;
    thetaStart: number;
}

Type declaration

height: number
heightSegments: number
openEnded: boolean
radialSegments: number
radiusBottom: number
radiusTop: number
thetaLength: number
thetaStart: number

type

type: string

Default

'CylinderGeometry'

userData

userData: {
[key: string]: any;
}

Default

Type declaration

[key: string]: any

uuid

uuid: string

Methods

addAttribute

addAttribute(name: string, attribute: BufferAttribute | InterleavedBufferAttribute): BufferGeometry
Deprecated
Use .setAttribute() instead.
Parameters
- name: string
- attribute: BufferAttribute | InterleavedBufferAttribute
Returns BufferGeometry
Inherited from BufferGeometry.addAttribute
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:189
addAttribute(name: any, array: any, itemSize: any): any
Parameters
- name: any
- array: any
- itemSize: any
Returns any
Inherited from BufferGeometry.addAttribute
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:190

addDrawCall

addDrawCall(start: any, count: any, indexOffset?: any): void
Deprecated
Use .addGroup() instead.
Parameters
- start: any
- count: any
- Optional indexOffset: any
Returns void
Inherited from BufferGeometry.addDrawCall
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:179

addEventListener

addEventListener<T>(type: T, listener: EventListener<Event, T, CylinderGeometry>): void
Adds a listener to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Event, T, CylinderGeometry>
  
  The function that gets called when the event is fired.
Returns void
Inherited from BufferGeometry.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:30

addGroup

addGroup(start: number, count: number, materialIndex?: number): void
Parameters
- start: number
- count: number
- Optional materialIndex: number
Returns void
Inherited from BufferGeometry.addGroup
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:102

addIndex

addIndex(index: any): void
Deprecated
Use .setIndex() instead.
Parameters
- index: any
Returns void
Inherited from BufferGeometry.addIndex
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:174

applyMatrix4

applyMatrix4(matrix: Matrix4): BufferGeometry
Bakes matrix transform directly into vertex coordinates.
Parameters
- matrix: Matrix4
Returns BufferGeometry
Inherited from BufferGeometry.applyMatrix4
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:110

applyQuaternion

applyQuaternion(q: Quaternion): BufferGeometry
Parameters
- q: Quaternion
Returns BufferGeometry
Inherited from BufferGeometry.applyQuaternion
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:111

center

center(): BufferGeometry
Returns BufferGeometry
Inherited from BufferGeometry.center
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:120

clearDrawCalls

clearDrawCalls(): void
Deprecated
Use .clearGroups() instead.

Returns void
Inherited from BufferGeometry.clearDrawCalls
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:184

clearGroups

clearGroups(): void
Returns void
Inherited from BufferGeometry.clearGroups
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:103

clone

clone(): BufferGeometry
Returns BufferGeometry
Inherited from BufferGeometry.clone
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:152

computeBoundingBox

computeBoundingBox(): void
Computes bounding box of the geometry, updating Geometry.boundingBox attribute. Bounding boxes aren't computed by default. They need to be explicitly computed, otherwise they are null.

Returns void
Inherited from BufferGeometry.computeBoundingBox
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:128

computeBoundingSphere

computeBoundingSphere(): void
Computes bounding sphere of the geometry, updating Geometry.boundingSphere attribute. Bounding spheres aren't' computed by default. They need to be explicitly computed, otherwise they are null.

Returns void
Inherited from BufferGeometry.computeBoundingSphere
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:134

computeTangents

computeTangents(): void
Computes and adds tangent attribute to this geometry.

Returns void
Inherited from BufferGeometry.computeTangents
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:139

computeVertexNormals

computeVertexNormals(): void
Computes vertex normals by averaging face normals.

Returns void
Inherited from BufferGeometry.computeVertexNormals
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:144

copy

copy(source: BufferGeometry): CylinderGeometry
Parameters
- source: BufferGeometry
Returns CylinderGeometry
Inherited from BufferGeometry.copy
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:153

deleteAttribute

deleteAttribute(name: BuiltinShaderAttributeName | string & {}): BufferGeometry
Parameters
- name: BuiltinShaderAttributeName | string & {}
Returns BufferGeometry
Inherited from BufferGeometry.deleteAttribute
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:99

dispatchEvent

dispatchEvent(event: Event): void
Fire an event type.
Parameters
- event: Event
Returns void
Inherited from BufferGeometry.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:50

dispose

dispose(): void
Disposes the object from memory. You need to call this when you want the bufferGeometry removed while the application is running.

Returns void
Inherited from BufferGeometry.dispose
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:159

getAttribute

getAttribute(name: BuiltinShaderAttributeName | string & {}): BufferAttribute | InterleavedBufferAttribute
Parameters
- name: BuiltinShaderAttributeName | string & {}
Returns BufferAttribute | InterleavedBufferAttribute
Inherited from BufferGeometry.getAttribute
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:98

getIndex

getIndex(): BufferAttribute
Returns BufferAttribute
Inherited from BufferGeometry.getIndex
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:91

hasAttribute

hasAttribute(name: BuiltinShaderAttributeName | string & {}): boolean
Parameters
- name: BuiltinShaderAttributeName | string & {}
Returns boolean
Inherited from BufferGeometry.hasAttribute
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:100

hasEventListener

hasEventListener<T>(type: T, listener: EventListener<Event, T, CylinderGeometry>): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Event, T, CylinderGeometry>
  
  The function that gets called when the event is fired.
Returns boolean
Inherited from BufferGeometry.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:37

lookAt

lookAt(v: THREE.Vector3): void
Parameters
- v: THREE.Vector3
Returns void
Inherited from BufferGeometry.lookAt
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:118

merge

merge(geometry: BufferGeometry, offset?: number): BufferGeometry
Parameters
- geometry: BufferGeometry
- Optional offset: number
Returns BufferGeometry
Inherited from BufferGeometry.merge
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:146

normalizeNormals

normalizeNormals(): void
Returns void
Inherited from BufferGeometry.normalizeNormals
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:147

removeAttribute

removeAttribute(name: string): BufferGeometry
Deprecated
Use .deleteAttribute() instead.
Parameters
- name: string
Returns BufferGeometry
Inherited from BufferGeometry.removeAttribute
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:195

removeEventListener

removeEventListener<T>(type: T, listener: EventListener<Event, T, CylinderGeometry>): void
Removes a listener from an event type.
Type Parameters
- T extends string
Parameters
- type: T
  
  The type of the listener that gets removed.
- listener: EventListener<Event, T, CylinderGeometry>
  
  The listener function that gets removed.
Returns void
Inherited from BufferGeometry.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:44

rotateX

rotateX(angle: number): BufferGeometry
Parameters
- angle: number
Returns BufferGeometry
Inherited from BufferGeometry.rotateX
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:113

rotateY

rotateY(angle: number): BufferGeometry
Parameters
- angle: number
Returns BufferGeometry
Inherited from BufferGeometry.rotateY
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:114

rotateZ

rotateZ(angle: number): BufferGeometry
Parameters
- angle: number
Returns BufferGeometry
Inherited from BufferGeometry.rotateZ
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:115

scale

scale(x: number, y: number, z: number): BufferGeometry
Parameters
- x: number
- y: number
- z: number
Returns BufferGeometry
Inherited from BufferGeometry.scale
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:117

setAttribute

setAttribute(name: BuiltinShaderAttributeName | string & {}, attribute: BufferAttribute | InterleavedBufferAttribute): BufferGeometry
Parameters
- name: BuiltinShaderAttributeName | string & {}
- attribute: BufferAttribute | InterleavedBufferAttribute
Returns BufferGeometry
Inherited from BufferGeometry.setAttribute
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:94

setDrawRange

setDrawRange(start: number, count: number): void
Parameters
- start: number
- count: number
Returns void
Inherited from BufferGeometry.setDrawRange
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:105

setFromPoints

setFromPoints(points: THREE.Vector3[] | THREE.Vector2[]): BufferGeometry
Parameters
- points: THREE.Vector3[] | THREE.Vector2[]
Returns BufferGeometry
Inherited from BufferGeometry.setFromPoints
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:122

setIndex

setIndex(index: number[] | BufferAttribute): BufferGeometry
Parameters
- index: number[] | BufferAttribute
Returns BufferGeometry
Inherited from BufferGeometry.setIndex
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:92

toJSON

toJSON(): any
Returns any
Inherited from BufferGeometry.toJSON
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:151

toNonIndexed

toNonIndexed(): BufferGeometry
Returns BufferGeometry
Inherited from BufferGeometry.toNonIndexed
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:149

translate

translate(x: number, y: number, z: number): BufferGeometry
Parameters
- x: number
- y: number
- z: number
Returns BufferGeometry
Inherited from BufferGeometry.translate
- Defined in node_modules/@types/three/src/core/BufferGeometry.d.ts:116

`Static` fromJSON

fromJSON(data: any): CylinderGeometry
Parameters
- data: any
Returns CylinderGeometry
- Defined in node_modules/@types/three/src/geometries/CylinderGeometry.d.ts:41

Class CylinderGeometry

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional radiusTop: number

Optional radiusBottom: number

Optional height: number

Optional radialSegments: number

Optional heightSegments: number

Optional openEnded: boolean

Optional thetaStart: number

Optional thetaLength: number

Returns CylinderGeometry

Properties

attributes

Default

Type declaration

[name: string]: BufferAttribute | InterleavedBufferAttribute

boundingBox

Default

boundingSphere

Default

drawRange

Default

Type declaration

count: number

start: number

drawcalls

Deprecated

groups

Default

id

index

Default

Readonly isBufferGeometry

morphAttributes

Default

Type declaration

[name: string]: (BufferAttribute | InterleavedBufferAttribute)[]

morphTargetsRelative

Default

name

Default

offsets

Deprecated

parameters

Type declaration

height: number

heightSegments: number

openEnded: boolean

radialSegments: number

radiusBottom: number

radiusTop: number

thetaLength: number

thetaStart: number

type

Default

userData

Default

Type declaration

[key: string]: any

uuid

Methods

addAttribute

Deprecated

Parameters

name: string

attribute: BufferAttribute | InterleavedBufferAttribute

Returns BufferGeometry

Parameters

name: any

array: any

itemSize: any

Returns any

addDrawCall

`Optional` radiusTop: number

`Optional` radiusBottom: number

`Optional` height: number

`Optional` radialSegments: number

`Optional` heightSegments: number

`Optional` openEnded: boolean

`Optional` thetaStart: number

`Optional` thetaLength: number

`Readonly` isBufferGeometry

`Optional` indexOffset: any

`Optional` materialIndex: number