Class G3d

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

  • G3d

Constructors

constructor

Properties

DEFAULT_COLOR getIndexCount getInstanceCount getMaterialCount getMeshCount getVertexCount indices instanceFlags instanceMeshes instanceNodes instanceTransforms materialColors meshInstances meshOpaqueCount meshSubmeshes meshVertexOffsets positions rawG3d submeshIndexOffset submeshMaterial COLOR_SIZE MATRIX_SIZE POSITION_SIZE

Methods

append filter getInstanceHasFlag getInstanceMatrix getInstanceMesh getMaterialAlpha getMaterialColor getMeshHasTransparency getMeshIndexCount getMeshIndexEnd getMeshIndexStart getMeshSubmeshCount getMeshSubmeshEnd getMeshSubmeshStart getMeshVertexCount getMeshVertexEnd getMeshVertexStart getSubmeshAlpha getSubmeshColor getSubmeshCount getSubmeshIndexCount getSubmeshIndexEnd getSubmeshIndexStart getSubmeshIsTransparent remapInstances slice validate createFromAbstract createFromBfast createFromPath

Constructors

constructor

  • Parameters

    • instanceMeshes: Int32Array
    • instanceFlags: Uint16Array
    • instanceTransforms: Float32Array
    • instanceNodes: Int32Array
    • meshSubmeshes: Int32Array
    • submeshIndexOffsets: Int32Array
    • submeshMaterials: Int32Array
    • indices: Int32Array | Uint32Array
    • positions: Float32Array
    • materialColors: Float32Array

    Returns G3d

Properties

DEFAULT_COLOR

DEFAULT_COLOR: Float32Array

Opaque white

getIndexCount

getIndexCount: (() => number)

Type declaration

    • (): number

    • Returns number

getInstanceCount

getInstanceCount: (() => number)

Type declaration

    • (): number

    • Returns number

getMaterialCount

getMaterialCount: (() => number)

Type declaration

    • (): number

    • Returns number

getMeshCount

getMeshCount: (() => number)

Type declaration

    • (): number

    • Returns number

getVertexCount

getVertexCount: (() => number)

Type declaration

    • (): number

    • Returns number

indices

indices: Uint32Array

instanceFlags

instanceFlags: Uint16Array

instanceMeshes

instanceMeshes: Int32Array

instanceNodes

instanceNodes: Int32Array

instanceTransforms

instanceTransforms: Float32Array

materialColors

materialColors: Float32Array

meshInstances

meshInstances: number[][]

meshOpaqueCount

meshOpaqueCount: Int32Array

meshSubmeshes

meshSubmeshes: Int32Array

meshVertexOffsets

meshVertexOffsets: Int32Array

positions

positions: Float32Array

rawG3d

rawG3d: AbstractG3d

submeshIndexOffset

submeshIndexOffset: Int32Array

submeshMaterial

submeshMaterial: Int32Array

Static COLOR_SIZE

COLOR_SIZE: number

Static MATRIX_SIZE

MATRIX_SIZE: number

Static POSITION_SIZE

POSITION_SIZE: number

Methods

append

  • Parameters

    Returns G3d

filter

  • Parameters

    • instances: number[]

    Returns G3d

getInstanceHasFlag

  • Parameters

    • instance: number
    • flag: number

    Returns boolean

getInstanceMatrix

  • Returns an 16 number array representation of the matrix for given instance

    Parameters

    • instance: number

      g3d instance index

    Returns Float32Array

getInstanceMesh

  • Returns mesh index of given instance

    Parameters

    • instance: number

      g3d instance index

    Returns number

getMaterialAlpha

  • Parameters

    • material: number

    Returns number

getMaterialColor

  • Returns color of given material as a 4-number array (RGBA)

    Parameters

    • material: number

      g3d material index

    Returns Float32Array

getMeshHasTransparency

  • Parameters

    • mesh: number

    Returns boolean

getMeshIndexCount

  • Parameters

    Returns number

getMeshIndexEnd

  • Parameters

    Returns number

getMeshIndexStart

  • Parameters

    Returns number

getMeshSubmeshCount

  • Parameters

    Returns number

getMeshSubmeshEnd

  • Parameters

    Returns number

getMeshSubmeshStart

  • Parameters

    Returns number

getMeshVertexCount

  • Parameters

    • mesh: number

    Returns number

getMeshVertexEnd

  • Parameters

    • mesh: number

    Returns number

getMeshVertexStart

  • Parameters

    • mesh: number

    Returns number

getSubmeshAlpha

  • Returns color of given submesh as a 4-number array (RGBA)

    Parameters

    • submesh: number

      g3d submesh index

    Returns number

getSubmeshColor

  • Returns color of given submesh as a 4-number array (RGBA)

    Parameters

    • submesh: number

      g3d submesh index

    Returns Float32Array

getSubmeshCount

  • Returns the total number of mesh in the g3d

    Returns number

getSubmeshIndexCount

  • Parameters

    • submesh: number

    Returns number

getSubmeshIndexEnd

  • Parameters

    • submesh: number

    Returns number

getSubmeshIndexStart

  • Parameters

    • submesh: number

    Returns number

getSubmeshIsTransparent

  • Returns true if submesh is transparent.

    Parameters

    • submesh: number

      g3d submesh index

    Returns boolean

remapInstances

  • Given VIM instance indices returns the corresponding G3d indices

    Parameters

    • instances: number[]

    Returns number[]

slice

  • Parameters

    • instance: number

    Returns G3d

validate

  • Returns void

Static createFromAbstract

  • Parameters

    • g3d: AbstractG3d

    Returns G3d

Static createFromBfast

  • Parameters

    Returns Promise<G3d>

Static createFromPath

  • Parameters

    • path: string

    Returns Promise<G3d>

Settings

Member Visibility

Theme

Generated using TypeDoc