DATAKIT API  V2025.1
catiav5w::Material::Lighting Class Reference

Public Member Functions

Dtk_Double64 GetAmbientCoefficient () const
 
const Dtk_RGBGetAmbientColor () const
 
Dtk_Double64 GetDiffuseCoefficient () const
 
const Dtk_RGBGetDiffuseColor () const
 
Dtk_Double64 GetReflectivityCoefficient () const
 
Dtk_Double64 GetSpecularCoefficient () const
 
const Dtk_RGBGetSpecularColor () const
 
Dtk_Double64 GetTransparencyCoefficient () const
 
const Dtk_RGBGetTransparencyColor () const
 
 Lighting ()
 
void SetAmbientData (const Dtk_RGB &inAmbientColor, const Dtk_Double64 inAmbientCoefficient)
 
void SetDiffuseData (const Dtk_RGB &inDiffuseColor, const Dtk_Double64 inDiffuseCoefficient)
 
void SetReflectivityCoefficient (const Dtk_Double64 inReflectivityCoefficient)
 
void SetSpecularData (const Dtk_RGB &inSpecularColor, const Dtk_Double64 inSpecularCoefficient)
 
void SetTransparencyData (const Dtk_RGB &inTransparencyColor, const Dtk_Double64 inTransparencyCoefficient)
 

Protected Attributes

Dtk_Double64 m_AmbientCoefficient
 
Dtk_RGB m_AmbientColor
 
Dtk_Double64 m_DiffuseCoefficient
 
Dtk_RGB m_DiffuseColor
 
Dtk_Double64 m_ReflectivityCoefficient
 
Dtk_Double64 m_SpecularCoefficient
 
Dtk_RGB m_SpecularColor
 
Dtk_Double64 m_TransparencyCoefficient
 
Dtk_RGB m_TransparencyColor
 

Constructor & Destructor Documentation

◆ Lighting()

catiav5w::Material::Lighting::Lighting ( )
116  {
117  //default values
118  //No color
119  //No Coefficient
120  m_AmbientCoefficient = -1.0;
121  m_DiffuseCoefficient = -1.0;
122  m_SpecularCoefficient = -1.0;
125  }

Member Function Documentation

◆ GetAmbientCoefficient()

Dtk_Double64 catiav5w::Material::Lighting::GetAmbientCoefficient ( ) const
154 { return m_AmbientCoefficient; }

◆ GetAmbientColor()

const Dtk_RGB& catiav5w::Material::Lighting::GetAmbientColor ( ) const
150 { return m_AmbientColor; }

◆ GetDiffuseCoefficient()

Dtk_Double64 catiav5w::Material::Lighting::GetDiffuseCoefficient ( ) const
155 { return m_DiffuseCoefficient; }

◆ GetDiffuseColor()

const Dtk_RGB& catiav5w::Material::Lighting::GetDiffuseColor ( ) const
151 { return m_DiffuseColor; }

◆ GetReflectivityCoefficient()

Dtk_Double64 catiav5w::Material::Lighting::GetReflectivityCoefficient ( ) const
158 { return m_ReflectivityCoefficient; }

◆ GetSpecularCoefficient()

Dtk_Double64 catiav5w::Material::Lighting::GetSpecularCoefficient ( ) const
156 { return m_SpecularCoefficient; }

◆ GetSpecularColor()

const Dtk_RGB& catiav5w::Material::Lighting::GetSpecularColor ( ) const
152 { return m_SpecularColor; }

◆ GetTransparencyCoefficient()

Dtk_Double64 catiav5w::Material::Lighting::GetTransparencyCoefficient ( ) const
157 { return m_TransparencyCoefficient; }

◆ GetTransparencyColor()

const Dtk_RGB& catiav5w::Material::Lighting::GetTransparencyColor ( ) const
153 { return m_TransparencyColor; }

◆ SetAmbientData()

void catiav5w::Material::Lighting::SetAmbientData ( const Dtk_RGB inAmbientColor,
const Dtk_Double64  inAmbientCoefficient 
)
127  {
128  m_AmbientColor = inAmbientColor;
129  m_AmbientCoefficient = ( ( inAmbientCoefficient > 1. ) || ( inAmbientCoefficient < 0. ) ) ? 1. : inAmbientCoefficient;
130  }

◆ SetDiffuseData()

void catiav5w::Material::Lighting::SetDiffuseData ( const Dtk_RGB inDiffuseColor,
const Dtk_Double64  inDiffuseCoefficient 
)
132  {
133  m_DiffuseColor = inDiffuseColor;
134  m_DiffuseCoefficient = ( ( inDiffuseCoefficient > 1. ) || ( inDiffuseCoefficient < 0. ) ) ? 1. : inDiffuseCoefficient;
135  }

◆ SetReflectivityCoefficient()

void catiav5w::Material::Lighting::SetReflectivityCoefficient ( const Dtk_Double64  inReflectivityCoefficient)
147  {
148  m_ReflectivityCoefficient = ( ( inReflectivityCoefficient > 1. ) || ( inReflectivityCoefficient < 0. ) ) ? 0. : inReflectivityCoefficient;
149  }

◆ SetSpecularData()

void catiav5w::Material::Lighting::SetSpecularData ( const Dtk_RGB inSpecularColor,
const Dtk_Double64  inSpecularCoefficient 
)
137  {
138  m_SpecularColor = inSpecularColor;
139  m_SpecularCoefficient = ( ( inSpecularCoefficient > 1. ) || ( inSpecularCoefficient < 0. ) ) ? 0. : inSpecularCoefficient;
140  }

◆ SetTransparencyData()

void catiav5w::Material::Lighting::SetTransparencyData ( const Dtk_RGB inTransparencyColor,
const Dtk_Double64  inTransparencyCoefficient 
)
142  {
143  m_TransparencyColor = inTransparencyColor;
144  m_TransparencyCoefficient = ( ( inTransparencyCoefficient > 1. ) || ( inTransparencyCoefficient < 0. ) ) ? 0. : inTransparencyCoefficient;
145  }

Field Documentation

◆ m_AmbientCoefficient

Dtk_Double64 catiav5w::Material::Lighting::m_AmbientCoefficient
protected

◆ m_AmbientColor

Dtk_RGB catiav5w::Material::Lighting::m_AmbientColor
protected

◆ m_DiffuseCoefficient

Dtk_Double64 catiav5w::Material::Lighting::m_DiffuseCoefficient
protected

◆ m_DiffuseColor

Dtk_RGB catiav5w::Material::Lighting::m_DiffuseColor
protected

◆ m_ReflectivityCoefficient

Dtk_Double64 catiav5w::Material::Lighting::m_ReflectivityCoefficient
protected

◆ m_SpecularCoefficient

Dtk_Double64 catiav5w::Material::Lighting::m_SpecularCoefficient
protected

◆ m_SpecularColor

Dtk_RGB catiav5w::Material::Lighting::m_SpecularColor
protected

◆ m_TransparencyCoefficient

Dtk_Double64 catiav5w::Material::Lighting::m_TransparencyCoefficient
protected

◆ m_TransparencyColor

Dtk_RGB catiav5w::Material::Lighting::m_TransparencyColor
protected
catiav5w::Material::Lighting::m_TransparencyCoefficient
Dtk_Double64 m_TransparencyCoefficient
Definition: catiav5w.hpp:111
catiav5w::Material::Lighting::m_SpecularCoefficient
Dtk_Double64 m_SpecularCoefficient
Definition: catiav5w.hpp:109
catiav5w::Material::Lighting::m_TransparencyColor
Dtk_RGB m_TransparencyColor
Definition: catiav5w.hpp:110
catiav5w::Material::Lighting::m_AmbientColor
Dtk_RGB m_AmbientColor
Definition: catiav5w.hpp:104
catiav5w::Material::Lighting::m_DiffuseColor
Dtk_RGB m_DiffuseColor
Definition: catiav5w.hpp:106
catiav5w::Material::Lighting::m_DiffuseCoefficient
Dtk_Double64 m_DiffuseCoefficient
Definition: catiav5w.hpp:107
catiav5w::Material::Lighting::m_SpecularColor
Dtk_RGB m_SpecularColor
Definition: catiav5w.hpp:108
catiav5w::Material::Lighting::m_ReflectivityCoefficient
Dtk_Double64 m_ReflectivityCoefficient
Definition: catiav5w.hpp:113
catiav5w::Material::Lighting::m_AmbientCoefficient
Dtk_Double64 m_AmbientCoefficient
Definition: catiav5w.hpp:105