OdGsBackgroundProperties Class Reference

#include <GsBackgroundProperties.h>

Inheritance diagram for OdGsBackgroundProperties:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGsBackgroundProperties)
	OdGsBackgroundProperties ()
	~OdGsBackgroundProperties ()
OdGiSolidBackgroundTraitsData *	solidBackgroundTraitsData () const
OdGiGradientBackgroundTraitsData *	gradientBackgroundTraitsData () const
OdGiImageBackgroundTraitsData *	imageBackgroundTraitsData () const
OdGiGroundPlaneBackgroundTraitsData *	groundPlaneBackgroundTraitsData () const
OdGiSkyBackgroundTraitsData *	skyBackgroundTraitsData () const
OdGiIBLBackgroundTraitsData *	iblBackgroundTraitsData () const
OdGiBackgroundTraitsData *	backgroundTraitsData () const
OdGiDrawable::DrawableType	backgroundType () const
const OdGsBackgroundProperties *	secondaryBackground () const
OdGsBackgroundProperties *	secondaryBackground ()
bool	isTraitsModified ()
void	clearTraits ()
virtual PropertiesType	propertiesType () const
virtual OdSmartPtr< OdGsProperties >	propertiesForType (PropertiesType type) const
virtual void	update (const OdGiDrawable *pUnderlyingDrawable, OdGsViewImpl *view, OdUInt32 incFlags=kAll)
virtual void	display (OdGsBaseVectorizer &view, OdGsPropertiesDirectRenderOutput *pdro=NULL, OdUInt32 incFlags=kAll)
Public Member Functions inherited from OdGsProperties
	ODRX_DECLARE_MEMBERS (OdGsProperties)
	OdGsProperties ()
void	setOpenDrawableFn (OdGiDrawablePtr(*fn)(OdDbStub *))
void	setUnderlyingDrawable (const OdGiDrawable *pUnderlyingDrawable, OdGiContext *ctx)
OdGiDrawablePtr	underlyingDrawable () const
bool	isUnderlyingDrawableChanged (const OdGiDrawable *pUnderlyingDrawable) const
bool	hasUnderlyingDrawable () const
bool	isUnderlyingDrawablePersistent () const
OdDbStub *	underlyingDrawableId () const
OdGiDrawable::DrawableType	underlyingDrawableType () const
virtual PropertiesType	propertiesType () const =0
virtual OdSmartPtr< OdGsProperties >	propertiesForType (PropertiesType) const
virtual void	update (const OdGiDrawable *pUnderlyingDrawable, OdGsViewImpl *view, OdUInt32 incFlags=kAll)=0
virtual void	display (OdGsBaseVectorizer &view, OdGsPropertiesDirectRenderOutput *pdro=NULL, OdUInt32 incFlags=kAll)=0
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

Protected Member Functions
virtual void	nestedBackgroundDisplay (OdGsBaseVectorizer &view, const OdGiDrawable *pDrawable, OdGiBackgroundTraitsData *pBackgroundTraits, OdGsPropertiesDirectRenderOutput *pdro=NULL)
virtual void	nestedBackgroundDisplay (OdGsBaseVectorizer &view, const OdGiDrawable *pDrawable, OdGiBackgroundTraitsData *pBackgroundTraits, OdGsPropertiesDirectRenderOutput *pdro=NULL)=0

Additional Inherited Members
Public Types inherited from OdGsProperties
enum	PropertiesType {   kViewport = 1 , kBackground = (1 << 1) , kVisualStyle = (1 << 2) , kRenderEnvironment = (1 << 3) ,   kRenderSettings = (1 << 4) , kDeviceSimple = 0 , kDeviceBackground = 3 , kDeviceNormal = 7 ,   kDeviceRender = 31 , kAll = 31 }
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()
Protected Attributes inherited from OdGsProperties
void *	m_pUnderlyingDrawable
const OdGiDrawable *	m_pInconsistentDrawable
OdGiContext *	m_context
OdGiDrawablePtr(*	m_pOpenDrawableFn )(OdDbStub *id)
bool	m_bDrawablePersistent
OdGiDrawable::DrawableType	m_dType

Detailed Description

<group OdGs_Classes>

Definition at line 35 of file GsBackgroundProperties.h.

Constructor & Destructor Documentation

OdGsBackgroundProperties()

OdGsBackgroundProperties::OdGsBackgroundProperties

(

)

Default constructor for the OdGsBackgroundProperties class. Sets background traits to NULL.

~OdGsBackgroundProperties()

OdGsBackgroundProperties::~OdGsBackgroundProperties

(

)

Destructor for the OdGsBackgroundProperties class. Clears background traits.

Member Function Documentation

backgroundTraitsData()

OdGiBackgroundTraitsData * OdGsBackgroundProperties::backgroundTraitsData ( ) const

inline

Retrieves pointer to background traits of the underlying background.

Definition at line 94 of file GsBackgroundProperties.h.

backgroundType()

OdGiDrawable::DrawableType OdGsBackgroundProperties::backgroundType ( ) const

inline

Retrieves background type of the underlying background.

Definition at line 100 of file GsBackgroundProperties.h.

clearTraits()

void OdGsBackgroundProperties::clearTraits

(

)

Clears background traits.

display()

virtual void OdGsBackgroundProperties::display ( OdGsBaseVectorizer &  view, OdGsPropertiesDirectRenderOutput *  pdro = NULL, OdUInt32  incFlags = kAll  )

virtual

Implements OdGsProperties.

gradientBackgroundTraitsData()

OdGiGradientBackgroundTraitsData * OdGsBackgroundProperties::gradientBackgroundTraitsData ( ) const

inline

Retrieves pointer to background traits of a gradient background.

Definition at line 69 of file GsBackgroundProperties.h.

groundPlaneBackgroundTraitsData()

OdGiGroundPlaneBackgroundTraitsData * OdGsBackgroundProperties::groundPlaneBackgroundTraitsData ( ) const

inline

Retrieves pointer to background traits of ground plane background.

Definition at line 79 of file GsBackgroundProperties.h.

iblBackgroundTraitsData()

OdGiIBLBackgroundTraitsData * OdGsBackgroundProperties::iblBackgroundTraitsData ( ) const

inline

Retrieves pointer to background traits of an image-based lighting background.

Definition at line 89 of file GsBackgroundProperties.h.

imageBackgroundTraitsData()

OdGiImageBackgroundTraitsData * OdGsBackgroundProperties::imageBackgroundTraitsData ( ) const

inline

Retrieves pointer to background traits of an image background.

Definition at line 74 of file GsBackgroundProperties.h.

isTraitsModified()

bool OdGsBackgroundProperties::isTraitsModified

(

)

Checks whether background traits is modified.

Returns

true if background traits are modified, false otherwise.

nestedBackgroundDisplay()

virtual void OdGsBackgroundProperties::nestedBackgroundDisplay ( OdGsBaseVectorizer &  view, const OdGiDrawable *  pDrawable, OdGiBackgroundTraitsData *  pBackgroundTraits, OdGsPropertiesDirectRenderOutput *  pdro = NULL  )

protectedvirtual

Implements OdGsNestedBackground.

ODRX_DECLARE_MEMBERS()

OdGsBackgroundProperties::ODRX_DECLARE_MEMBERS

(

OdGsBackgroundProperties

)

propertiesForType()

virtual OdSmartPtr< OdGsProperties > OdGsBackgroundProperties::propertiesForType ( PropertiesType  type ) const

virtual

Retrieves smart pointer to properties of the background by the specified property type.

Parameters

type	[in] Property type.

Reimplemented from OdGsProperties.

propertiesType()

virtual PropertiesType OdGsBackgroundProperties::propertiesType ( ) const

inlinevirtual

Retrieves property type of this object which is PropertiesType::kBackground.

Implements OdGsProperties.

Definition at line 130 of file GsBackgroundProperties.h.

secondaryBackground() [1/2]

OdGsBackgroundProperties * OdGsBackgroundProperties::secondaryBackground ( )

inline

Retrieves pointer to the secondary background.

Definition at line 110 of file GsBackgroundProperties.h.

secondaryBackground() [2/2]

const OdGsBackgroundProperties * OdGsBackgroundProperties::secondaryBackground ( ) const

inline

Retrieves pointer to the secondary background.

Definition at line 105 of file GsBackgroundProperties.h.

skyBackgroundTraitsData()

OdGiSkyBackgroundTraitsData * OdGsBackgroundProperties::skyBackgroundTraitsData ( ) const

inline

Retrieves pointer to background traits of a sky background.

Definition at line 84 of file GsBackgroundProperties.h.

solidBackgroundTraitsData()

OdGiSolidBackgroundTraitsData * OdGsBackgroundProperties::solidBackgroundTraitsData ( ) const

inline

Retrieves pointer to background traits of a solid background.

Definition at line 64 of file GsBackgroundProperties.h.

update()

virtual void OdGsBackgroundProperties::update ( const OdGiDrawable *  pUnderlyingDrawable, OdGsViewImpl *  view, OdUInt32  incFlags = kAll  )

virtual

Implements OdGsProperties.

---

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

• GsBackgroundProperties.h