CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
OdGiSpotLightTraitsData Class Reference

#include <GiLightTraitsData.h>

Inheritance diagram for OdGiSpotLightTraitsData:
OdGiLightTraitsData

Public Member Functions

 OdGiSpotLightTraitsData ()
 
OdGePoint3d position () const
 
void setPosition (const OdGePoint3d &pos)
 
OdGePoint3d target () const
 
void setTarget (const OdGePoint3d &trg)
 
OdGiLightAttenuation attenuation () const
 
void setAttenuation (const OdGiLightAttenuation &atten)
 
bool setHotspotAndFalloff (double hotSpot, double falloff)
 
double hotspot () const
 
double falloff () const
 
double physicalIntensity () const
 
void setPhysicalIntensity (double intensity)
 
OdGiColorRGB lampColor () const
 
void setLampColor (const OdGiColorRGB &color)
 
void save (OdGsFiler *pFiler) const
 
void load (OdGsFiler *pFiler)
 
- Public Member Functions inherited from OdGiLightTraitsData
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)
 

Additional Inherited Members

- Public Types inherited from OdGiLightTraitsData
enum  LightType {
  kInvalidLight = -1 , kPointLight = OdGiDrawable::kPointLight , kSpotLight = OdGiDrawable::kSpotLight , kDistantLight = OdGiDrawable::kDistantLight ,
  kWebLight = OdGiDrawable::kWebLight
}
 
- Static Public Member Functions inherited from OdGiLightTraitsData
static LightType drawableLightType (const OdGiDrawable *pDrawable)
 
static void deleteLightTraitsData (OdGiLightTraitsData *pLightTraits)
 
- Protected Member Functions inherited from OdGiLightTraitsData
 OdGiLightTraitsData ()
 
- Protected Attributes inherited from OdGiLightTraitsData
LightType m_type
 

Detailed Description

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 190 of file GiLightTraitsData.h.

Constructor & Destructor Documentation

◆ OdGiSpotLightTraitsData()

OdGiSpotLightTraitsData::OdGiSpotLightTraitsData ( )
inline

Definition at line 200 of file GiLightTraitsData.h.

Member Function Documentation

◆ attenuation()

OdGiLightAttenuation OdGiSpotLightTraitsData::attenuation ( ) const
inline

Definition at line 215 of file GiLightTraitsData.h.

◆ falloff()

double OdGiSpotLightTraitsData::falloff ( ) const
inline

Definition at line 220 of file GiLightTraitsData.h.

◆ hotspot()

double OdGiSpotLightTraitsData::hotspot ( ) const
inline

Definition at line 219 of file GiLightTraitsData.h.

◆ lampColor()

OdGiColorRGB OdGiSpotLightTraitsData::lampColor ( ) const
inline

Definition at line 225 of file GiLightTraitsData.h.

◆ load()

void OdGiSpotLightTraitsData::load ( OdGsFiler pFiler)
inline

Definition at line 241 of file GiLightTraitsData.h.

◆ physicalIntensity()

double OdGiSpotLightTraitsData::physicalIntensity ( ) const
inline

Definition at line 222 of file GiLightTraitsData.h.

◆ position()

OdGePoint3d OdGiSpotLightTraitsData::position ( ) const
inline

Definition at line 209 of file GiLightTraitsData.h.

◆ save()

void OdGiSpotLightTraitsData::save ( OdGsFiler pFiler) const
inline

Definition at line 228 of file GiLightTraitsData.h.

◆ setAttenuation()

void OdGiSpotLightTraitsData::setAttenuation ( const OdGiLightAttenuation atten)
inline

Definition at line 216 of file GiLightTraitsData.h.

◆ setHotspotAndFalloff()

bool OdGiSpotLightTraitsData::setHotspotAndFalloff ( double  hotspot,
double  falloff 
)
inline

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 259 of file GiLightTraitsData.h.

◆ setLampColor()

void OdGiSpotLightTraitsData::setLampColor ( const OdGiColorRGB color)
inline

Definition at line 226 of file GiLightTraitsData.h.

◆ setPhysicalIntensity()

void OdGiSpotLightTraitsData::setPhysicalIntensity ( double  intensity)
inline

Definition at line 223 of file GiLightTraitsData.h.

◆ setPosition()

void OdGiSpotLightTraitsData::setPosition ( const OdGePoint3d pos)
inline

Definition at line 210 of file GiLightTraitsData.h.

◆ setTarget()

void OdGiSpotLightTraitsData::setTarget ( const OdGePoint3d trg)
inline

Definition at line 213 of file GiLightTraitsData.h.

◆ target()

OdGePoint3d OdGiSpotLightTraitsData::target ( ) const
inline

Definition at line 212 of file GiLightTraitsData.h.


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