OdGiWebLightTraits Class Reference

#include <GiLightTraits.h>

Inheritance diagram for OdGiWebLightTraits:

Public Types
enum	WebFileType { kTypeA = 3 , kTypeB = 2 , kTypeC = 1 }
enum	WebSymmetry { kNoSymmetry = 0 , kSingleSymmetry , kDoubleSymmetry , kAxialSymmetry }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiWebLightTraits)
virtual void	setWebFile (const OdString &fileName)=0
virtual OdString	webFile () const =0
virtual void	setWebFileStream (OdStreamBufPtr &pWebStream)=0
virtual OdStreamBufPtr	webFileStream () const =0
virtual void	setWebRotation (OdGeVector3d fRot)=0
virtual OdGeVector3d	webRotation () const =0
virtual void	setWebFlux (double fFlux)=0
virtual double	webFlux () const =0
virtual void	setWebFileType (WebFileType type)=0
virtual WebFileType	webFileType () const =0
virtual void	setWebSymmetry (WebSymmetry sym)=0
virtual WebSymmetry	webSymmetry () const =0
virtual void	setWebHorzAng90to270 (bool bFlag)=0
virtual bool	webHorzAng90to270 () const =0
Public Member Functions inherited from OdGiPointLightTraits
	ODRX_DECLARE_MEMBERS (OdGiPointLightTraits)
virtual void	setPosition (const OdGePoint3d &pos)=0
virtual OdGePoint3d	position () const =0
virtual OdGiLightAttenuation	lightAttenuation () const =0
virtual void	setAttenuation (const OdGiLightAttenuation &atten)=0
virtual void	setPhysicalIntensity (double fIntensity)=0
virtual double	physicalIntensity () const =0
virtual void	setLampColor (const OdGiColorRGB &color)=0
virtual OdGiColorRGB	lampColor () const =0
virtual void	setHasTarget (bool bTarget)=0
virtual bool	hasTarget () const =0
virtual void	setTargetLocation (const OdGePoint3d &loc)=0
virtual OdGePoint3d	targetLocation () const =0
virtual void	setHemisphericalDistribution (bool bHemisphere)=0
virtual bool	hemisphericalDistribution () const =0
Public Member Functions inherited from OdGiStandardLightTraits
	ODRX_DECLARE_MEMBERS (OdGiStandardLightTraits)
virtual void	setIntensity (double inten)=0
virtual double	intensity () const =0
virtual void	setLightColor (const OdCmEntityColor &color)=0
virtual OdCmEntityColor	lightColor () const =0
virtual void	setShadowParameters (const OdGiShadowParameters &params)=0
virtual OdGiShadowParameters	shadowParameters () const =0
Public Member Functions inherited from OdGiLightTraits
	ODRX_DECLARE_MEMBERS (OdGiLightTraits)
virtual void	setOn (bool on)=0
virtual bool	isOn () const =0
Public Member Functions inherited from OdGiDrawableTraits
	ODRX_DECLARE_MEMBERS (OdGiDrawableTraits)
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()
static void	rxInit ()
static void	rxUninit ()

Detailed Description

Extended point light that provides photometric web traits. The web traits are taken from web files, for example *.ies files. To get detailed information about photometric data in *.ies files, see the following publication:

ESNA LM-63-95, IESNA Standard File Format for Electronic Transfer of Photometric Data, By the IESNA (Illuminating Engineering Socety of North America) Computer Committee.

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 1806 of file GiLightTraits.h.

Member Enumeration Documentation

WebFileType

enum OdGiWebLightTraits::WebFileType

Types of web files.

Enumerator
kTypeA	Type A web file.
kTypeB	Type B web file.
kTypeC	Type C web file.

Definition at line 1814 of file GiLightTraits.h.

WebSymmetry

enum OdGiWebLightTraits::WebSymmetry

Types of symmetry in the web file.

Enumerator
kNoSymmetry	No symmetry.
kSingleSymmetry	Symmetric about single XZ plane.
kDoubleSymmetry	Symmetric about the XZ and YZ planes.
kAxialSymmetry	Symmetric about the Z axis.

Definition at line 1827 of file GiLightTraits.h.

Member Function Documentation

ODRX_DECLARE_MEMBERS()

OdGiWebLightTraits::ODRX_DECLARE_MEMBERS

(

OdGiWebLightTraits

)

setWebFile()

virtual void OdGiWebLightTraits::setWebFile ( const OdString & fileName )

pure virtual

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.

setWebFileStream()

virtual void OdGiWebLightTraits::setWebFileStream ( OdStreamBufPtr & pWebStream )

pure virtual

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

Parameters

pWebStream

[in] Stream pointer.

setWebFileType()

virtual void OdGiWebLightTraits::setWebFileType ( WebFileType type )

pure virtual

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

Parameters

type	[in] Type of the web file.

setWebFlux()

virtual void OdGiWebLightTraits::setWebFlux ( double fFlux )

pure virtual

Specifies the flux value for the web light.

Parameters

fFlux

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

setWebHorzAng90to270()

virtual void OdGiWebLightTraits::setWebHorzAng90to270 ( bool bFlag )

pure virtual

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.

setWebRotation()

virtual void OdGiWebLightTraits::setWebRotation ( OdGeVector3d fRot )

pure virtual

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.

setWebSymmetry()

virtual void OdGiWebLightTraits::setWebSymmetry ( WebSymmetry sym )

pure virtual

Specifies the symmetry of the web file.

Parameters

sym	[in] Symmetry of the web file.

webFile()

virtual OdString OdGiWebLightTraits::webFile ( ) const

pure virtual

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

webFileStream()

virtual OdStreamBufPtr OdGiWebLightTraits::webFileStream ( ) const

pure virtual

Retrieves a stream with data for web light.

webFileType()

virtual WebFileType OdGiWebLightTraits::webFileType ( ) const

pure virtual

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

webFlux()

virtual double OdGiWebLightTraits::webFlux ( ) const

pure virtual

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

webHorzAng90to270()

virtual bool OdGiWebLightTraits::webHorzAng90to270 ( ) const

pure virtual

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.

webRotation()

virtual OdGeVector3d OdGiWebLightTraits::webRotation ( ) const

pure virtual

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

webSymmetry()

virtual WebSymmetry OdGiWebLightTraits::webSymmetry ( ) const

pure virtual

Retrieves the type of symmetry in the web file.

---

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

• GiLightTraits.h