BufferAttribute

This class stores data for an attribute (such as vertex positions, face indices, normals, colors, UVs, and any custom attributes ) associated with a BufferGeometry, which allows for more efficient passing of data to the GPU. See that page for details and a usage example.<br /><br /> Data is stored as vectors of any length (defined by itemSize), and in general in the methods outlined below if passing in an index, this is automatically multiplied by the vector length.

Core Class

This class stores data for an attribute (such as vertex positions, face indices, normals, colors, UVs, and any custom attributes ) associated with a BufferGeometry, which allows for more efficient passing of data to the GPU. See that page for details and a usage example.

Data is stored as vectors of any length (defined by itemSize), and in general in the methods outlined below if passing in an index, this is automatically multiplied by the vector length.

Type Parameters

T extends TypedArray = TypedArray

Hierarchy

ElementEventDispatcher
- BufferAttribute
  - InstancedBufferAttribute

Constructors

constructor

new BufferAttribute<T extends TypedArray = TypedArray>(
array: T,
itemSize: number,
): BufferAttribute<T>
Type Parameters
- T extends TypedArray = TypedArray
Parameters
- array: T
- itemSize: number
Returns BufferAttribute<T>
Overrides ElementEventDispatcher.constructor

Properties

_array

_array: T

The geometry attribute data store as TypedArray.

itemSize

itemSize: number

If the buffer is storing a 3-component vector (such as a position, normal, or color), then this will count the number of such vectors stored.

normalized

normalized: boolean

If attribute data is normalized.

count

count: number

Stores the array's length divided by the itemSize.

If the buffer is storing a 3-component vector (such as a position, normal, or color), then this will count the number of such vectors stored.

dynamic

dynamic: boolean

The data of this buffer always need update.

Deprecated

will not take effect, update attribute.array if need to reupload

updateRange

updateRange: { offset: number; count: number }

Object containing:
offset:Integer - Default is 0. Position at which to start update.
count:Integer - Default is -1, which means don't use update ranges.

This can be used to only update some components of stored vectors (for example, just the component related to color).

Deprecated

will not take effect, update attribute.array instead

isBufferAttribute

isBufferAttribute: boolean

Used to check type of this or extended instance. This value should not be changed by user.

isDataDropped

isDataDropped: boolean

When the data is cleared from memory, this mark will be set true.

Deprecated

never updated, always false.

removeDataAfterUpload

removeDataAfterUpload: boolean

Remove the data after it is uploaded to GPU memory.

Deprecated

will not take effect

version

version: number

A version number, incremented every time the needsUpdate property is set to true.

onUpdateCallback

onUpdateCallback: () => void

A callback function for updating. It will be called after needsUpdate.

onUploadCallback

onUploadCallback: () => void

A callback function for uploading. It will be called after the data uploaded to WebGL.

`Readonly`userData

userData: Record<keyof any, any>

_uuid

_uuid: any

uuid

uuid: string

_listeners

_listeners: Map<Symbol, Listener<never>[]>

Accessors

array

get array(): T
The geometry attribute data store as TypedArray.

Returns T
set array(v: T): void
Parameters
- v: T
Returns void

needsUpdate

set needsUpdate(value: boolean): void
When this attribute is set to true, the version will be change.
Parameters
- value: boolean
Returns void

businessTag

get businessTag(): string
Returns string
Inherited from ElementEventDispatcher.businessTag
set businessTag(v: string): void
Parameters
- v: string
Returns void
Inherited from ElementEventDispatcher.businessTag

Methods

notifyContentChange

notifyContentChange(): void
Returns void

setArray

setArray(array: T): this
Change the data of array.
Parameters
- array: T
Returns this

setDynamic

setDynamic(value: boolean): this
Change the state of dynamic.
Parameters
- value: boolean
Returns this

copy

copy(source: BufferAttribute): this
Copy the data to this object from source.
Parameters
- source: BufferAttribute
  the data source.
Returns this

copyAt

copyAt(index1: number, attribute: BufferAttribute, index2: number): this
Copy the data at specified position. The given index is items' index, do not need to multiply with item' size.
Parameters
- index1: number
  the start position of this array.
- attribute: BufferAttribute
  the start position of this array.
- index2: number
  the start position of source array.
Returns this

copyArray

copyArray(array: TypedArray | number[]): this
Copy the data from given array to this array.
Parameters
- array: TypedArray | number[]
  the start position of this array.
Returns this

copyColorArray

copyColorArray(colors: Color[]): this
Copy the data from given array to this array.
Parameters
- colors: Color[]
  the start position of this array.
Returns this

copyVector2Array

copyVector2Array(vectors: Vector2[]): this
Copy the data which is type of Vector2 from given array to this array.
Parameters
- vectors: Vector2[]
  the start position of this array.
Returns this

copyVector3Array

copyVector3Array(vectors: Vector3[]): this
Copy the data which is type of Vector3 from given array to this array.
Parameters
- vectors: Vector3[]
  the start position of this array.
Returns this

copyVector4Array

copyVector4Array(vectors: Vector4[]): this
Copy the data which is type of Vector4 from given array to this array.
Parameters
- vectors: Vector4[]
  the start position of this array.
Returns this

set

set(value: ArrayLike<number>, offset?: number): this
Copy the data from given Array or typedArray.
Parameters
- value: ArrayLike<number>
  an Array or TypedArray from which to copy values.
- offset: number
  (optional) index of the array at which to start copying.
Returns this

getX

getX(index: number): number
Return the x component of all items.
Parameters
- index: number
Returns number

setX

setX(index: number, x: number): this
Set the x component of the vector at the given index.
Parameters
- index: number
- x: number
Returns this

getY

getY(index: number): number
Return the y component of all vectors.
Parameters
- index: number
Returns number

setY

setY(index: number, y: number): this
Set the y component of the vector at the given index.
Parameters
- index: number
- y: number
Returns this

getZ

getZ(index: number): number
Return the z component of all vectors.
Parameters
- index: number
Returns number

setZ

setZ(index: number, z: number): this
Set the z component of the vector at the given index.
Parameters
- index: number
- z: number
Returns this

getW

getW(index: number): number
Return the w component of all vectors.
Parameters
- index: number
Returns number

setW

setW(index: number, w: number): this
Set the w component of the vector at the given index.
Parameters
- index: number
- w: number
Returns this

setXY

setXY(index: number, x: number, y: number): this
Set the x and y component of the vector at the given index.
Parameters
- index: number
- x: number
- y: number
Returns this

setXYZ

setXYZ(index: number, x: number, y: number, z: number): this
Set the x , y and z component of the vector at the given index.
Parameters
- index: number
- x: number
- y: number
- z: number
Returns this

setXYZW

setXYZW(index: number, x: number, y: number, z: number, w: number): this
Set all component of the vector at the given index.
Parameters
- index: number
- x: number
- y: number
- z: number
- w: number
Returns this

getVector2

getVector2(index: number, out?: Vector2): Vector2
Return the vector2 at specific position.
Parameters
- index: number
- out: Vector2
Returns Vector2

clone

clone(): BufferAttribute<T>
Return a clone of this object.

Returns BufferAttribute<T>

destroy

destroy(): void
Release the memory which is occupied by this instance from CPU and GPU.

Returns void
Overrides ElementEventDispatcher.destroy

freeGPU

freeGPU(): void
Returns void

markBusinessTag

markBusinessTag(v: string): this
Parameters
- v: string
Returns this
Inherited from ElementEventDispatcher.markBusinessTag

isDestroyed

isDestroyed(): boolean
Returns boolean
Inherited from ElementEventDispatcher.isDestroyed

validate

validate(): void
Returns void
Inherited from ElementEventDispatcher.validate

destroyAllResourcesOwned

destroyAllResourcesOwned(): void
Returns void
Inherited from ElementEventDispatcher.destroyAllResourcesOwned

freeAllGpuResourceOwned

freeAllGpuResourceOwned(): void
Returns void
Inherited from ElementEventDispatcher.freeAllGpuResourceOwned

on

on<T>(_type: EventType<T>, _listener: Listener<T>): void
Adds a listener to an event type.
Type Parameters
- T
Parameters
- _type: EventType<T>
- _listener: Listener<T>
Returns void
Inherited from ElementEventDispatcher.on

once

once<T>(_type: EventType<T>, _listener: Listener<T>): void
Only active the listener one times and then off it| it.
Type Parameters
- T
Parameters
- _type: EventType<T>
- _listener: Listener<T>
Returns void
Inherited from ElementEventDispatcher.once

has

has<T>(_type: EventType<T>, _listener: Listener<T>): boolean
Checks if listener is added to an event type.
Type Parameters
- T
Parameters
- _type: EventType<T>
- _listener: Listener<T>
Returns boolean
Inherited from ElementEventDispatcher.has

off

off<T>(_type: EventType<T>, _listener: Listener<T>): void
Removes a listener from listening list.
Type Parameters
- T
Parameters
- _type: EventType<T>
- _listener: Listener<T>
Returns void
Inherited from ElementEventDispatcher.off

emit

emit(type: EventType<never>): void
Active the event and call the registered listener.
Parameters
- type: EventType<never>
Returns void
Inherited from ElementEventDispatcher.emit
emit<T>(type: EventType<T>, payload: T): void
Type Parameters
- T
Parameters
- type: EventType<T>
- payload: T
Returns void
Inherited from ElementEventDispatcher.emit

clearAllListeners

clearAllListeners(): void
Removes all listeners from listening list.

Returns void
Inherited from ElementEventDispatcher.clearAllListeners

Type Parameters

Hierarchy

Constructors

constructor

Type Parameters

Parameters

Returns BufferAttribute<T>

Properties

_array

itemSize

normalized

count

dynamic

Deprecated

updateRange

Deprecated

isBufferAttribute

isDataDropped

Deprecated

removeDataAfterUpload

Deprecated

version

onUpdateCallback

onUploadCallback

ReadonlyuserData

_uuid

uuid

_listeners

Accessors

array

Returns T

Parameters

Returns void

needsUpdate

Parameters

Returns void

businessTag

Returns string

Parameters

Returns void

Methods

notifyContentChange

Returns void

setArray

Parameters

Returns this

setDynamic

Parameters

Returns this

copy

Parameters

Returns this

copyAt

Parameters

Returns this

copyArray

Parameters

Returns this

copyColorArray

Parameters

Returns this

copyVector2Array

Parameters

Returns this

copyVector3Array

Parameters

Returns this

copyVector4Array

Parameters

Returns this

set

Parameters

Returns this

getX

Parameters

Returns number

setX

Parameters

Returns this

getY

`Readonly`userData