Class SubMesh

constructor

• new SubMesh(
      materialIndex: number,
      verticesStart: number,
      verticesCount: number,
      indexStart: number,
      indexCount: number,
      mesh: AbstractMesh,
      renderingMesh?: Mesh,
      createBoundingBox?: boolean,
      addToMesh?: boolean,
  ): SubMesh

  Creates a new submesh

  Parameters

  • materialIndex: number

    defines the material index to use

  • verticesStart: number

    defines vertex index start

  • verticesCount: number

    defines vertices count

  • indexStart: number

    defines index start

  • indexCount: number

    defines indices count

  • mesh: AbstractMesh

    defines the parent mesh

  • OptionalrenderingMesh: Mesh

    defines an optional rendering mesh

  • createBoundingBox: boolean = true

    defines if bounding box should be created for this submesh

  • addToMesh: boolean = true

    defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)

  Returns SubMesh

indexCount

indexStart

materialIndex

verticesCount

verticesStart

effect

• get effect(): Nullable<Effect>

  Gets associated (main) effect (possibly the effect override if defined)

  Returns Nullable<Effect>

IsGlobal

• get IsGlobal(): boolean
  Ignorenaming

  Returns true if this submesh covers the entire parent mesh

  Returns boolean

materialDefines

• get materialDefines(): Nullable<MaterialDefines>

  Gets material defines used by the effect associated to the sub mesh

  Returns Nullable<MaterialDefines>

• set materialDefines(defines: Nullable<MaterialDefines>): void

  Sets material defines used by the effect associated to the sub mesh

  Parameters

  • defines: Nullable<MaterialDefines>

  Returns void

canIntersects

• canIntersects(ray: Ray): boolean

  Checks if the submesh intersects with a ray

  Parameters

  • ray: Ray

    defines the ray to test

  Returns boolean

  true is the passed ray intersects the submesh bounding box

clone

• clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh

  Creates a new submesh from the passed mesh

  Parameters

  • newMesh: AbstractMesh

    defines the new hosting mesh

  • OptionalnewRenderingMesh: Mesh

    defines an optional rendering mesh

  Returns SubMesh

  the new submesh

dispose

• dispose(immediate?: boolean): void

  Release associated resources

  Parameters

  • immediate: boolean = false

    If true, the effect will be disposed immediately (false by default)

  Returns void

getBoundingInfo

• getBoundingInfo(): BoundingInfo

  Returns the submesh BoundingInfo object

  Returns BoundingInfo

  current bounding info (or mesh's one if the submesh is global)

getClassName

• getClassName(): string

  Gets the class name

  Returns string

  the string "SubMesh".

getEffectiveMesh

• getEffectiveMesh(): AbstractMesh

  Returns the effective mesh of the submesh

  Returns AbstractMesh

  the effective mesh (could be different from parent mesh)

getMaterial

• getMaterial(getDefaultMaterial?: boolean, passId?: number): Nullable<Material>

  Returns the submesh material

  Parameters

  • getDefaultMaterial: boolean = true

    Defines whether or not to get the default material if nothing has been defined.

  • OptionalpassId: number

    Optional render pass id to get the material with. If undefined, the engine's current render pass id is used.

  Returns Nullable<Material>

  null or the current material

getMesh

• getMesh(): AbstractMesh

  Returns the mesh of the current submesh

  Returns AbstractMesh

  the parent mesh

getRenderingMesh

• getRenderingMesh(): Mesh

  Returns the rendering mesh of the submesh

  Returns Mesh

  the rendering mesh (could be different from parent mesh)

getReplacementMesh

• getReplacementMesh(): Nullable<AbstractMesh>

  Returns the replacement mesh of the submesh

  Returns Nullable<AbstractMesh>

  the replacement mesh (could be different from parent mesh)

intersects

• intersects(
      ray: Ray,
      positions: Vector3[],
      indices: IndicesArray,
      fastCheck?: boolean,
      trianglePredicate?: TrianglePickingPredicate,
  ): Nullable<IntersectionInfo>

  Intersects current submesh with a ray

  Parameters

  • ray: Ray

    defines the ray to test

  • positions: Vector3[]

    defines mesh's positions array

  • indices: IndicesArray

    defines mesh's indices array

  • OptionalfastCheck: boolean

    defines if the first intersection will be used (and not the closest)

  • OptionaltrianglePredicate: TrianglePickingPredicate

    defines an optional predicate used to select faces when a mesh intersection is detected

  Returns Nullable<IntersectionInfo>

  intersection info or null if no intersection

isCompletelyInFrustum

• isCompletelyInFrustum(frustumPlanes: Plane[]): boolean

  True is the submesh bounding box is completely inside the frustum defined by the passed array of planes

  Parameters

  • frustumPlanes: Plane[]

    defines the frustum planes

  Returns boolean

  true if the submesh is inside the frustum

isInFrustum

• isInFrustum(frustumPlanes: Plane[]): boolean

  True is the submesh bounding box intersects the frustum defined by the passed array of planes.

  Parameters

  • frustumPlanes: Plane[]

    defines the frustum planes

  Returns boolean

  true if the submesh is intersecting with the frustum

projectToRef

• projectToRef(
      vector: Vector3,
      positions: Vector3[],
      indices: IndicesArray,
      ref: Vector3,
  ): number

  Projects a point on this submesh and stores the result in "ref"

  Parameters

  • vector: Vector3

    point to project

  • positions: Vector3[]

    defines mesh's positions array

  • indices: IndicesArray

    defines mesh's indices array

  • ref: Vector3

    vector that will store the result

  Returns number

  distance from the point and the submesh, or -1 if the mesh rendering mode doesn't support projections

refreshBoundingInfo

• refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh

  Sets a new updated BoundingInfo object to the submesh

  Parameters

  • data: Nullable<FloatArray> = null

    defines an optional position array to use to determine the bounding info

  Returns SubMesh

  the SubMesh

render

• render(enableAlphaMode: boolean): SubMesh

  Renders the submesh

  Parameters

  • enableAlphaMode: boolean

    defines if alpha needs to be used

  Returns SubMesh

  the submesh

resetDrawCache

• resetDrawCache(passId?: number, immediate?: boolean): void

  Resets the draw wrappers cache

  Parameters

  • OptionalpassId: number

    If provided, releases only the draw wrapper corresponding to this render pass id

  • immediate: boolean = false

    If true, the draw wrapper will dispose the effect immediately (false by default)

  Returns void

setBoundingInfo

• setBoundingInfo(boundingInfo: BoundingInfo): SubMesh

  Sets the submesh BoundingInfo

  Parameters

  • boundingInfo: BoundingInfo

    defines the new bounding info to use

  Returns SubMesh

  the SubMesh

setEffect

• setEffect(
      effect: Nullable<Effect>,
      defines?: Nullable<string | MaterialDefines>,
      materialContext?: IMaterialContext,
      resetContext?: boolean,
  ): void

  Sets associated effect (effect used to render this submesh)

  Parameters

  • effect: Nullable<Effect>

    defines the effect to associate with

  • defines: Nullable<string | MaterialDefines> = null

    defines the set of defines used to compile this effect

  • OptionalmaterialContext: IMaterialContext

    material context associated to the effect

  • resetContext: boolean = true

    true to reset the draw context

  Returns void

updateBoundingInfo

• updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh

  Updates the submesh BoundingInfo

  Parameters

  • world: DeepImmutable<Matrix>

    defines the world matrix to use to update the bounding info

  Returns SubMesh

  the submesh

StaticAddToMesh

• AddToMesh(
      materialIndex: number,
      verticesStart: number,
      verticesCount: number,
      indexStart: number,
      indexCount: number,
      mesh: AbstractMesh,
      renderingMesh?: Mesh,
      createBoundingBox?: boolean,
  ): SubMesh

  Add a new submesh to a mesh

  Parameters

  • materialIndex: number

    defines the material index to use

  • verticesStart: number

    defines vertex index start

  • verticesCount: number

    defines vertices count

  • indexStart: number

    defines index start

  • indexCount: number

    defines indices count

  • mesh: AbstractMesh

    defines the parent mesh

  • OptionalrenderingMesh: Mesh

    defines an optional rendering mesh

  • createBoundingBox: boolean = true

    defines if bounding box should be created for this submesh

  Returns SubMesh

  the new submesh

StaticCreateFromIndices

• CreateFromIndices(
      materialIndex: number,
      startIndex: number,
      indexCount: number,
      mesh: AbstractMesh,
      renderingMesh?: Mesh,
      createBoundingBox?: boolean,
  ): SubMesh

  Creates a new submesh from indices data

  Parameters

  • materialIndex: number

    the index of the main mesh material

  • startIndex: number

    the index where to start the copy in the mesh indices array

  • indexCount: number

    the number of indices to copy then from the startIndex

  • mesh: AbstractMesh

    the main mesh to create the submesh from

  • OptionalrenderingMesh: Mesh

    the optional rendering mesh

  • createBoundingBox: boolean = true

    defines if bounding box should be created for this submesh

  Returns SubMesh

  a new submesh