Open CASCADE Technology 7.8.0
Public Member Functions | Data Fields
XCAFDoc_VisMaterialPBR Struct Reference

Metallic-roughness PBR material definition. More...

#include <XCAFDoc_VisMaterialPBR.hxx>

Public Member Functions

 XCAFDoc_VisMaterialPBR ()
 Empty constructor.
 
Standard_Boolean IsEqual (const XCAFDoc_VisMaterialPBR &theOther) const
 Compare two materials.
 
void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream.
 

Data Fields

Handle< Image_TextureBaseColorTexture
 RGB texture for the base color.
 
Handle< Image_TextureMetallicRoughnessTexture
 RG texture packing the metallic and roughness properties together.
 
Handle< Image_TextureEmissiveTexture
 RGB emissive map controls the color and intensity of the light being emitted by the material.
 
Handle< Image_TextureOcclusionTexture
 R occlusion map indicating areas of indirect lighting.
 
Handle< Image_TextureNormalTexture
 normal map
 
Quantity_ColorRGBA BaseColor
 base color (or scale factor to the texture); [1.0, 1.0, 1.0, 1.0] by default
 
Graphic3d_Vec3 EmissiveFactor
 emissive color; [0.0, 0.0, 0.0] by default
 
Standard_ShortReal Metallic
 metalness (or scale factor to the texture) within range [0.0, 1.0]; 1.0 by default
 
Standard_ShortReal Roughness
 roughness (or scale factor to the texture) within range [0.0, 1.0]; 1.0 by default
 
Standard_ShortReal RefractionIndex
 IOR (index of refraction) within range [1.0, 3.0]; 1.5 by default.
 
Standard_Boolean IsDefined
 defined flag; TRUE by default
 

Detailed Description

Metallic-roughness PBR material definition.

Constructor & Destructor Documentation

◆ XCAFDoc_VisMaterialPBR()

XCAFDoc_VisMaterialPBR::XCAFDoc_VisMaterialPBR ( )
inline

Empty constructor.

Member Function Documentation

◆ DumpJson()

void XCAFDoc_VisMaterialPBR::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const
inline

Dumps the content of me into the stream.

◆ IsEqual()

Standard_Boolean XCAFDoc_VisMaterialPBR::IsEqual ( const XCAFDoc_VisMaterialPBR theOther) const
inline

Compare two materials.

Field Documentation

◆ BaseColor

Quantity_ColorRGBA XCAFDoc_VisMaterialPBR::BaseColor

base color (or scale factor to the texture); [1.0, 1.0, 1.0, 1.0] by default

◆ BaseColorTexture

Handle< Image_Texture > XCAFDoc_VisMaterialPBR::BaseColorTexture

RGB texture for the base color.

◆ EmissiveFactor

Graphic3d_Vec3 XCAFDoc_VisMaterialPBR::EmissiveFactor

emissive color; [0.0, 0.0, 0.0] by default

◆ EmissiveTexture

Handle< Image_Texture > XCAFDoc_VisMaterialPBR::EmissiveTexture

RGB emissive map controls the color and intensity of the light being emitted by the material.

◆ IsDefined

Standard_Boolean XCAFDoc_VisMaterialPBR::IsDefined

defined flag; TRUE by default

◆ Metallic

Standard_ShortReal XCAFDoc_VisMaterialPBR::Metallic

metalness (or scale factor to the texture) within range [0.0, 1.0]; 1.0 by default

◆ MetallicRoughnessTexture

Handle< Image_Texture > XCAFDoc_VisMaterialPBR::MetallicRoughnessTexture

RG texture packing the metallic and roughness properties together.

◆ NormalTexture

Handle< Image_Texture > XCAFDoc_VisMaterialPBR::NormalTexture

normal map

◆ OcclusionTexture

Handle< Image_Texture > XCAFDoc_VisMaterialPBR::OcclusionTexture

R occlusion map indicating areas of indirect lighting.

◆ RefractionIndex

Standard_ShortReal XCAFDoc_VisMaterialPBR::RefractionIndex

IOR (index of refraction) within range [1.0, 3.0]; 1.5 by default.

◆ Roughness

Standard_ShortReal XCAFDoc_VisMaterialPBR::Roughness

roughness (or scale factor to the texture) within range [0.0, 1.0]; 1.0 by default


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