OdGiWebLightTraitsData Class Reference

#include <GiLightTraitsData.h>

Inheritance diagram for OdGiWebLightTraitsData:

Public Member Functions
	OdGiWebLightTraitsData ()
const OdString &	webFile () const
void	setWebFile (const OdString &fileName)
virtual void	setWebFileStream (OdStreamBufPtr &pWebStream)
virtual OdStreamBufPtr	webFileStream () const
const OdGeVector3d &	webRotation () const
void	setWebRotation (const OdGeVector3d &rot)
double	webFlux () const
void	setWebFlux (double flux)
OdGiWebLightTraits::WebFileType	webFileType () const
void	setWebFileType (OdGiWebLightTraits::WebFileType type)
OdGiWebLightTraits::WebSymmetry	webSymmetry () const
void	setWebSymmetry (OdGiWebLightTraits::WebSymmetry sym)
bool	webHorzAng90to270 () const
void	setWebHorzAng90to270 (bool bHA)
void	save (OdGsFiler *pFiler) const
void	load (OdGsFiler *pFiler)
Public Member Functions inherited from OdGiPointLightTraitsData
	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 { kFlagHorzAng90to270 = (OdGiPointLightTraitsData::kLastFlag << 1) , kLastFlag = kFlagHorzAng90to270 }
Protected Types inherited from OdGiPointLightTraitsData
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>

Definition at line 747 of file GiLightTraitsData.h.

Member Enumeration Documentation

LightFlags

enum OdGiWebLightTraitsData::LightFlags

protected

Enumerator
kFlagHorzAng90to270
kLastFlag

Definition at line 757 of file GiLightTraitsData.h.

Constructor & Destructor Documentation

OdGiWebLightTraitsData()

OdGiWebLightTraitsData::OdGiWebLightTraitsData ( )

inline

Default constructor for the OdGiWebLightTraitsData class.

Definition at line 767 of file GiLightTraitsData.h.

Member Function Documentation

load()

void OdGiWebLightTraitsData::load ( OdGsFiler * pFiler )

inline

Loads the light traits from a specified filer.

Parameters

pFiler

[in] Pointer to a filer.

Definition at line 909 of file GiLightTraitsData.h.

save()

void OdGiWebLightTraitsData::save ( OdGsFiler * pFiler ) const

inline

Saves the light traits to a specified filer.

Parameters

pFiler

[in] Pointer to a filer.

Definition at line 878 of file GiLightTraitsData.h.

setWebFile()

void OdGiWebLightTraitsData::setWebFile ( const OdString & fileName )

inline

Specifies the path to the file that stores the light's goniometric data (for example, inside *.IES files). Applicable only if photometric lights are used.

Parameters

fileName

[in] Full path to a web file.

Definition at line 786 of file GiLightTraitsData.h.

setWebFileStream()

virtual void OdGiWebLightTraitsData::setWebFileStream ( OdStreamBufPtr & pWebStream )

inlinevirtual

Specifies the stream that stores the light's goniometric data. Applicable only if photometric lights are used.

Parameters

fileName

[in] Stream pointer.

Definition at line 793 of file GiLightTraitsData.h.

setWebFileType()

void OdGiWebLightTraitsData::setWebFileType ( OdGiWebLightTraits::WebFileType type )

inline

Specifies the type of web file which is used for the web light.

Parameters

type	[in] Type of the web file.

Definition at line 843 of file GiLightTraitsData.h.

setWebFlux()

void OdGiWebLightTraitsData::setWebFlux ( double flux )

inline

Specifies the flux value for the web light.

Parameters

fFlux

[in] Flux value (in lumens) for the web light.

Definition at line 830 of file GiLightTraitsData.h.

setWebHorzAng90to270()

void OdGiWebLightTraitsData::setWebHorzAng90to270 ( bool bHA )

inline

Specifies whether the IES file based web light is a bilaterally symmetric luminaire (symmetric about the 90 to 270 degree plane).

Parameters

bFlag

[in] Flag that specifies whether the web light has a horizontal angle that starts from 90 degrees and ends with 270 degrees.

Definition at line 871 of file GiLightTraitsData.h.

setWebRotation()

void OdGiWebLightTraitsData::setWebRotation ( const OdGeVector3d & rot )

inline

Specifies rotation offset used to orient the goniometric data relative to the light orientation. The offset is specified in XYZ Euler angles.

Parameters

fRot	[in] Rotation offset.

Definition at line 817 of file GiLightTraitsData.h.

setWebSymmetry()

void OdGiWebLightTraitsData::setWebSymmetry ( OdGiWebLightTraits::WebSymmetry sym )

inline

Specifies the symmetry of the web file.

Parameters

sym	[in] Symmetry of the web file.

Definition at line 856 of file GiLightTraitsData.h.

webFile()

const OdString & OdGiWebLightTraitsData::webFile ( ) const

inline

Retrieves a string that represents a full path to a web file.

Definition at line 779 of file GiLightTraitsData.h.

webFileStream()

virtual OdStreamBufPtr OdGiWebLightTraitsData::webFileStream ( ) const

inlinevirtual

Retrieves a stream with data for web light.

Definition at line 803 of file GiLightTraitsData.h.

webFileType()

OdGiWebLightTraits::WebFileType OdGiWebLightTraitsData::webFileType ( ) const

inline

Retrieves the type of a web file used for the web light.

Definition at line 836 of file GiLightTraitsData.h.

webFlux()

double OdGiWebLightTraitsData::webFlux ( ) const

inline

Retrieves the flux value (in lumens) for the web light.

Definition at line 823 of file GiLightTraitsData.h.

webHorzAng90to270()

bool OdGiWebLightTraitsData::webHorzAng90to270 ( ) const

inline

Checks whether the web light is a bilaterally symmetric luminaire.

Returns

true if the web light has a horizontal angle that starts from 90 degrees and ends with 270 degrees.

Definition at line 864 of file GiLightTraitsData.h.

webRotation()

const OdGeVector3d & OdGiWebLightTraitsData::webRotation ( ) const

inline

Retrieves rotation offset used to orient the goniometric data relative to the light orientation (in XYZ Euler angles).

Definition at line 809 of file GiLightTraitsData.h.

webSymmetry()

OdGiWebLightTraits::WebSymmetry OdGiWebLightTraitsData::webSymmetry ( ) const

inline

Retrieves the type of symmetry in the web file.

Definition at line 849 of file GiLightTraitsData.h.

---

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

• GiLightTraitsData.h