OdGiPointLightTraitsData Class Reference

#include <GiLightTraitsData.h>

Inheritance diagram for OdGiPointLightTraitsData:

Public Member Functions
	OdGiPointLightTraitsData ()
OdGePoint3d	position () const
void	setPosition (const OdGePoint3d &pos)
OdGiLightAttenuation	attenuation () const
void	setAttenuation (const OdGiLightAttenuation &atten)
double	physicalIntensity () const
void	setPhysicalIntensity (double intensity)
OdGiColorRGB	lampColor () const
void	setLampColor (const OdGiColorRGB &color)
bool	hasTarget () const
void	setHasTarget (bool bTarget)
OdGePoint3d	targetLocation () const
void	setTargetLocation (const OdGePoint3d &loc)
void	setHemisphericalDistribution (bool bHemisphere)
bool	hemisphericalDistribution () const
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 { kFlagHasTarget = (OdGiLightTraitsData::kLastFlag << 1) , kFlagHemisphere = (OdGiLightTraitsData::kLastFlag << 2) , kLastFlag = kFlagHemisphere }
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 260 of file GiLightTraitsData.h.

Member Enumeration Documentation

LightFlags

enum OdGiPointLightTraitsData::LightFlags

protected

Enumerator
kFlagHasTarget
kFlagHemisphere
kLastFlag

Definition at line 270 of file GiLightTraitsData.h.

Constructor & Destructor Documentation

OdGiPointLightTraitsData()

OdGiPointLightTraitsData::OdGiPointLightTraitsData ( )

inline

Default constructor for the OdGiPointLightTraitsData class. Creates an object with physical intensity 1500, white lamp color, without target and hemispherical distribution. Also sets type of the light to kPointLight.

Definition at line 282 of file GiLightTraitsData.h.

Member Function Documentation

attenuation()

OdGiLightAttenuation OdGiPointLightTraitsData::attenuation ( ) const

inline

Retrieves light attenuation parameters for this light source.

Returns

light attenuation parameters as OdGiLightAttenuation instance.

Definition at line 310 of file GiLightTraitsData.h.

hasTarget()

bool OdGiPointLightTraitsData::hasTarget ( ) const

inline

Checks whether this point has an associated target grip displayed.

Returns

true if light displays a target grip, false otherwise.

Definition at line 355 of file GiLightTraitsData.h.

hemisphericalDistribution()

bool OdGiPointLightTraitsData::hemisphericalDistribution ( ) const

inline

Retrieves hemispherical destribution state for this point light.

Returns

Hemispherical distribution state.

Definition at line 390 of file GiLightTraitsData.h.

lampColor()

OdGiColorRGB OdGiPointLightTraitsData::lampColor ( ) const

inline

Retrieves color of the light lamp.

Returns

color of the light lamp as OdGiColorRGB instance.

Definition at line 340 of file GiLightTraitsData.h.

load()

void OdGiPointLightTraitsData::load ( OdGsFiler * pFiler )

inline

Loads the light traits from a specified filer.

Parameters

pFiler

[in] Pointer to a filer.

Definition at line 415 of file GiLightTraitsData.h.

physicalIntensity()

double OdGiPointLightTraitsData::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 325 of file GiLightTraitsData.h.

position()

OdGePoint3d OdGiPointLightTraitsData::position ( ) const

inline

Retrieves position of the point light source.

Returns

point light position as OdGePoint3d instance.

Definition at line 295 of file GiLightTraitsData.h.

save()

void OdGiPointLightTraitsData::save ( OdGsFiler * pFiler ) const

inline

Saves the light traits to a specified filer.

Parameters

pFiler

[in] Pointer to a filer.

Definition at line 397 of file GiLightTraitsData.h.

setAttenuation()

void OdGiPointLightTraitsData::setAttenuation ( const OdGiLightAttenuation & atten )

inline

Specifies attenuation light parameters for the point light source.

Parameters

atten

[in] Point light source position.

Definition at line 317 of file GiLightTraitsData.h.

setHasTarget()

void OdGiPointLightTraitsData::setHasTarget ( bool bTarget )

inline

Specifies whether this point should have an associated target grip displayed.

Parameters

bTarget

[in] Flag that specifies whether to display a target grip for orienting the light.

Definition at line 362 of file GiLightTraitsData.h.

setHemisphericalDistribution()

void OdGiPointLightTraitsData::setHemisphericalDistribution ( bool bHemisphere )

inline

Enables hemispherical distribution of point light.

Parameters

bHemisphere

[in] Hemispherical destribution state.

Definition at line 384 of file GiLightTraitsData.h.

setLampColor()

void OdGiPointLightTraitsData::setLampColor ( const OdGiColorRGB & color )

inline

Specifies color for the light lamp.

Parameters

color

[in] RGB color value.

Definition at line 347 of file GiLightTraitsData.h.

setPhysicalIntensity()

void OdGiPointLightTraitsData::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 332 of file GiLightTraitsData.h.

setPosition()

void OdGiPointLightTraitsData::setPosition ( const OdGePoint3d & pos )

inline

Specifies position of the point light source.

Parameters

pos	[in] Point light source position.

Definition at line 302 of file GiLightTraitsData.h.

setTargetLocation()

void OdGiPointLightTraitsData::setTargetLocation ( const OdGePoint3d & loc )

inline

Specifies target location of the light.

Parameters

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

Definition at line 377 of file GiLightTraitsData.h.

targetLocation()

OdGePoint3d OdGiPointLightTraitsData::targetLocation ( ) const

inline

Retrieves target location of the light.

Returns

target location of the light as OdGePoint3d instance.

Definition at line 370 of file GiLightTraitsData.h.

---

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

• GiLightTraitsData.h