CFx SDK Documentation  2023 SP0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OdGiLightTraitsData Class Reference

#include <GiLightTraitsData.h>

Inheritance diagram for OdGiLightTraitsData:
OdGiDistantLightTraitsData OdGiLightTraitsVpDepData OdGiPointLightTraitsData OdGiSpotLightTraitsData OdGiWebLightTraitsData

Public Types

enum  LightType {
  kInvalidLight = -1 , kPointLight = OdGiDrawable::kPointLight , kSpotLight = OdGiDrawable::kSpotLight , kDistantLight = OdGiDrawable::kDistantLight ,
  kWebLight = OdGiDrawable::kWebLight
}
 

Public Member Functions

bool isOn () const
 
void setOn (bool value)
 
double intensity () const
 
void setIntensity (double dIntensity)
 
OdCmEntityColor color () const
 
void setColor (const OdCmEntityColor &color)
 
OdGiShadowParameters shadowParameters () const
 
void setShadowParameters (const OdGiShadowParameters &params)
 
LightType type () const
 
void save (OdGsFiler *pFiler) const
 
void load (OdGsFiler *pFiler)
 

Static Public Member Functions

static LightType drawableLightType (const OdGiDrawable *pDrawable)
 
static void deleteLightTraitsData (OdGiLightTraitsData *pLightTraits)
 

Protected Member Functions

 OdGiLightTraitsData ()
 

Protected Attributes

LightType m_type
 

Detailed Description

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 35 of file GiLightTraitsData.h.

Member Enumeration Documentation

◆ LightType

Enumerator
kInvalidLight 
kPointLight 
kSpotLight 
kDistantLight 
kWebLight 

Definition at line 43 of file GiLightTraitsData.h.

Constructor & Destructor Documentation

◆ OdGiLightTraitsData()

OdGiLightTraitsData::OdGiLightTraitsData ( )
inlineprotected

Definition at line 57 of file GiLightTraitsData.h.

Member Function Documentation

◆ color()

OdCmEntityColor OdGiLightTraitsData::color ( ) const
inline

Definition at line 70 of file GiLightTraitsData.h.

◆ deleteLightTraitsData()

void OdGiLightTraitsData::deleteLightTraitsData ( OdGiLightTraitsData pLightTraits)
inlinestatic

Definition at line 391 of file GiLightTraitsData.h.

◆ drawableLightType()

OdGiLightTraitsData::LightType OdGiLightTraitsData::drawableLightType ( const OdGiDrawable pDrawable)
inlinestatic

Definition at line 84 of file GiLightTraitsData.h.

◆ intensity()

double OdGiLightTraitsData::intensity ( ) const
inline

Definition at line 67 of file GiLightTraitsData.h.

◆ isOn()

bool OdGiLightTraitsData::isOn ( ) const
inline

Definition at line 64 of file GiLightTraitsData.h.

◆ load()

void OdGiLightTraitsData::load ( OdGsFiler pFiler)
inline

Definition at line 106 of file GiLightTraitsData.h.

◆ save()

void OdGiLightTraitsData::save ( OdGsFiler pFiler) const
inline

Definition at line 99 of file GiLightTraitsData.h.

◆ setColor()

void OdGiLightTraitsData::setColor ( const OdCmEntityColor color)
inline

Definition at line 71 of file GiLightTraitsData.h.

◆ setIntensity()

void OdGiLightTraitsData::setIntensity ( double  dIntensity)
inline

Definition at line 68 of file GiLightTraitsData.h.

◆ setOn()

void OdGiLightTraitsData::setOn ( bool  value)
inline

Definition at line 65 of file GiLightTraitsData.h.

◆ setShadowParameters()

void OdGiLightTraitsData::setShadowParameters ( const OdGiShadowParameters params)
inline

Definition at line 74 of file GiLightTraitsData.h.

◆ shadowParameters()

OdGiShadowParameters OdGiLightTraitsData::shadowParameters ( ) const
inline

Definition at line 73 of file GiLightTraitsData.h.

◆ type()

LightType OdGiLightTraitsData::type ( ) const
inline

Definition at line 76 of file GiLightTraitsData.h.

Member Data Documentation

◆ m_type

LightType OdGiLightTraitsData::m_type
protected

Definition at line 54 of file GiLightTraitsData.h.


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