RibbonBuffer

Ribbon buffer. Draws a thin ribbon.

Hierarchy

MeshBuffer
- RibbonBuffer

Index

Constructors

constructor

Accessors

Constructors

constructor

new RibbonBuffer(data: RibbonBufferData, params?: Partial<BufferParameters>): RibbonBuffer

Overrides MeshBuffer.constructor
- Defined in src/buffer/ribbon-buffer.ts:36
Parameters
- data: RibbonBufferData
  
  attribute object
- Default value params: Partial<BufferParameters> = {}
  
  parameter object
Returns RibbonBuffer

Properties

dynamic

dynamic: boolean = true

fragmentShader

fragmentShader: string = "Mesh.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 = false

isSurface

isSurface: boolean = false

isText

isText: boolean = false

material

material: ShaderMaterial

parameterTypes

parameterTypes: object = BufferParameterTypes

Type declaration

matrix: object
background: object
- updateShader: boolean
clipCenter: object
- uniform: boolean
clipNear: object
- property: boolean
- updateShader: boolean
clipRadius: object
- uniform: boolean
- updateShader: boolean
depthWrite: object
- property: boolean
diffuse: object
- uniform: boolean
diffuseInterior: object
- updateShader: boolean
flatShaded: object
- updateShader: boolean
interiorColor: object
- uniform: boolean
interiorDarkening: object
- uniform: boolean
metalness: object
- uniform: boolean
opacity: object
- uniform: boolean
opaqueBack: object
- updateShader: boolean
roughness: object
- uniform: boolean
side: object
- property: boolean
- updateShader: boolean
useInteriorColor: object
- updateShader: boolean
wireframe: object
- updateVisibility: boolean

parameters

parameters: BufferParameters

Optional picking

picking: Picker

pickingGroup

pickingGroup: Group = new Group()

pickingMaterial

pickingMaterial: ShaderMaterial

pickingUniforms

pickingUniforms: Uniforms

uniforms

uniforms: Uniforms

vertexShader

vertexShader: string = "Ribbon.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

Inherited from Buffer.defaultParameters
- Defined in src/buffer/buffer.ts:120
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

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

Inherited from Buffer.dispose
- Defined in src/buffer/buffer.ts:847
Free buffer resources

Returns void

getDefines

getDefines(type?: BufferTypes): object

Inherited from Buffer.getDefines
- Defined in src/buffer/buffer.ts:525
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

makeIndex

makeIndex(): void

- Defined in src/buffer/ribbon-buffer.ts:200
Returns void

makeMaterial

makeMaterial(): void

Inherited from Buffer.makeMaterial
- Defined in src/buffer/buffer.ts:257
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?: Partial<RibbonBufferData>): void

Overrides Buffer.setAttributes
- Defined in src/buffer/ribbon-buffer.ts:74
Parameters
- Default value data: Partial<RibbonBufferData> = {}
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

Inherited from Buffer.setUniforms
- Defined in src/buffer/buffer.ts:748
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: RibbonBufferData

Default value params: Partial<BufferParameters> = {}

Returns RibbonBuffer

Properties

dynamic

fragmentShader

geometry

group

indexVersion

isImpostor

isLine

isPoint

isSurface

isText

material

parameterTypes

Type declaration

matrix: object

background: object

updateShader: boolean

clipCenter: object

uniform: boolean

clipNear: object

property: boolean

updateShader: boolean

clipRadius: object

uniform: boolean

updateShader: boolean

depthWrite: object

property: boolean

diffuse: object

uniform: boolean

diffuseInterior: object

updateShader: boolean

flatShaded: object

updateShader: boolean

interiorColor: object

uniform: boolean

interiorDarkening: object

uniform: boolean

metalness: object

uniform: boolean

opacity: object

uniform: boolean

opaqueBack: object

updateShader: boolean

roughness: object

uniform: boolean

side: object

property: boolean

updateShader: boolean

useInteriorColor: object

updateShader: boolean

wireframe: object

updateVisibility: boolean

parameters

Optional picking

pickingGroup

pickingMaterial

pickingUniforms

uniforms

vertexShader

visible

Optional wireframeGeometry

wireframeGroup

Optional wireframeIndex

wireframeIndexCount

wireframeIndexVersion

wireframeMaterial

Accessors

attributeSize