core/com.pico.spatial.core.ecs.resource/PhysicallyBasedMaterial

PhysicallyBasedMaterial

class PhysicallyBasedMaterial : Material

A material that simulates the appearance of real-world objects.

PhysicallyBasedMaterial is used in scenarios where realistic rendering is required. This material simulates how light interacts with surfaces based on physical properties, resulting in highly realistic visuals.

Use cases:

AAA games that require realistic environments and character models.
Architectural visualization to create lifelike representations of buildings and interiors.
Film and animation production where high-quality rendering is essential.
Virtual reality (VR) and augmented reality (AR) applications that demand immersive and realistic visuals.

Material Property Blending:

PhysicallyBasedMaterial allows for the blending of different material properties to achieve the desired visual effect. The PropertyValue and TextureResource are combined using a multiplicative blending mode. This means that the final appearance of the material is the result of multiplying the property value with the texture color. This blending mode helps in creating more dynamic and visually interesting effects by combining uniform values and detailed texture information. Allowing for flexible customization and control over the material's appearance. These properties may be represented by different data types, such as linear color, floats, to accommodate various material characteristics.

Types

object Companion

The companion object of PhysicallyBasedMaterial.

Functions

getAmbientOcclusion

fun getAmbientOcclusion(): Float

Gets the ambient occlusion value of the PhysicallyBasedMaterial.

getAmbientOcclusionTexture

fun getAmbientOcclusionTexture(): TextureResource?

Gets the ambient occlusion texture of the PhysicallyBasedMaterial.

fun getBaseColor(): Color4

Gets the base color of the PhysicallyBasedMaterial.

getBaseColorTexture

fun getBaseColorTexture(): TextureResource?

Gets the base color texture of the PhysicallyBasedMaterial.

getBlendingMode

fun getBlendingMode(): BlendingMode

Gets the blending mode of the PhysicallyBasedMaterial.

fun getCullingMode(): MaterialCullingMode

Gets the MaterialCullingMode of the PhysicallyBasedMaterial.

fun getDepthTest(): Boolean

Gets the state of depth testing for the material.

fun getDepthWrite(): Boolean

Gets the state of depth writing for the material.

getEmissiveColor

fun getEmissiveColor(): Color4

Gets the emissive color of the PhysicallyBasedMaterial.

getEmissiveTexture

fun getEmissiveTexture(): TextureResource?

Gets the emissive texture of the PhysicallyBasedMaterial.

fun getMetallic(): Float

Gets the metallic value of the PhysicallyBasedMaterial.

getMetallicTexture

fun getMetallicTexture(): TextureResource?

Gets the metallic texture of the PhysicallyBasedMaterial.

fun getName(): String

Gets the name of the PhysicallyBasedMaterial.

fun getNormalScale(): Float

Gets the normal scale of the PhysicallyBasedMaterial.

getNormalTexture

fun getNormalTexture(): TextureResource?

Gets the normal texture of the PhysicallyBasedMaterial.

fun getOpacity(): Float

Gets the opacity of the PhysicallyBasedMaterial.

getPolygonFillMode

fun getPolygonFillMode(): PolygonFillMode

Gets the fill mode for rendering polygons in the material.

fun getRoughness(): Float

Gets the roughness of the PhysicallyBasedMaterial.

getRoughnessTexture

fun getRoughnessTexture(): TextureResource?

Gets the roughness texture of the PhysicallyBasedMaterial.

setAmbientOcclusion

fun setAmbientOcclusion(ao: Float)

Sets the ambient occlusion value of the PhysicallyBasedMaterial.

setAmbientOcclusionTexture

fun setAmbientOcclusionTexture(texture: TextureResource)

Sets the ambient occlusion texture of the PhysicallyBasedMaterial.

fun setBaseColor(color: Color4)

Sets the base color of the PhysicallyBasedMaterial using a color value.

setBaseColorTexture

fun setBaseColorTexture(texture: TextureResource)

Sets the base color of the PhysicallyBasedMaterial using a texture.

setBlendingMode

fun setBlendingMode(blendingMode: BlendingMode)

Sets the blending mode of the PhysicallyBasedMaterial.

fun setCullingMode(cullingMode: MaterialCullingMode)

Sets the MaterialCullingMode of the PhysicallyBasedMaterial.

fun setDepthTest(depthTest: Boolean)

Enables or disables depth testing for the material.

fun setDepthWrite(depthWrite: Boolean)

Enables or disables depth writing for the material.

setEmissiveColor

fun setEmissiveColor(color: Color4)

Sets the emissive color of the PhysicallyBasedMaterial.

setEmissiveTexture

fun setEmissiveTexture(texture: TextureResource)

Sets the emissive texture of the PhysicallyBasedMaterial.

fun setMetallic(metallic: Float)

Sets the metallic value of the PhysicallyBasedMaterial.

setMetallicTexture

fun setMetallicTexture(texture: TextureResource)

Sets the metallic property of the PhysicallyBasedMaterial using a texture.

fun setNormalScale(scale: Float)

Sets the normal scale of the PhysicallyBasedMaterial.

setNormalTexture

fun setNormalTexture(texture: TextureResource)

Sets the normal texture of the PhysicallyBasedMaterial.

fun setOpacity(opacity: Float)

Sets the opacity of the PhysicallyBasedMaterial.

setPolygonFillMode

fun setPolygonFillMode(polygonFillMode: PolygonFillMode)

Sets the fill mode for rendering polygons in the material.

fun setRoughness(roughness: Float)

Sets the roughness value of the PhysicallyBasedMaterial.

setRoughnessTexture

fun setRoughnessTexture(texture: TextureResource)

Sets the roughness of the PhysicallyBasedMaterial using a texture.