OdGiLightTraitsVpDepData Class Reference

#include <GiLightTraitsData.h>

Inheritance diagram for OdGiLightTraitsVpDepData:

Public Member Functions
	OdGiLightTraitsVpDepData ()
OdUInt32	viewportId () const
void	setViewportId (OdUInt32 id)
OdDbStub *	viewportObjectId () const
void	setViewportObjectId (OdDbStub *id)
bool	vpDepOn () const
void	setVpDepOn (bool on)
double	vpDepDimming () const
void	setVpDepDimming (double dimming)
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

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 Types inherited from OdGiLightTraitsData
enum	LightFlags { kFlagIsOn = (1 << 0) , kFlagIsTransformed = (1 << 1) , kLastFlag = kFlagIsTransformed }
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 958 of file GiLightTraitsData.h.

Constructor & Destructor Documentation

OdGiLightTraitsVpDepData()

OdGiLightTraitsVpDepData::OdGiLightTraitsVpDepData ( )

inline

Default constructor for the OdGiLightTraitsVpDepData class.

Definition at line 970 of file GiLightTraitsData.h.

Member Function Documentation

load()

void OdGiLightTraitsVpDepData::load ( OdGsFiler * pFiler )

inline

Loads light traits data from the specified filer.

Parameters

pFiler

[in] Filer pointer from which to load the light traits data.

Definition at line 1040 of file GiLightTraitsData.h.

save()

void OdGiLightTraitsVpDepData::save ( OdGsFiler * pFiler ) const

inline

Saves light traits data to the specified filer.

Parameters

pFiler

[out] Filer pointer to which to save the light traits data.

Definition at line 1027 of file GiLightTraitsData.h.

setViewportId()

void OdGiLightTraitsVpDepData::setViewportId ( OdUInt32 id )

inline

Sets a viewport ID for the viewport-dependent light traits.

Parameters

id	[in] Viewport ID.

Definition at line 988 of file GiLightTraitsData.h.

setViewportObjectId()

void OdGiLightTraitsVpDepData::setViewportObjectId ( OdDbStub * id )

inline

Sets a database-resident viewport Object ID for the viewport-dependent light traits.

Parameters

id	[in] Pointer to the database-resident viewport Object ID.

Definition at line 1001 of file GiLightTraitsData.h.

setVpDepDimming()

void OdGiLightTraitsVpDepData::setVpDepDimming ( double dimming )

inline

Definition at line 1020 of file GiLightTraitsData.h.

setVpDepOn()

void OdGiLightTraitsVpDepData::setVpDepOn ( bool on )

inline

Switches light traits dependency on or off.

Parameters

on	[in] Light traits dependency state.

Definition at line 1017 of file GiLightTraitsData.h.

viewportId()

OdUInt32 OdGiLightTraitsVpDepData::viewportId ( ) const

inline

Retrieves a viewport ID for the viewport-dependent light traits.

Definition at line 981 of file GiLightTraitsData.h.

viewportObjectId()

OdDbStub * OdGiLightTraitsVpDepData::viewportObjectId ( ) const

inline

Retrieves a pointer to the database-resident viewport Object ID for the viewport-dependent light traits.

Definition at line 994 of file GiLightTraitsData.h.

vpDepDimming()

double OdGiLightTraitsVpDepData::vpDepDimming ( ) const

inline

Definition at line 1019 of file GiLightTraitsData.h.

vpDepOn()

bool OdGiLightTraitsVpDepData::vpDepOn ( ) const

inline

Checks whether viewport dependency is turned on.

Returns

true if viewport dependency is on, false otherwise.

Definition at line 1010 of file GiLightTraitsData.h.

---

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

• GiLightTraitsData.h