OdGiDistantLightTraitsData Class Reference

#include <GiLightTraitsData.h>

Inheritance diagram for OdGiDistantLightTraitsData:

Public Member Functions
	OdGiDistantLightTraitsData ()
OdGeVector3d	direction () const
void	setDirection (const OdGeVector3d &dir)
bool	isSunlight () const
void	setSunlight (bool val)
double	physicalIntensity () const
void	setPhysicalIntensity (double intensity)
OdGiColorRGB	lampColor () const
void	setLampColor (const OdGiColorRGB &color)
void	skyParameters (OdGiSkyParameters &) const
void	setSkyParameters (const OdGiSkyParameters &)
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)
void	setLightTransform (const OdGeMatrix3d &xForm)
void	addLightTransform (const OdGeMatrix3d &xForm)
void	resetLightTransform ()
bool	isLightTransformed () const
const OdGeMatrix3d &	lightTransformationMatrix () const

Protected Types
enum	LightFlags { kFlagIsSunlight = (OdGiLightTraitsData::kLastFlag << 1) , kLastFlag = kFlagIsSunlight }
Protected Types inherited from OdGiLightTraitsData
enum	LightFlags { kFlagIsOn = (1 << 0) , kFlagIsTransformed = (1 << 1) , kLastFlag = kFlagIsTransformed }

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
OdUInt32	m_uFlags
LightType	m_type

Detailed Description

Corresponding C++ library: TD_Gi <group OdGi_Classes>

See also

<link tv_working_with_lights, Work with Lights>

Definition at line 615 of file GiLightTraitsData.h.

Member Enumeration Documentation

LightFlags

enum OdGiDistantLightTraitsData::LightFlags

protected

Enumerator
kFlagIsSunlight
kLastFlag

Definition at line 624 of file GiLightTraitsData.h.

Constructor & Destructor Documentation

OdGiDistantLightTraitsData()

OdGiDistantLightTraitsData::OdGiDistantLightTraitsData ( )

inline

Default constructor for the OdGiDistantLightTraitsData class. Creates an object with physical intensity 1500, white lamp color, and flag that specifies whether this light is rendered as a sunlight. Also sets type of the light to kDistantLight.

Definition at line 635 of file GiLightTraitsData.h.

Member Function Documentation

direction()

OdGeVector3d OdGiDistantLightTraitsData::direction ( ) const

inline

Retrieves direction of the distant light.

Returns

direction of the distant light as OdGeVector3d instance.

Definition at line 648 of file GiLightTraitsData.h.

isSunlight()

bool OdGiDistantLightTraitsData::isSunlight ( ) const

inline

Checks whether this light is rendered as sunlight.

Returns

true if this light is rendered as sunlight, false otherwise.

Definition at line 663 of file GiLightTraitsData.h.

lampColor()

OdGiColorRGB OdGiDistantLightTraitsData::lampColor ( ) const

inline

Retrieves color of the light lamp.

Returns

color of the light lamp as OdGiColorRGB instance.

Definition at line 693 of file GiLightTraitsData.h.

load()

void OdGiDistantLightTraitsData::load ( OdGsFiler * pFiler )

inline

Loads the light traits from a specified filer.

Parameters

pFiler

[in] Pointer to a filer.

Definition at line 732 of file GiLightTraitsData.h.

physicalIntensity()

double OdGiDistantLightTraitsData::physicalIntensity ( ) const

inline

Retrieves physical intensity for this light source in candela.

Returns

physical intensity of the light as a value of the double type.

Definition at line 678 of file GiLightTraitsData.h.

save()

void OdGiDistantLightTraitsData::save ( OdGsFiler * pFiler ) const

inline

Saves the light traits to a specified filer.

Parameters

pFiler

[in] Pointer to a filer.

Definition at line 717 of file GiLightTraitsData.h.

setDirection()

void OdGiDistantLightTraitsData::setDirection ( const OdGeVector3d & dir )

inline

Specifies direction of the distant light.

Parameters

dir	[in] Light direction.

Definition at line 655 of file GiLightTraitsData.h.

setLampColor()

void OdGiDistantLightTraitsData::setLampColor ( const OdGiColorRGB & color )

inline

Specifies color for the light lamp.

Parameters

color

[in] RGB color value.

Definition at line 700 of file GiLightTraitsData.h.

setPhysicalIntensity()

void OdGiDistantLightTraitsData::setPhysicalIntensity ( double intensity )

inline

Specifies physical intensity for this light source in candela.

Parameters

fIntensity

[in] Physical intensity of the light in candela.

Definition at line 685 of file GiLightTraitsData.h.

setSkyParameters()

void OdGiDistantLightTraitsData::setSkyParameters ( const OdGiSkyParameters & )

inline

Specifies sky parameters for this light. Currently not implemented.

Definition at line 710 of file GiLightTraitsData.h.

setSunlight()

void OdGiDistantLightTraitsData::setSunlight ( bool val )

inline

Specifies whether this light is rendered as sunlight.

Parameters

isSunlight

[in] Flag that specifies whether to render this light as sunlight.

Definition at line 670 of file GiLightTraitsData.h.

skyParameters()

void OdGiDistantLightTraitsData::skyParameters ( OdGiSkyParameters & ) const

inline

Retrieves sky parameters of this light. Currently not implemented.

Definition at line 705 of file GiLightTraitsData.h.

---

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

• GiLightTraitsData.h