CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdGiStandardLightTraits Class Referenceabstract

#include <GiLightTraits.h>

Inheritance diagram for OdGiStandardLightTraits:
OdGiLightTraits OdGiDrawableTraits OdRxObject OdGiDistantLightTraits OdGiPointLightTraits OdGiSpotLightTraits OdGiWebLightTraits

Public Member Functions

 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 OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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 OdRxClassdesc ()
 

Detailed Description

Represents characteristics of a standard light source.

Corresponding C++ library: TD_Gi <group OdGi_Classes>

See also
<link tv_working_with_lights, Work with Lights>

Definition at line 1406 of file GiLightTraits.h.

Member Function Documentation

◆ intensity()

virtual double OdGiStandardLightTraits::intensity ( ) const
pure virtual

Retrieves intensity of a light source.

Returns
the intensity of the light source as a value of the double type.

◆ lightColor()

virtual OdCmEntityColor OdGiStandardLightTraits::lightColor ( ) const
pure virtual

Retrieves color of a light source.

Returns
color of the emitted light as OdCmEntityColor instance.

◆ ODRX_DECLARE_MEMBERS()

OdGiStandardLightTraits::ODRX_DECLARE_MEMBERS ( OdGiStandardLightTraits  )

◆ setIntensity()

virtual void OdGiStandardLightTraits::setIntensity ( double  inten)
pure virtual

Specifies intensity of a light source.

Parameters
inten[in] Light source intensity.

◆ setLightColor()

virtual void OdGiStandardLightTraits::setLightColor ( const OdCmEntityColor color)
pure virtual

Specifies color of a light source.

Parameters
color[in] Color of the emitted light.

◆ setShadowParameters()

virtual void OdGiStandardLightTraits::setShadowParameters ( const OdGiShadowParameters params)
pure virtual

Specifies shadow parameters for this light source.

Parameters
params[in] Shadow parameters.

◆ shadowParameters()

virtual OdGiShadowParameters OdGiStandardLightTraits::shadowParameters ( ) const
pure virtual

Retrieves shadow parameters of this light source.

Returns
shadow parameters as OdGiShadowParameters instance.

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