Class Geometry

constructor

• new Geometry(
      id: string,
      scene?: Scene,
      vertexData?: VertexData,
      updatable?: boolean,
      mesh?: Nullable<Mesh>,
      totalVertices?: Nullable<number>,
  ): Geometry

  Creates a new geometry

  Parameters

  • id: string

    defines the unique ID

  • Optionalscene: Scene

    defines the hosting scene

  • OptionalvertexData: VertexData

    defines the VertexData used to get geometry data

  • updatable: boolean = false

    defines if geometry must be updatable (false by default)

  • mesh: Nullable<Mesh> = null

    defines the mesh that will be associated with the geometry

  • totalVertices: Nullable<number> = null

    defines the total number of vertices (optional)

  Returns Geometry

delayLoadingFile

delayLoadState

id

onGeometryUpdated

uniqueId

useBoundingInfoFromGeometry

boundingBias

• get boundingBias(): Vector2

  Gets or sets the Bias Vector to apply on the bounding elements (box/sphere), the max extend is computed as v += v * bias.x + bias.y, the min is computed as v -= v * bias.x + bias.y

  Returns Vector2

• set boundingBias(value: Vector2): void

  Gets or sets the Bias Vector to apply on the bounding elements (box/sphere), the max extend is computed as v += v * bias.x + bias.y, the min is computed as v -= v * bias.x + bias.y

  Parameters

  • value: Vector2

  Returns void

doNotSerialize

• get doNotSerialize(): boolean

  Gets a value indicating that the geometry should not be serialized

  Returns boolean

extend

• get extend(): { maximum: Vector3; minimum: Vector3 }

  Gets the current extend of the geometry

  Returns { maximum: Vector3; minimum: Vector3 }

meshes

• get meshes(): Mesh[]

  Get the list of meshes using this geometry

  Returns Mesh[]

applyToMesh

• applyToMesh(mesh: Mesh): void

  Apply current geometry to a given mesh

  Parameters

  • mesh: Mesh

    defines the mesh to apply geometry to

  Returns void

clearCachedData

• clearCachedData(): void

  Release any memory retained by the cached data on the Geometry.

  Call this function to reduce memory footprint of the mesh. Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)

  Returns void

copy

• copy(id: string): Geometry

  Clone the current geometry into a new geometry

  Parameters

  • id: string

    defines the unique ID of the new geometry

  Returns Geometry

  a new geometry object

copyVerticesData

• copyVerticesData(
      kind: string,
      vertexData: { [kind: string]: Float32Array<ArrayBufferLike> },
  ): void

  Copies the requested vertex data kind into the given vertex data map. Float data is constructed if the map doesn't have the data.

  Parameters

  • kind: string

    defines the data kind (Position, normal, etc...)

  • vertexData: { [kind: string]: Float32Array<ArrayBufferLike> }

    defines the map that stores the resulting data

  Returns void

dispose

• dispose(): void

  Free all associated resources

  Returns void

getEngine

• getEngine(): AbstractEngine

  Gets the hosting engine

  Returns AbstractEngine

  the hosting Engine

getIndexBuffer

• getIndexBuffer(): Nullable<DataBuffer>

  Gets the index buffer

  Returns Nullable<DataBuffer>

  the index buffer

getIndices

• getIndices(
      copyWhenShared?: boolean,
      forceCopy?: boolean,
  ): Nullable<IndicesArray>

  Gets the index buffer array

  Parameters

  • OptionalcopyWhenShared: boolean

    defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes

  • OptionalforceCopy: boolean

    defines a boolean indicating that the returned array must be cloned upon returning it

  Returns Nullable<IndicesArray>

  the index buffer array

getScene

• getScene(): Scene

  Gets the hosting scene

  Returns Scene

  the hosting Scene

getTotalIndices

• getTotalIndices(): number

  Return the total number of indices

  Returns number

  the total number of indices

getTotalVertices

• getTotalVertices(): number

  Gets total number of vertices

  Returns number

  the total number of vertices

getVertexBuffer

• getVertexBuffer(kind: string): Nullable<VertexBuffer>

  Gets a specific vertex buffer

  Parameters

  • kind: string

    defines the data kind (Position, normal, etc...)

  Returns Nullable<VertexBuffer>

  a VertexBuffer

getVertexBuffers

• getVertexBuffers(): Nullable<{ [key: string]: VertexBuffer }>

  Returns all vertex buffers

  Returns Nullable<{ [key: string]: VertexBuffer }>

  an object holding all vertex buffers indexed by kind

getVerticesData

• getVerticesData(
      kind: string,
      copyWhenShared?: boolean,
      forceCopy?: boolean,
  ): Nullable<FloatArray>

  Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.

  Parameters

  • kind: string

    defines the data kind (Position, normal, etc...)

  • OptionalcopyWhenShared: boolean

    defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes

  • OptionalforceCopy: boolean

    defines a boolean indicating that the returned array must be cloned upon returning it

  Returns Nullable<FloatArray>

  a float array containing vertex data

getVerticesDataKinds

• getVerticesDataKinds(): string[]

  Gets a list of all attached data kinds (Position, normal, etc...)

  Returns string[]

  a list of string containing all kinds

isDisposed

• isDisposed(): boolean

  Gets a value indicating if the geometry is disposed

  Returns boolean

  true if the geometry was disposed

isReady

• isReady(): boolean

  Defines if the geometry is ready to use

  Returns boolean

  true if the geometry is ready to be used

isVertexBufferUpdatable

• isVertexBufferUpdatable(kind: string): boolean

  Returns a boolean defining if the vertex data for the requested kind is updatable

  Parameters

  • kind: string

    defines the data kind (Position, normal, etc...)

  Returns boolean

  true if the vertex buffer with the specified kind is updatable

isVerticesDataPresent

• isVerticesDataPresent(kind: string): boolean

  Gets a boolean indicating if specific vertex buffer is present

  Parameters

  • kind: string

    defines the data kind (Position, normal, etc...)

  Returns boolean

  true if data is present

load

• load(scene: Scene, onLoaded?: () => void): void

  Load the geometry if it was flagged as delay loaded

  Parameters

  • scene: Scene

    defines the hosting scene

  • OptionalonLoaded: () => void

    defines a callback called when the geometry is loaded

  Returns void

releaseForMesh

• releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void

  Release the associated resources for a specific mesh

  Parameters

  • mesh: Mesh

    defines the source mesh

  • OptionalshouldDispose: boolean

    defines if the geometry must be disposed if there is no more mesh pointing to it

  Returns void

removeVerticesData

• removeVerticesData(kind: string): void

  Removes a specific vertex data

  Parameters

  • kind: string

    defines the data kind (Position, normal, etc...)

  Returns void

serialize

• serialize(): any

  Serialize the current geometry info (and not the vertices data) into a JSON object

  Returns any

  a JSON representation of the current geometry data (without the vertices data)

serializeVerticeData

• serializeVerticeData(): any

  Serialize all vertices data into a JSON object

  Returns any

  a JSON representation of the current geometry data

setAllVerticesData

• setAllVerticesData(vertexData: VertexData, updatable?: boolean): void

  Affects all geometry data in one call

  Parameters

  • vertexData: VertexData

    defines the geometry data

  • Optionalupdatable: boolean

    defines if the geometry must be flagged as updatable (false as default)

  Returns void

setIndexBuffer

• setIndexBuffer(
      indexBuffer: DataBuffer,
      totalVertices: number,
      totalIndices: number,
      is32Bits?: Nullable<boolean>,
  ): void

  Sets the index buffer for this geometry.

  Parameters

  • indexBuffer: DataBuffer

    Defines the index buffer to use for this geometry

  • totalVertices: number

    Defines the total number of vertices used by the buffer

  • totalIndices: number

    Defines the total number of indices in the index buffer

  • is32Bits: Nullable<boolean> = null

    Defines if the indices are 32 bits. If null (default), the value is guessed from the number of vertices

  Returns void

setIndices

• setIndices(
      indices: IndicesArray,
      totalVertices?: Nullable<number>,
      updatable?: boolean,
      dontForceSubMeshRecreation?: boolean,
  ): void

  Creates a new index buffer

  Parameters

  • indices: IndicesArray

    defines the indices to store in the index buffer

  • totalVertices: Nullable<number> = null

    defines the total number of vertices (could be null)

  • updatable: boolean = false

    defines if the index buffer must be flagged as updatable (false by default)

  • dontForceSubMeshRecreation: boolean = false

    defines a boolean indicating that we don't want to force the recreation of sub-meshes if we don't have to (false by default)

  Returns void

setVerticesBuffer

• setVerticesBuffer(
      buffer: VertexBuffer,
      totalVertices?: Nullable<number>,
      disposeExistingBuffer?: boolean,
  ): void

  Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data

  Parameters

  • buffer: VertexBuffer

    defines the vertex buffer to use

  • totalVertices: Nullable<number> = null

    defines the total number of vertices for position kind (could be null)

  • disposeExistingBuffer: boolean = true

    disposes the existing buffer, if any (default: true)

  Returns void

setVerticesData

• setVerticesData(
      kind: string,
      data: FloatArray,
      updatable?: boolean,
      stride?: number,
  ): void

  Set specific vertex data

  Parameters

  • kind: string

    defines the data kind (Position, normal, etc...)

  • data: FloatArray

    defines the vertex data to use

  • updatable: boolean = false

    defines if the vertex must be flagged as updatable (false as default)

  • Optionalstride: number

    defines the stride to use (0 by default). This value is deduced from the kind value if not specified

  Returns void

toLeftHanded

• toLeftHanded(): void

  Invert the geometry to move from a right handed system to a left handed one.

  Returns void

updateIndices

• updateIndices(
      indices: IndicesArray,
      offset?: number,
      gpuMemoryOnly?: boolean,
  ): void

  Update index buffer

  Parameters

  • indices: IndicesArray

    defines the indices to store in the index buffer

  • Optionaloffset: number

    defines the offset in the target buffer where to store the data

  • gpuMemoryOnly: boolean = false

    defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)

  Returns void

updateVerticesData

• updateVerticesData(
      kind: string,
      data: FloatArray,
      updateExtends?: boolean,
  ): void

  Update a specific vertex buffer This function will create a new buffer if the current one is not updatable

  Parameters

  • kind: string

    defines the data kind (Position, normal, etc...)

  • data: FloatArray

    defines the data to use

  • updateExtends: boolean = false

    defines if the geometry extends must be recomputed (false by default)

  Returns void

updateVerticesDataDirectly

• updateVerticesDataDirectly(
      kind: string,
      data: DataArray,
      offset: number,
      useBytes?: boolean,
  ): void

  Update a specific vertex buffer This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array It will do nothing if the buffer is not updatable

  Parameters

  • kind: string

    defines the data kind (Position, normal, etc...)

  • data: DataArray

    defines the data to use

  • offset: number

    defines the offset in the target buffer where to store the data

  • useBytes: boolean = false

    set to true if the offset is in bytes

  Returns void

StaticCreateGeometryForMesh

• CreateGeometryForMesh(mesh: Mesh): Geometry

  Static function used to attach a new empty geometry to a mesh

  Parameters

  • mesh: Mesh

    defines the mesh to attach the geometry to

  Returns Geometry

  the new Geometry

StaticExtractFromMesh

• ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>

  Extracts a clone of a mesh geometry

  Parameters

  • mesh: Mesh

    defines the source mesh

  • id: string

    defines the unique ID of the new geometry object

  Returns Nullable<Geometry>

  the new geometry object

StaticParse

• Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>

  Create a new geometry from persisted data (Using .babylon file format)

  Parameters

  • parsedVertexData: any

    defines the persisted data

  • scene: Scene

    defines the hosting scene

  • rootUrl: string

    defines the root url to use to load assets (like delayed data)

  Returns Nullable<Geometry>

  the new geometry object

StaticRandomId

• RandomId(): string

  You should now use Tools.RandomId(), this method is still here for legacy reasons. Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523 Be aware Math.random() could cause collisions, but: "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"

  Returns string

  a string containing a new GUID