OdGiLightTraitsData Class Reference

#include <GiLightTraitsData.h>

Inheritance diagram for OdGiLightTraitsData:

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>

See also

<link tv_working_with_lights, Work with Lights>

Definition at line 37 of file GiLightTraitsData.h.

Member Enumeration Documentation

LightType

enum OdGiLightTraitsData::LightType

Represents light types.

Enumerator
kInvalidLight	Invalid light.
kPointLight	Point light.
kSpotLight	Spot light.
kDistantLight	Distant light.
kWebLight	Web light.

Definition at line 48 of file GiLightTraitsData.h.

Constructor & Destructor Documentation

OdGiLightTraitsData()

OdGiLightTraitsData::OdGiLightTraitsData ( )

inlineprotected

Definition at line 73 of file GiLightTraitsData.h.

Member Function Documentation

color()

OdCmEntityColor OdGiLightTraitsData::color ( ) const

inline

Retrieves the color of the emitted light.

Returns

the color of the emitted light as OdCmEntityColor instance.

Definition at line 117 of file GiLightTraitsData.h.

deleteLightTraitsData()

void OdGiLightTraitsData::deleteLightTraitsData ( OdGiLightTraitsData *  pLightTraits )

inlinestatic

Deletes the specified light traits.

Parameters

pLightTraits

[in] Pointer to light traits to delete.

Definition at line 774 of file GiLightTraitsData.h.

drawableLightType()

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

inlinestatic

Retrieves a light type.

Returns

light type as a value from the LightType enumeration.

Definition at line 175 of file GiLightTraitsData.h.

intensity()

double OdGiLightTraitsData::intensity ( ) const

inline

Retrieves intensity of a light source.

Returns

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

Definition at line 102 of file GiLightTraitsData.h.

isOn()

bool OdGiLightTraitsData::isOn ( ) const

inline

Checks whether light is enabled.

Returns

true if light is enabled, false otherwise.

Definition at line 87 of file GiLightTraitsData.h.

load()

void OdGiLightTraitsData::load ( OdGsFiler *  pFiler )

inline

Loads the light traits from a specified filer.

Parameters

pFiler

[in] Pointer to a filer.

Definition at line 197 of file GiLightTraitsData.h.

save()

void OdGiLightTraitsData::save ( OdGsFiler *  pFiler ) const

inline

Saves the light traits to a specified filer.

Parameters

pFiler

[in] Pointer to a filer.

Definition at line 190 of file GiLightTraitsData.h.

setColor()

void OdGiLightTraitsData::setColor ( const OdCmEntityColor &  color )

inline

Specifies the color of the emitted light.

Parameters

color

[in] Color of the emitted light.

Definition at line 124 of file GiLightTraitsData.h.

setIntensity()

void OdGiLightTraitsData::setIntensity ( double  dIntensity )

inline

Specifies intensity of a light source.

Parameters

dIntensity

[in] Light source intensity.

Definition at line 109 of file GiLightTraitsData.h.

setOn()

void OdGiLightTraitsData::setOn ( bool  value )

inline

Specifies whether light is enabled.

Parameters

value

[in] Flag that specifies whether light is enabled.

Definition at line 94 of file GiLightTraitsData.h.

setShadowParameters()

void OdGiLightTraitsData::setShadowParameters ( const OdGiShadowParameters &  params )

inline

Specifies shadow parameters for this light source.

Parameters

params

[in] Shadow parameters.

See also

<link gi_shadows_rendering, Shadows Visualization>

Definition at line 143 of file GiLightTraitsData.h.

shadowParameters()

OdGiShadowParameters OdGiLightTraitsData::shadowParameters ( ) const

inline

Retrieves shadow parameters of this light source.

Returns

shadow parameters as OdGiShadowParameters instance.

See also

<link gi_shadows_rendering, Shadows Visualization>

Definition at line 134 of file GiLightTraitsData.h.

type()

LightType OdGiLightTraitsData::type ( ) const

inline

Retrieves a light type.

Returns

light type as a value from the LightType enumeration.

Definition at line 151 of file GiLightTraitsData.h.

Member Data Documentation

m_type

LightType OdGiLightTraitsData::m_type

protected

Definition at line 70 of file GiLightTraitsData.h.

---

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

• GiLightTraitsData.h