CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdTrVisLightDef Struct Reference

#include <TrVisLightDef.h>

Inheritance diagram for OdTrVisLightDef:
OdTrVecLightDef

Public Types

enum  LightDefFlags { kLightEnabled = (1 << 0) , kLightUseLims = (1 << 1) , kLightShadows = (1 << 2) }
 
enum  Overrider {
  kOverrideVisibility = (1 << 0) , kOverrideOrientation = (1 << 1) , kOverrideColor = (1 << 2) , kOverrideTextrue = (1 << 3) ,
  kOverrideAttenuation = (1 << 4) , kOverrideAngles = (1 << 5) , kOverrideSpecualFactor = (1 << 6) , kOverrideShadow = (1 << 7) ,
  kLastOverride = kOverrideShadow
}
 
enum  LightType { kDistant = 0 , kPoint , kSpot }
 

Public Member Functions

void setLightOn (bool bSet)
 
bool isLightOn () const
 
void enableAttenuationLimits (bool bSet)
 
bool attenuationLimitsEnabled () const
 
void enableShadows (bool bSet)
 
bool shadowsEnabled () const
 
void setDefault ()
 
OdTrVisLightDefapply (OdUInt32 nMod, const OdTrVisLightDef &l)
 
OdUInt32 diff (const OdTrVisLightDef &dl2, bool bFinFirstDiff=false) const
 
void transformBy (const OdGeMatrix3d &xForm)
 
bool operator== (const OdTrVisLightDef &dl2) const
 
bool operator!= (const OdTrVisLightDef &dl2) const
 
void save (OdGsFiler *pFiler) const
 
void load (OdGsFiler *pFiler)
 

Public Attributes

enum OdTrVisLightDef::LightType m_type
 
OdGePoint3d m_position
 
OdGeVector3d m_direction
 
OdGeVector3d m_upVector
 
OdTrVisMaterialColor m_color
 
OdTrVisTextureId m_texture
 
float m_constantAttenuation
 
float m_linearAttenuation
 
float m_quadraticAttenuation
 
float m_startAttenuationLimit
 
float m_endAttenuationLimit
 
float m_spotCutoff
 
float m_spotExponent
 
float m_specularFactor
 
OdUInt16 m_shadowMapSize
 
OdUInt16 m_shadowSoftness
 
OdUInt16 m_shadowSamples
 
OdUInt16 m_lightFlags
 

Detailed Description

<group ExRender_Windows_Classes>

Definition at line 38 of file TrVisLightDef.h.

Member Enumeration Documentation

◆ LightDefFlags

Enumerator
kLightEnabled 
kLightUseLims 
kLightShadows 

Definition at line 41 of file TrVisLightDef.h.

◆ LightType

Enumerator
kDistant 
kPoint 
kSpot 

Definition at line 62 of file TrVisLightDef.h.

◆ Overrider

Enumerator
kOverrideVisibility 
kOverrideOrientation 
kOverrideColor 
kOverrideTextrue 
kOverrideAttenuation 
kOverrideAngles 
kOverrideSpecualFactor 
kOverrideShadow 
kLastOverride 

Definition at line 48 of file TrVisLightDef.h.

Member Function Documentation

◆ apply()

OdTrVisLightDef & OdTrVisLightDef::apply ( OdUInt32 nMod,
const OdTrVisLightDef & l )
inline

Definition at line 129 of file TrVisLightDef.h.

◆ attenuationLimitsEnabled()

bool OdTrVisLightDef::attenuationLimitsEnabled ( ) const
inline

Definition at line 101 of file TrVisLightDef.h.

◆ diff()

OdUInt32 OdTrVisLightDef::diff ( const OdTrVisLightDef & dl2,
bool bFinFirstDiff = false ) const
inline

Definition at line 166 of file TrVisLightDef.h.

◆ enableAttenuationLimits()

void OdTrVisLightDef::enableAttenuationLimits ( bool bSet)
inline

Definition at line 100 of file TrVisLightDef.h.

◆ enableShadows()

void OdTrVisLightDef::enableShadows ( bool bSet)
inline

Definition at line 103 of file TrVisLightDef.h.

◆ isLightOn()

bool OdTrVisLightDef::isLightOn ( ) const
inline

Definition at line 98 of file TrVisLightDef.h.

◆ load()

void OdTrVisLightDef::load ( OdGsFiler * pFiler)
inline

Definition at line 260 of file TrVisLightDef.h.

◆ operator!=()

bool OdTrVisLightDef::operator!= ( const OdTrVisLightDef & dl2) const
inline

Definition at line 231 of file TrVisLightDef.h.

◆ operator==()

bool OdTrVisLightDef::operator== ( const OdTrVisLightDef & dl2) const
inline

Definition at line 229 of file TrVisLightDef.h.

◆ save()

void OdTrVisLightDef::save ( OdGsFiler * pFiler) const
inline

Definition at line 238 of file TrVisLightDef.h.

◆ setDefault()

void OdTrVisLightDef::setDefault ( )
inline

Definition at line 107 of file TrVisLightDef.h.

◆ setLightOn()

void OdTrVisLightDef::setLightOn ( bool bSet)
inline

Definition at line 97 of file TrVisLightDef.h.

◆ shadowsEnabled()

bool OdTrVisLightDef::shadowsEnabled ( ) const
inline

Definition at line 104 of file TrVisLightDef.h.

◆ transformBy()

void OdTrVisLightDef::transformBy ( const OdGeMatrix3d & xForm)
inline

Definition at line 221 of file TrVisLightDef.h.

Member Data Documentation

◆ m_color

OdTrVisMaterialColor OdTrVisLightDef::m_color

Definition at line 75 of file TrVisLightDef.h.

◆ m_constantAttenuation

float OdTrVisLightDef::m_constantAttenuation

Definition at line 79 of file TrVisLightDef.h.

◆ m_direction

OdGeVector3d OdTrVisLightDef::m_direction

Definition at line 71 of file TrVisLightDef.h.

◆ m_endAttenuationLimit

float OdTrVisLightDef::m_endAttenuationLimit

Definition at line 84 of file TrVisLightDef.h.

◆ m_lightFlags

OdUInt16 OdTrVisLightDef::m_lightFlags

Definition at line 95 of file TrVisLightDef.h.

◆ m_linearAttenuation

float OdTrVisLightDef::m_linearAttenuation

Definition at line 80 of file TrVisLightDef.h.

◆ m_position

OdGePoint3d OdTrVisLightDef::m_position

Definition at line 69 of file TrVisLightDef.h.

◆ m_quadraticAttenuation

float OdTrVisLightDef::m_quadraticAttenuation

Definition at line 81 of file TrVisLightDef.h.

◆ m_shadowMapSize

OdUInt16 OdTrVisLightDef::m_shadowMapSize

Definition at line 91 of file TrVisLightDef.h.

◆ m_shadowSamples

OdUInt16 OdTrVisLightDef::m_shadowSamples

Definition at line 93 of file TrVisLightDef.h.

◆ m_shadowSoftness

OdUInt16 OdTrVisLightDef::m_shadowSoftness

Definition at line 92 of file TrVisLightDef.h.

◆ m_specularFactor

float OdTrVisLightDef::m_specularFactor

Definition at line 89 of file TrVisLightDef.h.

◆ m_spotCutoff

float OdTrVisLightDef::m_spotCutoff

Definition at line 86 of file TrVisLightDef.h.

◆ m_spotExponent

float OdTrVisLightDef::m_spotExponent

Definition at line 87 of file TrVisLightDef.h.

◆ m_startAttenuationLimit

float OdTrVisLightDef::m_startAttenuationLimit

Definition at line 83 of file TrVisLightDef.h.

◆ m_texture

OdTrVisTextureId OdTrVisLightDef::m_texture

Definition at line 77 of file TrVisLightDef.h.

◆ m_type

enum OdTrVisLightDef::LightType OdTrVisLightDef::m_type

◆ m_upVector

OdGeVector3d OdTrVisLightDef::m_upVector

Definition at line 73 of file TrVisLightDef.h.


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