MaterialsModule Overview
MaterialsModule Overview
MetallicRoughnessPbrMaterial

MetallicRoughnessPbrMaterial

The MetallicRoughnessPbrMaterial class encapsulates physically based materials.

Inherits From : MaterialBase

Properties

PropertyDescription
baseColor
(get) (Not Available)
(set) baseColor: TextureBase | null


Specifies the baseColor texture of the material.
baseColorFactor
(get) baseColorFactor: RgbaSignal
(set) baseColorFactor: ColorSignal


Specifies a ColorSignal for a base color factor. A ColorSignal may be created using the RGBA() and HSVA() methods of the Reactive module.
Note that RgbaSignal is always returned.
See Also: ReactiveModule.RGBA and ReactiveModule.HSVA.
baseColorTextureTransform
(get) baseColorTextureTransform: TextureTransform
(set) baseColorTextureTransform: TextureTransformSignal


Specifies the coordinates transform of the baseColorFactor texture of this material.
blendMode
(get) blendMode: Signal<MaterialsModule.BlendMode>
(set) blendMode: Signal<MaterialsModule.BlendMode>


Specifies the material blend mode.
diffuseEnvironment
(get) (Not Available)
(set) diffuseEnvironment: TextureBase | null


Set a diffuse environment texture on this material.
emissive
(get) (Not Available)
(set) emissive: TextureBase | null


Specifies the emissive texture of the material.
emissiveTextureTransform
(get) emissiveTextureTransform: TextureTransform
(set) emissiveTextureTransform: TextureTransformSignal


Specifies the coordinates transform of the emissive texture of this material.
metallicFactor
(get) metallicFactor: ScalarSignal
(set) metallicFactor: ScalarSignal


Specifies the metallic factor.
metallicRoughness
(get) (Not Available)
(set) metallicRoughness: TextureBase | null


Specifies the metallicRoughness texture of the material.
metallicRoughnessTextureTransform
(get) metallicRoughnessTextureTransform: TextureTransform
(set) metallicRoughnessTextureTransform: TextureTransformSignal


Specifies the coordinates transform of the MetallicRoughness texture of this material.
normalTextureTransform
(get) normalTextureTransform: TextureTransform
(set) normalTextureTransform: TextureTransformSignal


Specifies the coordinates transform of the normal texture of this material.
roughnessFactor
(get) roughnessFactor: ScalarSignal
(set) roughnessFactor: ScalarSignal


Specifies the roughness factor.
specularEnvironment
(get) (Not Available)
(set) specularEnvironment: TextureBase | null


Set a specular environment texture on this material.
staticEnvironmentRotation
(get) staticEnvironmentRotation: PointSignal
(set) staticEnvironmentRotation: PointSignal


Specifies the rotation signal to be used for transformations of static environment textures.

Methods

MethodDescription
getBaseColor
getBaseColor(): Promise<TextureBase | null>


Returns a promise that is resolved with the texture associated with a given material or null if no texture was assigned.
getDiffuseEnvironment
getDiffuseEnvironment(): Promise<TextureBase | null>


Returns a promise that is resolved with the diffuse environment texture associated with a given material or null if no texture was assigned.
getEmissive
getEmissive(): Promise<TextureBase | null>


Returns a promise that is resolved with the texture associated with a given material or null if no texture was assigned.
getMetallicRoughness
getMetallicRoughness(): Promise<TextureBase | null>


Returns a promise that is resolved with the texture associated with a given material or null if no texture was assigned.
getNormal
getNormal(): Promise<TextureBase | null>


Returns a promise that is resolved with the texture associated with a given material or null if no texture was assigned.
getSpecularEnvironment
getSpecularEnvironment(): Promise<TextureBase | null>


Returns a promise that is resolved with the specular environment texture associated with a given material or null if no texture was assigned.
setNormal
setNormal(texture: TextureBase | null): Promise<void>


Assign normal texture for this material.
Returns a promise that is resolved when the texture is assigned.

Was this article helpful?