OdGiSpotLightTraits Class Reference

#include <GiLightTraits.h>

Inheritance diagram for OdGiSpotLightTraits:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiSpotLightTraits)
virtual void	setPosition (const OdGePoint3d &pos)=0
virtual OdGePoint3d	position () const =0
virtual void	setTargetLocation (const OdGePoint3d &loc)=0
virtual OdGePoint3d	targetLocation () const =0
virtual bool	setHotspotAndFalloff (double hotspot, double falloff)=0
virtual double	hotspot () const =0
virtual double	falloff () 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
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 spot light. This type of light source emits a cone of 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 1598 of file GiLightTraits.h.

Member Function Documentation

falloff()

virtual double OdGiSpotLightTraits::falloff ( ) const

pure virtual

Retrieves the cone angle that produces the light falloff.

Returns

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

hotspot()

virtual double OdGiSpotLightTraits::hotspot ( ) const

pure virtual

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.

lampColor()

virtual OdGiColorRGB OdGiSpotLightTraits::lampColor ( ) const

pure virtual

Retrieves color of the light lamp.

Returns

color of the light lamp as OdGiColorRGB instance.

lightAttenuation()

virtual OdGiLightAttenuation OdGiSpotLightTraits::lightAttenuation ( ) const

pure virtual

Retrieves light attenuation parameters for this light source.

Returns

light attenuation parameters as OdGiLightAttenuation instance.

ODRX_DECLARE_MEMBERS()

OdGiSpotLightTraits::ODRX_DECLARE_MEMBERS

(

OdGiSpotLightTraits

)

physicalIntensity()

virtual double OdGiSpotLightTraits::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.

position()

virtual OdGePoint3d OdGiSpotLightTraits::position ( ) const

pure virtual

Retrieves position of the spot light source.

Returns

position of the spot light source as OdGePoint3d instance.

setAttenuation()

virtual void OdGiSpotLightTraits::setAttenuation ( const OdGiLightAttenuation &  atten )

pure virtual

Specifies attenuation light parameters for the point light source.

Parameters

atten

[in] Point light source position.

setHotspotAndFalloff()

virtual bool OdGiSpotLightTraits::setHotspotAndFalloff ( double  hotspot, double  falloff  )

pure virtual

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.

setLampColor()

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

pure virtual

Specifies color for the light lamp.

Parameters

color

[in] RGB color value.

setPhysicalIntensity()

virtual void OdGiSpotLightTraits::setPhysicalIntensity ( double  fIntensity )

pure virtual

Specifies physical intensity for this light source in candela.

Parameters

fIntensity

[in] Physical intensity of the light in candela.

setPosition()

virtual void OdGiSpotLightTraits::setPosition ( const OdGePoint3d &  pos )

pure virtual

Specifies position of the spot light source.

Parameters

pos	[in] Spot light source position.

setTargetLocation()

virtual void OdGiSpotLightTraits::setTargetLocation ( const OdGePoint3d &  loc )

pure virtual

Specifies target location of the light.

Parameters

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

targetLocation()

virtual OdGePoint3d OdGiSpotLightTraits::targetLocation ( ) const

pure virtual

Retrieves target location of the light.

Returns

target location of the light as OdGePoint3d instance.

---

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

• GiLightTraits.h