MaterialBase

The MaterialBase class exposes properties common to all material types.

Properties

PropertyDescription
alphaCutoff
(get) alphaCutoff: ScalarSignal
(set) alphaCutoff: ScalarSignal

Specifies a number between 0.0 and 1.0.
cullMode
(get) cullMode: Signal<MaterialsModule.CullMode>
(set) cullMode: Signal<MaterialsModule.CullMode>


Specifies the material cull mode.
diffuse
(get) diffuse: TextureBase
(set) diffuse: TextureBase


Specifies the texture that forms the basis of this material.
diffuseTextureTransform
(get) diffuseTextureTransform: TextureTransform
(set) diffuseTextureTransform: TextureTransformSignal


Specifies the coordinates transform of the diffuse texture of this material.
doubleSided
(get) doubleSided: BoolSignal
(set) doubleSided: BoolSignal


Indicates whether the material can be seen from both sides when rendering the scene.

Note: When FALSE, only the side specified by object's Cull Mode is rendered.
identifier
(get) identifier: string
(set) (Not Available)


Specifies the unique identifier for the material.
name
(get) name: string
(set) (Not Available)


Specifies the unique identifier for the material name. This value is specified in AR Studio at design time.

See Also: MaterialsModule.get.
opacity
(get) opacity: ScalarSignal
(set) opacity: ScalarSignal


Specifies a number between 0.0 and 1.0 indicating the opacity threshold for discarding pixels. 0 is transparent and 1 is opaque.

Methods

MethodDescription
getDiffuse
getDiffuse(): Promise<TextureBase>


Returns a promise that is resolved with the texture associated with a given material or null if no texture was assigned.
setTexture
setTexture(signal: ShaderSignal, config: {textureSlotName: DefaultMaterialTextures | BlendedMaterialTextures | FacePaintMaterialTextures | PhysicallyBasedMaterialTextures}): void


Assigns a ShaderSignal to the specified texture slot.
setTextureSlot
setTextureSlot(textureSlotName: String, signal: ShaderSignal): void


Assigns a ShaderSignal to the specified texture slot.