Materials

Materials used by Twinfinity for rendering of IFC products and other objects.

Index

Constructors

• constructor

Properties

• reservedGpuPickClearColor

Accessors

• availableObjectCount
• isBackfaceCullingEnabled
• maxObjectCount
• objectCount
• state

Methods

• add
• clear
• copyColorTo
• createGpuTextureObject
• deleteGpuTextureObject
• get
• getBabylonMeshCustomDepthMaterial
• getBimProductAndMeshById
• getColorComponent
• getDitherDepthDiscardMode
• getGpuPickingMaterial
• getIFCMeshCustomDepthMaterial
• getTransparencyMode
• gpuPickRgbToInt32
• intToGpuPickRgbaInPlace
• renderPropertiesFor
• setColor
• setDitherDepthDiscardMode
• setDitherMode
• setHighlightColor
• setTransparencyMode
• updateMaterials

Constructors

publicconstructor

• new Materials(_isBackfaceCullingEnabled?: boolean): Materials

• Materials constructor.

  ---

  Parameters

  • _isBackfaceCullingEnabled: boolean = true

  Returns Materials

Properties

publicreadonlyreservedGpuPickClearColor

reservedGpuPickClearColor: Color4 = ...

Color used to as scene.clearColor when doing gpu picking.

Accessors

publicavailableObjectCount

• get availableObjectCount(): number

• Number of objects (IFC products or TextureObject) that can still be added to this instance

  ---

  Returns number

publicisBackfaceCullingEnabled

• get isBackfaceCullingEnabled(): boolean
• set isBackfaceCullingEnabled(value: boolean): void

• Returns boolean

• Parameters

  • value: boolean

  Returns void

publicmaxObjectCount

• get maxObjectCount(): number

• Maximum number of Ifc products and TextureObject instances material can hold.

  ---

  Returns number

publicobjectCount

• get objectCount(): number

• Number of objects (IFC products or TextureObject) this instance currently holds. Cannot be higher than maxObjectCount.

  ---

  Returns number

publicstate

• get state(): Record<string, never>

• Changed whenever colors or properties on objects, managed by this Materials instance, change. Useful when performing checks (for exemple during rendering) to determine if something has changed between one frame and another. Let your code keep a reference to state. Whenever you need to check whether something has changed just compare your local reference with state. If they differ then colors or properties of objects have changed since the last frame. Dont forget to update the local reference afterwards.

  ---

  Returns Record<string, never>

Methods

publicadd

• add(ifcFiles: IBimIfcLoaderElement[]): void

• Parameters

  • ifcFiles: IBimIfcLoaderElement[]

  Returns void

publicclear

• clear(): void

• Returns void

publiccopyColorTo

• copyColorTo(mesh: BimProductMesh, dst: Writeable<ArrayLike<number>>, dstOffset?: number): void

• Parameters

  • mesh: BimProductMesh

  • dst: Writeable<ArrayLike<number>>

  • dstOffset: number = 0

  Returns void

publiccreateGpuTextureObject

• createGpuTextureObject(): undefined | TextureObject

• Create a TextureObject.

  ---

  Returns undefined | TextureObject

  A valid TextureObject or undefined if the maximum number of gpu texture objects have been reached.

publicdeleteGpuTextureObject

• deleteGpuTextureObject(textureObject: number | TextureObject): boolean

• Deletes a TextureObject.

  ---

  Parameters

  • textureObject: number | TextureObject

    Object to delete.

  Returns boolean

  True if deleted, otherwise false.

publicget

• get(isTransparent: boolean, scene: Scene): Material

• Parameters

  • isTransparent: boolean

  • scene: Scene

  Returns Material

publicgetBabylonMeshCustomDepthMaterial

• getBabylonMeshCustomDepthMaterial(scene: Scene, storeNonLinearDepth: boolean): BabylonMeshDepthMaterial

• Creates a custom depth material that is used for Babylon meshes for two reasons:

  1. It correctly excludes the invisible fragments from the IFC meshes
  2. It uses a camera with a nearplane that is further away, to increase precision and thereforce reduce z fighting for effects that use depth textures written to with this material

  ---

  Parameters

  • scene: Scene

    The scene for which the depth material should be created

  • storeNonLinearDepth: boolean

    Whether the custom depth material should write the depth linearly or logarithmically

  Returns BabylonMeshDepthMaterial

  The custom depth material, which was created for the scene

publicgetBimProductAndMeshById

• getBimProductAndMeshById(id: number): undefined | BimProductMesh

• Parameters

  • id: number

  Returns undefined | BimProductMesh

publicgetColorComponent

• getColorComponent(mesh: BimProductMesh, colorComponent: RgbaComponent): number

• Parameters

  • mesh: BimProductMesh

  • colorComponent: RgbaComponent

  Returns number

publicgetDitherDepthDiscardMode

• getDitherDepthDiscardMode(): boolean

• Returns boolean

publicgetGpuPickingMaterial

• getGpuPickingMaterial(sceneOrMesh: Scene | AbstractMesh): Material

• Parameters

  • sceneOrMesh: Scene | AbstractMesh

  Returns Material

publicgetIFCMeshCustomDepthMaterial

• getIFCMeshCustomDepthMaterial(scene: Scene, storeNonLinearDepth: boolean): IfcMeshDepthMaterial

• Creates a custom depth material that is used for IFC meshes instead of Babylons normal depth material for two reasons:

  1. It correctly excludes the invisible fragments from the IFC meshes
  2. It uses a camera with a nearplane that is further away, to increase precision and thereforce reduce z fighting for effects that use depth textures written to with this material

  ---

  Parameters

  • scene: Scene

    The scene for which the depth material should be created

  • storeNonLinearDepth: boolean

    Wheter the custom depth material should write the depth linearly or logarithmic

  Returns IfcMeshDepthMaterial

  The custom depth material, which was created for the scene

publicgetTransparencyMode

• getTransparencyMode(): TransparencyMode

• Returns TransparencyMode

publicgpuPickRgbToInt32

• gpuPickRgbToInt32(pixels: ArrayLike<number>, offset: number): number

• Parameters

  • pixels: ArrayLike<number>

  • offset: number

  Returns number

publicintToGpuPickRgbaInPlace

• intToGpuPickRgbaInPlace<T>(pixelValue: number, alpha: number, dst: T): T

• Type parameters

  • T: Writeable<ArrayLike<number>>

  Parameters

  • pixelValue: number

  • alpha: number

  • dst: T

  Returns T

publicrenderPropertiesFor

• renderPropertiesFor(mesh: BimProductMesh): Uint32Bits

• Sets various on/off properties pertaining to rendering of a BimProductMesh instance. A mask representing the bits that you want to flip, Legend: idw: Depth write, single bit, represents a bool, wheter the object is written into the postprocess depth buffer or not v: Visibility, 1 bit wheter the object is visible or not h: Highlight, 2 bits for a total of 3 different highlight colors, or no highlight if all bits are turned off p1: Plane1, if plane1 can clip the product p2: Plane2, if plane2 can clip the product p3: Plane3, if plane3 can clip the product s: Shininess, 4 bits, represents a number 0: unused bit [0|0|0|0 0|0|0|0] [0|0|0|0 0|p3|p2|p1] [0|0|0|0 s|s|s|s] [0|0|0|0 h|h|v|idw]

  ---

  Parameters

  • mesh: BimProductMesh

    Mesh to read/write properties for.

  Returns Uint32Bits

  A Unit32Bits instance. Use to manipulate the bits in the property mask for the BimProductAndMesh instance.

publicsetColor

• setColor(mesh: BimProductMesh, color: ArrayLike<number>): boolean

• Parameters

  • mesh: BimProductMesh

  • color: ArrayLike<number>

  Returns boolean

publicsetDitherDepthDiscardMode

• setDitherDepthDiscardMode(ditherDepthDiscard: boolean): void

• Parameters

  • ditherDepthDiscard: boolean

  Returns void

publicsetDitherMode

• setDitherMode(ditherMode: DitheringTextureMode, animatedFrames: number): void

• Parameters

  • ditherMode: DitheringTextureMode

  • animatedFrames: number

  Returns void

publicsetHighlightColor

• setHighlightColor(color: Color3, highlightIndex: IfcMaterialHighlightIndex): void

• Parameters

  • color: Color3

  • highlightIndex: IfcMaterialHighlightIndex

  Returns void

publicsetTransparencyMode

• setTransparencyMode(transparencyMode: TransparencyMode): void

• Parameters

  • transparencyMode: TransparencyMode

  Returns void

publicupdateMaterials

• updateMaterials(clipPlanes: ClipPlane[]): void

• Updates all materials with the given clipPlanes

  ---

  Parameters

  • clipPlanes: ClipPlane[]

    The clip planes that you want to apply to the materials. Any previous clip planes will be removed.

  Returns void