FI3DHMaterialProperties Struct Reference

FI3DHMaterialProperties Struct Reference#

instant3Dhub: FI3DHMaterialProperties Struct Reference
instant3Dhub

#include "I3DHDataTypes.h"

Collaboration diagram for FI3DHMaterialProperties:

Detailed Description

Metadata for materials stored in the instant3Dhub MaterialAPI.

Experimental
The instant3Dhub Material API is experimental and under active development.

Public Member Functions

const FLinearColorGetBaseColor () const
const FLinearColorGetEmissiveColor () const
float GetOpacity () const
float GetRoughness () const
float GetMetallic () const

Public Attributes

TOptional< FLinearColorBaseColor
TOptional< FLinearColorEmissiveColor
TOptional< FStringName
TOptional< float > Opacity
TOptional< float > Roughness
TOptional< float > Metallic

Member Function Documentation

◆ GetBaseColor()

const FLinearColor & FI3DHMaterialProperties::GetBaseColor ( ) const
inline

Returns the base color of the material, defaulting to [1, 1, 1].

◆ GetEmissiveColor()

const FLinearColor & FI3DHMaterialProperties::GetEmissiveColor ( ) const
inline

Returns the emissive color of the material, defaulting to [0, 0, 0].

◆ GetMetallic()

float FI3DHMaterialProperties::GetMetallic ( ) const
inline

Returns the metallic property of the material, defaulting to 0.0.

◆ GetOpacity()

float FI3DHMaterialProperties::GetOpacity ( ) const
inline

Returns the opacity of the material, defaulting to 1.0.

◆ GetRoughness()

float FI3DHMaterialProperties::GetRoughness ( ) const
inline

Returns the roughness of the material, defaulting to 0.5.

Member Data Documentation

◆ BaseColor

TOptional<FLinearColor> FI3DHMaterialProperties::BaseColor

The base color of the material.

Defaults to [1, 1, 1].

Note
Alpha component is ignored. Use Opacity instead.

◆ EmissiveColor

TOptional<FLinearColor> FI3DHMaterialProperties::EmissiveColor

The emissive color of the material.

Defaults to [0, 0, 0].

Note
Alpha component is ignored. Use Opacity instead.

◆ Metallic

TOptional<float> FI3DHMaterialProperties::Metallic

The metallic property of the material in range [0, 1].

Defaults to 0.0.

◆ Name

TOptional<FString> FI3DHMaterialProperties::Name

The name of the material.

◆ Opacity

TOptional<float> FI3DHMaterialProperties::Opacity

The opacity of the material in range [0, 1].

Defaults to 1.0.

◆ Roughness

TOptional<float> FI3DHMaterialProperties::Roughness

The roughness of the material in range [0, 1].

Defaults to 0.5.


The documentation for this struct was generated from the following file: