PointBuffer

Point buffer. Draws points. Optionally textured.

example: var pointBuffer = new PointBuffer( { position: new Float32Array( [ 0, 0, 0 ] ), color: new Float32Array( [ 1, 0, 0 ] ) } );

Hierarchy

Buffer
- PointBuffer

Index

Constructors

constructor

Accessors

Constructors

constructor

new PointBuffer(data: BufferData, params?: Partial<PointBufferParameters>): PointBuffer

Overrides Buffer.constructor
- Defined in src/buffer/point-buffer.ts:102
Parameters
- data: BufferData
  
  attribute object
- Default value params: Partial<PointBufferParameters> = {}
  
  parameter object
Returns PointBuffer

Properties

dynamic

dynamic: boolean = true

fragmentShader

fragmentShader: string = "Point.frag"

geometry

geometry: BufferGeometry = new BufferGeometry()

group

group: Group = new Group()

indexVersion

indexVersion: number = 0

isImpostor

isImpostor: boolean = false

isLine

isLine: boolean = false

isPoint

isPoint: boolean = true

isSurface

isSurface: boolean = false

isText

isText: boolean = false

material

material: ShaderMaterial

parameterTypes

parameterTypes: object & object = PointBufferParameterTypes

parameters

parameters: PointBufferParameters

Optional picking

picking: Picker

pickingGroup

pickingGroup: Group = new Group()

pickingMaterial

pickingMaterial: ShaderMaterial

pickingUniforms

pickingUniforms: Uniforms

tex

tex: DataTexture

uniforms

uniforms: Uniforms

vertexShader

vertexShader: string = "Point.vert"

visible

visible: boolean = true

Optional wireframeGeometry

wireframeGeometry: BufferGeometry

wireframeGroup

wireframeGroup: Group = new Group()

Optional wireframeIndex

wireframeIndex: Uint32Array | Uint16Array

wireframeIndexCount

wireframeIndexCount: number = 0

wireframeIndexVersion

wireframeIndexVersion: number = -1

wireframeMaterial

wireframeMaterial: ShaderMaterial

Accessors

attributeSize

get attributeSize(): number

Inherited from Buffer.attributeSize
- Defined in src/buffer/buffer.ts:236
Returns number

defaultParameters

get defaultParameters(): object & object

Overrides Buffer.defaultParameters
- Defined in src/buffer/point-buffer.ts:95
Returns object & object

matrix

get matrix(): Matrix4
set matrix(m: Matrix4): void

Inherited from Buffer.matrix
- Defined in src/buffer/buffer.ts:224
Returns Matrix4
Inherited from Buffer.matrix
- Defined in src/buffer/buffer.ts:221
Parameters
- m: Matrix4
Returns void

pickable

get pickable(): boolean

Inherited from Buffer.pickable
- Defined in src/buffer/buffer.ts:240
Returns boolean

size

get size(): number

Inherited from Buffer.size
- Defined in src/buffer/buffer.ts:232
Returns number

transparent

get transparent(): boolean

Inherited from Buffer.transparent
- Defined in src/buffer/buffer.ts:228
Returns boolean

Methods

_getMesh

_getMesh(materialName: BufferMaterials): LineSegments | Points | Mesh

Inherited from Buffer._getMesh
- Defined in src/buffer/buffer.ts:467
Parameters
- materialName: BufferMaterials
Returns LineSegments | Points | Mesh

addAttributes

addAttributes(attributes: object): void

Inherited from Buffer.addAttributes
- Defined in src/buffer/buffer.ts:573
Parameters
- attributes: object
  - [k: string]: _BufferAttribute
Returns void

addUniforms

addUniforms(uniforms: Uniforms): void

Inherited from Buffer.addUniforms
- Defined in src/buffer/buffer.ts:563
Parameters
- uniforms: Uniforms
Returns void

dispose

dispose(): void

Overrides Buffer.dispose
- Defined in src/buffer/point-buffer.ts:172
Returns void

getDefines

getDefines(type?: BufferTypes): object

Overrides Buffer.getDefines
- Defined in src/buffer/point-buffer.ts:145
Parameters
- Optional type: BufferTypes
Returns object

getFragmentShader

getFragmentShader(type?: BufferTypes): string

Inherited from Buffer.getFragmentShader
- Defined in src/buffer/buffer.ts:521
Parameters
- Optional type: BufferTypes
Returns string

getMesh

getMesh(): LineSegments | Points | Mesh

Inherited from Buffer.getMesh
- Defined in src/buffer/buffer.ts:489
Returns LineSegments | Points | Mesh

getParameters

getParameters(): object

Inherited from Buffer.getParameters
- Defined in src/buffer/buffer.ts:559
Returns object
- background: boolean
- clipCenter: Vector3
- clipNear: number
- clipRadius: number
- depthWrite: boolean
- diffuse: number
- diffuseInterior: boolean
- disablePicking: boolean
- flatShaded: boolean
- forceTransparent: boolean
- interiorColor: number
- interiorDarkening: number
- matrix: Matrix4
- metalness: number
- opacity: number
- opaqueBack: boolean
- roughness: number
- side: "double" | "front" | "back"
- sortParticles: boolean
- useInteriorColor: boolean
- wireframe: boolean

getPickingMesh

getPickingMesh(): LineSegments | Points | Mesh

Inherited from Buffer.getPickingMesh
- Defined in src/buffer/buffer.ts:509
Returns LineSegments | Points | Mesh

getRenderOrder

getRenderOrder(): number

Inherited from Buffer.getRenderOrder
- Defined in src/buffer/buffer.ts:451
Returns number

getShader

getShader(name: string, type?: BufferTypes): string

Inherited from Buffer.getShader
- Defined in src/buffer/buffer.ts:513
Parameters
- name: string
- Optional type: BufferTypes
Returns string

getVertexShader

getVertexShader(type?: BufferTypes): string

Inherited from Buffer.getVertexShader
- Defined in src/buffer/buffer.ts:517
Parameters
- Optional type: BufferTypes
Returns string

getWireframeMesh

getWireframeMesh(): LineSegments

Inherited from Buffer.getWireframeMesh
- Defined in src/buffer/buffer.ts:493
Returns LineSegments

initIndex

initIndex(index: Uint32Array | Uint16Array): void

Inherited from Buffer.initIndex
- Defined in src/buffer/buffer.ts:250
Parameters
- index: Uint32Array | Uint16Array
Returns void

makeMaterial

makeMaterial(): void

Overrides Buffer.makeMaterial
- Defined in src/buffer/point-buffer.ts:121
Returns void

makeTexture

makeTexture(): void

- Defined in src/buffer/point-buffer.ts:140
Returns void

makeWireframeGeometry

makeWireframeGeometry(): void

Inherited from Buffer.makeWireframeGeometry
- Defined in src/buffer/buffer.ts:315
Returns void

makeWireframeIndex

makeWireframeIndex(): void

Inherited from Buffer.makeWireframeIndex
- Defined in src/buffer/buffer.ts:333
Returns void

setAttributes

setAttributes(data: any): void

Inherited from Buffer.setAttributes
- Defined in src/buffer/buffer.ts:703
Sets buffer attributes

example

var buffer = new Buffer(); buffer.setAttributes({ attrName: attrData });

Parameters
- data: any
  
  An object where the keys are the attribute names and the values are the attribute data.
Returns void

setMatrix

setMatrix(m: Matrix4): void

Inherited from Buffer.setMatrix
- Defined in src/buffer/buffer.ts:244
Parameters
- m: Matrix4
Returns void

setParameters

setParameters(params: Partial<BufferParameters>): void

Inherited from Buffer.setParameters
- Defined in src/buffer/buffer.ts:630
Set buffer parameters

Parameters
- params: Partial<BufferParameters>
  
  buffer parameters object
Returns void

setProperties

setProperties(data: any): void

Inherited from Buffer.setProperties
- Defined in src/buffer/buffer.ts:792
Parameters
- data: any
Returns void

setUniforms

setUniforms(data: any): void

Overrides Buffer.setUniforms
- Defined in src/buffer/point-buffer.ts:163
Parameters
- data: any
Returns void

setVisibility

setVisibility(value: boolean): void

Inherited from Buffer.setVisibility
- Defined in src/buffer/buffer.ts:825
Set buffer visibility

Parameters
- value: boolean
  
  visibility value
Returns void

updateRenderOrder

updateRenderOrder(): void

Inherited from Buffer.updateRenderOrder
- Defined in src/buffer/buffer.ts:595
Returns void

updateShader

updateShader(): void

Inherited from Buffer.updateShader
- Defined in src/buffer/buffer.ts:607
Returns void

updateWireframeIndex

updateWireframeIndex(): void

Inherited from Buffer.updateWireframeIndex
- Defined in src/buffer/buffer.ts:431
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

data: BufferData

Default value params: Partial<PointBufferParameters> = {}

Returns PointBuffer

Properties

dynamic

fragmentShader

geometry

group

indexVersion

isImpostor

isLine

isPoint

isSurface

isText

material

parameterTypes

parameters

Optional picking

pickingGroup

pickingMaterial

pickingUniforms

tex

uniforms

vertexShader

visible

Optional wireframeGeometry

wireframeGroup

Optional wireframeIndex

wireframeIndexCount

wireframeIndexVersion

wireframeMaterial

Accessors

attributeSize

Returns number

defaultParameters

Returns object & object

matrix

Returns Matrix4

Parameters

m: Matrix4

Returns void

pickable

Returns boolean

size

Returns number

transparent

Returns boolean

Methods

_getMesh

Parameters

materialName: BufferMaterials

Returns LineSegments | Points | Mesh

addAttributes

Parameters

attributes: object

[k: string]: _BufferAttribute

Returns void

addUniforms

Parameters

uniforms: Uniforms

Returns void

dispose

Returns void

getDefines

Parameters

Optional type: BufferTypes

Returns object

getFragmentShader

Parameters

Optional type: BufferTypes

Returns string