OdGsProperties Class Reference

#include <GsProperties.h>

Inheritance diagram for OdGsProperties:

Public Types
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 }

Public Member Functions
	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 Attributes
void *	m_pUnderlyingDrawable
const OdGiDrawable *	m_pInconsistentDrawable
OdGiContext *	m_context
OdGiDrawablePtr(*	m_pOpenDrawableFn )(OdDbStub *id)
bool	m_bDrawablePersistent
OdGiDrawable::DrawableType	m_dType

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

Corresponding C++ library: TD_Gs <group OdGs_Classes>

Definition at line 112 of file GsProperties.h.

Member Enumeration Documentation

PropertiesType

enum OdGsProperties::PropertiesType

Represents property types.

Enumerator
kViewport	Represents a property type for a graphics viewport.
kBackground	Represents a property type for a view background.
kVisualStyle	Represents a property type for a visual style.
kRenderEnvironment	Represents a property type for a render environment.
kRenderSettings	Represents a property type for render settings.
kDeviceSimple	Represents a properties for a simple device.
kDeviceBackground	Represents a properties for a background-compatible device.
kDeviceNormal	Represents a properties for a normal vectorization device.
kDeviceRender	Represents a properties for a rendering device.
kAll	Represents all properties combined.

Definition at line 118 of file GsProperties.h.

Constructor & Destructor Documentation

OdGsProperties()

OdGsProperties::OdGsProperties

(

)

Default constructor for the OdGsProperties class. Sets the following data member:

member Value Description m_pUnderlyingDrawable NULL Underlying drawable m_pInconsistentDrawable NULL Inconsistent (transient) drawable m_context NULL Gi context m_bDrawablePersistent false Flag that shows whether persistent (database-resident) drawable is used m_dType (OdGiDrawable::DrawableType)0xFFFFFFFF Drawable type

Member Function Documentation

display()

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

pure virtual

Implemented in OdGsBackgroundProperties, OdGsRenderEnvironmentProperties, OdGsRenderSettingsProperties, OdGsViewportProperties, and OdGsVisualStyleProperties.

hasUnderlyingDrawable()

bool OdGsProperties::hasUnderlyingDrawable

(

)

const

Checks whether this object has an associated underlying drawable.

Returns

true if this object has an associated underlying drawable, false otherwise.

isUnderlyingDrawableChanged()

bool OdGsProperties::isUnderlyingDrawableChanged

(

const OdGiDrawable *

pUnderlyingDrawable

)

const

Checks whether associated underlying drawable has changed.

Returns

true if associated underlying drawable has changed, false otherwise.

isUnderlyingDrawablePersistent()

bool OdGsProperties::isUnderlyingDrawablePersistent

(

)

const

Checks whether an associated underlying drawable is persistent (database-resident).

Returns

true if an associated underlying drawable is persistent, false otherwise.

ODRX_DECLARE_MEMBERS()

OdGsProperties::ODRX_DECLARE_MEMBERS

(

OdGsProperties

)

propertiesForType()

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

virtual

Searches in a hierarchy corresponding properties by the specified properties type. and returns a smart pointer to the searched properties.

Reimplemented in OdGsBackgroundProperties, OdGsRenderEnvironmentProperties, OdGsRenderSettingsProperties, OdGsViewportProperties, and OdGsVisualStyleProperties.

propertiesType()

virtual PropertiesType OdGsProperties::propertiesType ( ) const

pure virtual

Retrieves a type of properties.

Implemented in OdGsBackgroundProperties, OdGsRenderEnvironmentProperties, OdGsRenderSettingsProperties, OdGsViewportProperties, and OdGsVisualStyleProperties.

setOpenDrawableFn()

void OdGsProperties::setOpenDrawableFn

(

OdGiDrawablePtr(*)(OdDbStub *)

fn

)

setUnderlyingDrawable()

void OdGsProperties::setUnderlyingDrawable	(	const OdGiDrawable *	pUnderlyingDrawable,
		OdGiContext *	ctx
	)

Sets underlying drawable.

Parameters

pUnderlyingDrawable	[in] Pointer to the underlying drawable.
ctx	[in] Pointer to the GI context.

underlyingDrawable()

OdGiDrawablePtr OdGsProperties::underlyingDrawable

(

)

const

Retrieves a smart pointer to n underlying drawable.

underlyingDrawableId()

OdDbStub * OdGsProperties::underlyingDrawableId

(

)

const

Retrieves a pointer to a persistent object ID of an underlying drawable.

underlyingDrawableType()

OdGiDrawable::DrawableType OdGsProperties::underlyingDrawableType

(

)

const

Retrieves a type of an underlying drawable.

update()

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

pure virtual

Implemented in OdGsBackgroundProperties, OdGsRenderEnvironmentProperties, OdGsRenderSettingsProperties, OdGsViewportProperties, and OdGsVisualStyleProperties.

Member Data Documentation

m_bDrawablePersistent

bool OdGsProperties::m_bDrawablePersistent

protected

Definition at line 156 of file GsProperties.h.

m_context

OdGiContext* OdGsProperties::m_context

protected

Definition at line 153 of file GsProperties.h.

m_dType

OdGiDrawable::DrawableType OdGsProperties::m_dType

protected

Definition at line 158 of file GsProperties.h.

m_pInconsistentDrawable

const OdGiDrawable* OdGsProperties::m_pInconsistentDrawable

protected

Definition at line 152 of file GsProperties.h.

m_pOpenDrawableFn

OdGiDrawablePtr(* OdGsProperties::m_pOpenDrawableFn) (OdDbStub *id)

protected

Definition at line 155 of file GsProperties.h.

m_pUnderlyingDrawable

void* OdGsProperties::m_pUnderlyingDrawable

protected

Definition at line 151 of file GsProperties.h.

---

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

• GsProperties.h