Class G3dMesh

G3D is a simple, efficient, generic binary format for storing and transmitting geometry. The G3D format is designed to be used either as a serialization format or as an in-memory data structure. A G3d with specific attributes according to the VIM format specification. See https://github.com/vimaec/vim#vim-geometry-attributes for the vim specification. See https://github.com/vimaec/g3d for the g3d specification.

Hierarchy

G3dMesh

Constructors

constructor

new G3dMesh(instanceNodes: Int32Array, instanceTransforms: Float32Array, instanceFlags: Uint16Array, meshOpaqueSubmeshCount: number, submeshIndexOffsets: Int32Array, submeshVertexOffsets: Int32Array, submeshMaterials: Int32Array, indices: Int32Array | Uint32Array, positions: Float32Array, materialColors: Float32Array): G3dMesh
Parameters
- instanceNodes: Int32Array
- instanceTransforms: Float32Array
- instanceFlags: Uint16Array
- meshOpaqueSubmeshCount: number
- submeshIndexOffsets: Int32Array
- submeshVertexOffsets: Int32Array
- submeshMaterials: Int32Array
- indices: Int32Array | Uint32Array
- positions: Float32Array
- materialColors: Float32Array
Returns G3dMesh
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:50

Properties

DEFAULT_COLOR

DEFAULT_COLOR: Float32Array

Opaque white

getInstanceCount

getInstanceCount: (() => number)

Type declaration

- (): number
- Returns number

getMaterialCount

getMaterialCount: (() => number)

Type declaration

- (): number
- Returns number

indices

indices: Uint32Array

instanceFlags

instanceFlags: Uint16Array

instanceNodes

instanceNodes: Int32Array

instanceTransforms

instanceTransforms: Float32Array

materialColors

materialColors: Float32Array

meshOpaqueSubmeshCount

meshOpaqueSubmeshCount: number

opaqueCount

opaqueCount: number

positions

positions: Float32Array

rawG3d

rawG3d: AbstractG3d

submeshIndexOffset

submeshIndexOffset: Int32Array

submeshMaterial

submeshMaterial: Int32Array

submeshVertexOffset

submeshVertexOffset: Int32Array

`Static` COLOR_SIZE

COLOR_SIZE: number

`Static` MATRIX_SIZE

MATRIX_SIZE: number

`Static` POSITION_SIZE

POSITION_SIZE: number

Methods

getHasTransparency

getHasTransparency(): boolean
Returns boolean
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:67

getIndexCount

getIndexCount(section?: MeshSection): number
Parameters
- Optional section: MeshSection
Returns number
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:66

getIndexEnd

getIndexEnd(section?: MeshSection): number
Parameters
- Optional section: MeshSection
Returns number
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:65

getIndexStart

getIndexStart(section?: MeshSection): number
Parameters
- Optional section: MeshSection
Returns number
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:64

getInstanceHasFlag

getInstanceHasFlag(instance: number, flag: number): boolean
Parameters
- instance: number
- flag: number
Returns boolean
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:93

getInstanceMatrix

getInstanceMatrix(instance: number): Float32Array
Returns an 16 number array representation of the matrix for given instance
Parameters
- instance: number
  
  g3d instance index
Returns Float32Array
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:98

getMaterialAlpha

getMaterialAlpha(material: number): number
Parameters
- material: number
Returns number
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:105

getMaterialColor

getMaterialColor(material: number): Float32Array
Returns color of given material as a 4-number array (RGBA)
Parameters
- material: number
  
  g3d material index
Returns Float32Array
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:104

getSubmeshAlpha

getSubmeshAlpha(submesh: number): number
Returns color of given submesh as a 4-number array (RGBA)
Parameters
- submesh: number
  
  g3d submesh index
Returns number
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:86

getSubmeshColor

getSubmeshColor(submesh: number): Float32Array
Returns color of given submesh as a 4-number array (RGBA)
Parameters
- submesh: number
  
  g3d submesh index
Returns Float32Array
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:81

getSubmeshCount

getSubmeshCount(section: MeshSection): number
Parameters
- section: MeshSection
Returns number
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:70

getSubmeshEnd

getSubmeshEnd(section: MeshSection): number
Parameters
- section: MeshSection
Returns number
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:69

getSubmeshIndexCount

getSubmeshIndexCount(submesh: number): number
Parameters
- submesh: number
Returns number
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:73

getSubmeshIndexEnd

getSubmeshIndexEnd(submesh: number): number
Parameters
- submesh: number
Returns number
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:72

getSubmeshIndexStart

getSubmeshIndexStart(submesh: number): number
Parameters
- submesh: number
Returns number
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:71

getSubmeshIsTransparent

getSubmeshIsTransparent(submesh: number): boolean
Returns true if submesh is transparent.
Parameters
- submesh: number
  
  g3d submesh index
Returns boolean
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:91

getSubmeshStart

getSubmeshStart(section: MeshSection): number
Parameters
- section: MeshSection
Returns number
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:68

getSubmeshVertexCount

getSubmeshVertexCount(submesh: number): number
Parameters
- submesh: number
Returns number
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:76

getSubmeshVertexEnd

getSubmeshVertexEnd(submesh: number): number
Parameters
- submesh: number
Returns number
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:75

getSubmeshVertexStart

getSubmeshVertexStart(submesh: number): number
Parameters
- submesh: number
Returns number
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:74

getVertexCount

getVertexCount(section?: MeshSection): number
Parameters
- Optional section: MeshSection
Returns number
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:63

getVertexEnd

getVertexEnd(section?: MeshSection): number
Parameters
- Optional section: MeshSection
Returns number
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:62

getVertexStart

getVertexStart(section?: MeshSection): number
Parameters
- Optional section: MeshSection
Returns number
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:61

insert

insert(g3d: G3dMesh, instanceStart: number, submesStart: number, indexStart: number, vertexStart: number, materialStart: number): void
Parameters
- g3d: G3dMesh
- instanceStart: number
- submesStart: number
- indexStart: number
- vertexStart: number
- materialStart: number
Returns void
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:56

toG3d

toG3d(): G3d
Returns G3d
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:55

`Static` createFromAbstract

createFromAbstract(g3d: AbstractG3d): G3dMesh
Parameters
- g3d: AbstractG3d
Returns G3dMesh
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:51

`Static` createFromBfast

createFromBfast(bfast: BFast): Promise<G3dMesh>
Parameters
- bfast: BFast
Returns Promise<G3dMesh>
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:54

`Static` createFromBuffer

createFromBuffer(buffer: ArrayBuffer): Promise<G3dMesh>
Parameters
- buffer: ArrayBuffer
Returns Promise<G3dMesh>
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:53

`Static` createFromPath

createFromPath(path: string): Promise<G3dMesh>
Parameters
- path: string
Returns Promise<G3dMesh>
- Defined in node_modules/vim-format/dist/g3dMesh.d.ts:52

Class G3dMesh

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

instanceNodes: Int32Array

instanceTransforms: Float32Array

instanceFlags: Uint16Array

meshOpaqueSubmeshCount: number

submeshIndexOffsets: Int32Array

submeshVertexOffsets: Int32Array

submeshMaterials: Int32Array

indices: Int32Array | Uint32Array

positions: Float32Array

materialColors: Float32Array

Returns G3dMesh

Properties

DEFAULT_COLOR

getInstanceCount

Type declaration

Returns number

getMaterialCount

Type declaration

Returns number

indices

instanceFlags

instanceNodes

instanceTransforms

materialColors

meshOpaqueSubmeshCount

opaqueCount

positions

rawG3d

submeshIndexOffset

submeshMaterial

submeshVertexOffset

Static COLOR_SIZE

Static MATRIX_SIZE

Static POSITION_SIZE

Methods

getHasTransparency

Returns boolean

getIndexCount

Parameters

Optional section: MeshSection

Returns number

getIndexEnd

Parameters

Optional section: MeshSection

Returns number

getIndexStart

Parameters

Optional section: MeshSection

Returns number

getInstanceHasFlag

Parameters

instance: number

flag: number

Returns boolean

getInstanceMatrix

Parameters

instance: number

Returns Float32Array

getMaterialAlpha

Parameters

material: number

Returns number

getMaterialColor

Parameters

material: number

Returns Float32Array

getSubmeshAlpha

Parameters

submesh: number

Returns number

getSubmeshColor

`Static` COLOR_SIZE

`Static` MATRIX_SIZE

`Static` POSITION_SIZE

`Optional` section: MeshSection

`Optional` section: MeshSection

`Optional` section: MeshSection

`Optional` section: MeshSection

`Optional` section: MeshSection

`Optional` section: MeshSection

`Static` createFromAbstract