OdGiSpotLightTraitsData Class Reference

#include <GiLightTraitsData.h>

Inheritance diagram for OdGiSpotLightTraitsData:

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>

See also

<link tv_working_with_lights, Work with Lights>

Definition at line 384 of file GiLightTraitsData.h.

Constructor & Destructor Documentation

OdGiSpotLightTraitsData()

OdGiSpotLightTraitsData::OdGiSpotLightTraitsData ( )

inline

Default constructor for the OdGiSpotLightTraitsData class. Creates an object with physical intensity 1500, white lamp color, hotspot and falloff cone angles set to 0. Also sets type of the light to kSpotLight.

Definition at line 398 of file GiLightTraitsData.h.

Member Function Documentation

attenuation()

OdGiLightAttenuation OdGiSpotLightTraitsData::attenuation ( ) const

inline

Retrieves light attenuation parameters for this light source.

Returns

light attenuation parameters as OdGiLightAttenuation instance.

Definition at line 447 of file GiLightTraitsData.h.

falloff()

double OdGiSpotLightTraitsData::falloff ( ) const

inline

Retrieves the cone angle that produces the light falloff.

Returns

cone of the falloff as a value of the double type.

Definition at line 480 of file GiLightTraitsData.h.

hotspot()

double OdGiSpotLightTraitsData::hotspot ( ) const

inline

Retrieves the cone angle that produces the brightest part of the beam (hotspot) of this light.

Returns

cone of the hotspot as a value of the double type.

Definition at line 472 of file GiLightTraitsData.h.

lampColor()

OdGiColorRGB OdGiSpotLightTraitsData::lampColor ( ) const

inline

Retrieves color of the light lamp.

Returns

color of the light lamp as OdGiColorRGB instance.

Definition at line 507 of file GiLightTraitsData.h.

load()

void OdGiSpotLightTraitsData::load ( OdGsFiler *  pFiler )

inline

Loads the light traits from a specified filer.

Parameters

pFiler

[in] Pointer to a filer.

Definition at line 541 of file GiLightTraitsData.h.

physicalIntensity()

double OdGiSpotLightTraitsData::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 490 of file GiLightTraitsData.h.

position()

OdGePoint3d OdGiSpotLightTraitsData::position ( ) const

inline

Retrieves position of the spot light source.

Returns

position of the spot light source as OdGePoint3d instance.

Definition at line 413 of file GiLightTraitsData.h.

save()

void OdGiSpotLightTraitsData::save ( OdGsFiler *  pFiler ) const

inline

Saves the light traits to a specified filer.

Parameters

pFiler

[in] Pointer to a filer.

Definition at line 523 of file GiLightTraitsData.h.

setAttenuation()

void OdGiSpotLightTraitsData::setAttenuation ( const OdGiLightAttenuation &  atten )

inline

Specifies attenuation light parameters for the point light source.

Parameters

atten

[in] Point light source position.

Definition at line 454 of file GiLightTraitsData.h.

setHotspotAndFalloff()

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

inline

Specifies target location of the light.

Parameters

hotspot	[in] Hotspot cone angle, in radians. Defines the brightest part of the spot light beam.
falloff	[in] Falloff angle, in radians. Defines the full cone of light.

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 559 of file GiLightTraitsData.h.

setLampColor()

void OdGiSpotLightTraitsData::setLampColor ( const OdGiColorRGB &  color )

inline

Specifies color for the light lamp.

Parameters

color

[in] RGB color value.

Definition at line 514 of file GiLightTraitsData.h.

setPhysicalIntensity()

void OdGiSpotLightTraitsData::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 497 of file GiLightTraitsData.h.

setPosition()

void OdGiSpotLightTraitsData::setPosition ( const OdGePoint3d &  pos )

inline

Specifies position of the spot light source.

Parameters

pos	[in] Spot light source position.

Definition at line 420 of file GiLightTraitsData.h.

setTarget()

void OdGiSpotLightTraitsData::setTarget ( const OdGePoint3d &  trg )

inline

Specifies target location of the light.

Parameters

loc	[in] Location of the target. Must differ from the spot light position.

Definition at line 437 of file GiLightTraitsData.h.

target()

OdGePoint3d OdGiSpotLightTraitsData::target ( ) const

inline

Retrieves target location of the light.

Returns

target location of the light as OdGePoint3d instance.

Definition at line 430 of file GiLightTraitsData.h.

---

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

• GiLightTraitsData.h