OdGiDistantLightTraits Class Reference

#include <GiLightTraits.h>

Inheritance diagram for OdGiDistantLightTraits:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiDistantLightTraits)
virtual void	setLightDirection (const OdGeVector3d &vec)=0
virtual OdGeVector3d	lightDirection () const =0
virtual void	setIsSunlight (bool isSunlight)=0
virtual bool	isSunlight () const =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	setSkyParameters (const OdGiSkyParameters &params)=0
virtual void	skyParameters (OdGiSkyParameters &params) 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 ()

Detailed Description

Represents characteristics for the distant light. This type of light source is located infinitely far from the scene and emits light in a specified direction. Corresponding C++ library: TD_Gi <group OdGi_Classes>

See also

<link tv_working_with_lights, Work with Lights>

Definition at line 1726 of file GiLightTraits.h.

Member Function Documentation

isSunlight()

virtual bool OdGiDistantLightTraits::isSunlight ( ) const

pure virtual

Checks whether this light is rendered as sunlight.

Returns

true if this light is rendered as sunlight, false otherwise.

lampColor()

virtual OdGiColorRGB OdGiDistantLightTraits::lampColor ( ) const

pure virtual

Retrieves color of the light lamp.

Returns

color of the light lamp as OdGiColorRGB instance.

lightDirection()

virtual OdGeVector3d OdGiDistantLightTraits::lightDirection ( ) const

pure virtual

Retrieves direction of the distant light.

Returns

direction of the distant light as OdGeVector3d instance.

ODRX_DECLARE_MEMBERS()

OdGiDistantLightTraits::ODRX_DECLARE_MEMBERS

(

OdGiDistantLightTraits

)

physicalIntensity()

virtual double OdGiDistantLightTraits::physicalIntensity ( ) const

pure virtual

Retrieves physical intensity for this light source in candela.

Returns

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

setIsSunlight()

virtual void OdGiDistantLightTraits::setIsSunlight ( bool  isSunlight )

pure virtual

Specifies whether this light is rendered as sunlight.

Parameters

isSunlight

[in] Flag that specifies whether to render this light as sunlight.

setLampColor()

virtual void OdGiDistantLightTraits::setLampColor ( const OdGiColorRGB &  color )

pure virtual

Specifies color for the light lamp.

Parameters

color

[in] RGB color value.

setLightDirection()

virtual void OdGiDistantLightTraits::setLightDirection ( const OdGeVector3d &  vec )

pure virtual

Specifies direction of the distant light.

Parameters

vec	[in] Light direction.

setPhysicalIntensity()

virtual void OdGiDistantLightTraits::setPhysicalIntensity ( double  fIntensity )

pure virtual

Specifies physical intensity for this light source in candela.

Parameters

fIntensity

[in] Physical intensity of the light in candela.

setSkyParameters()

virtual void OdGiDistantLightTraits::setSkyParameters ( const OdGiSkyParameters &  params )

pure virtual

Specifies sky parameters for this light.

Parameters

params

[in] Sky properties for this light.

skyParameters()

virtual void OdGiDistantLightTraits::skyParameters ( OdGiSkyParameters &  params ) const

pure virtual

Retrieves sky parameters of this light.

Returns

sky parameters as OdGiColorRGB instance.

---

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

• GiLightTraits.h