OdGsBaseModel Class Reference

#include <GsBaseModel.h>

Inheritance diagram for OdGsBaseModel:

Classes
struct	SectioningSettings

Public Types
enum	AdditionMode { kAddDrawable = 0, kUneraseDrawable }
typedef std::pair< OdGsViewImpl *, OdUInt32 >	ViewRef
typedef std::pair< const OdGsBaseModule *, OdUInt32 >	ModuleRef
Public Types inherited from OdGsModel
enum	InvalidationHint {   kInvalidateIsolines = 0, kInvalidateViewportCache = 1, kInvalidateAll = 2, kInvalidateMaterials = 3,   kInvalidateLinetypes = 4 }
enum	RenderType {   kMinRenderType = -3, kUserBg1 = -3, kUserBg2 = -2, kUserBg3 = -1,   kMain = 0, kSprite, kDirect, kHighlight,   kHighlightSelection, kDirectTopmost, kContrast, kCount,   kUserFg1 = kCount, kUserFg2, kUserFg3, kMaxRenderType,   kNumRenderTypes = kMaxRenderType - kMinRenderType }

Public Member Functions
virtual void	invalidateEntRect (OdGiDrawable *pDrawable, OdGiDrawable *pParent, bool bForceIfNoExtents=false)
virtual void	invalidateEntRect (OdGsEntityNode *pNode, OdGsContainerNode *pParent, bool bForceIfNoExtents)
bool	checkFaded () const
void	setCheckFaded (bool bOn)
const ViewPropsArray &	getViewProps () const
OdGsViewImpl *	refView () const
OdGsBaseVectorizeDevice *	refDevice () const
OdUInt32	refModulesCount () const
bool	invalidVp (unsigned int viewportId) const
OdGsBaseModelImpl *	impl ()
void	invalidateRegenDrawBlocks (OdGsViewImpl &view, const OdDbStub *layoutId)
void	invalidateSectionableBlocks ()
virtual OdGsNode *	gsNode (OdGiDrawable *pDrawable)
virtual void	detach (OdGsNode *pNode)
virtual void	detachAll ()
void	detachAllFromDb (const OdDbBaseDatabase *pDb)
OdGiDrawablePtr	open (OdDbStub *objectId)
void	setOpenDrawableFn (OdGiOpenDrawableFn openDrawableFn)
OdGiOpenDrawableFn	openDrawableFn () const
void	onAdded (OdGiDrawable *pAdded, OdGiDrawable *pParent)
void	onAdded (OdGiDrawable *pAdded, OdDbStub *parentID)
virtual void	onAddedImpl (OdGiDrawable *pAdded, OdGiDrawable *pParent, AdditionMode additionMode=kAddDrawable)
void	onModified (OdGiDrawable *pModified, OdGiDrawable *pParent)
void	onModified (OdGiDrawable *pModified, OdDbStub *parentID)
virtual void	onModifiedImpl (OdGiDrawable *pModified, OdGiDrawable *pParent)
void	onErased (OdGiDrawable *pErased, OdGiDrawable *pParent)
void	onErased (OdGiDrawable *pErased, OdDbStub *parentID)
virtual void	onErasedImpl (OdGiDrawable *pErased, OdGiDrawable *pParent)
void	onUnerased (OdGiDrawable *pUnerased, OdGiDrawable *pParent)
void	onUnerased (OdGiDrawable *pUnerased, OdDbStub *parentID)
void	invalidate (InvalidationHint hint)
void	invalidate (OdGsView *pView)
void	invalidateVisible (OdGsDevice *pDevice)
void	invalidate (OdGsViewImpl &view, OdUInt32 mask)
OdUInt32	viewChanges (OdUInt32 viewportId) const
OdUInt32	numViewProps () const
const ViewProps &	viewProps (OdUInt32 viewportId) const
virtual void	updateViewProps (const OdGsViewImpl &viewport)
virtual bool	isViewPropsValid (OdUInt32 viewportId) const
virtual OdGsLayerNode *	gsLayerNode (OdDbStub *layerId, const OdGsBaseVectorizer *pView)
virtual void	propagateLayerChanges (OdGsBaseVectorizeDevice &device)
void	setTransform (const OdGeMatrix3d &xForm)
OdGeMatrix3d	transform () const
bool	isIdentityTransform () const
OdGsView::RenderMode	renderModeOverride () const
void	setRenderModeOverride (OdGsView::RenderMode mode=OdGsView::kNone)
void	highlight (const OdGiPathNode &path, bool bDoIt=true, const OdGsView *pView=NULL)
virtual void	highlightImpl (const OdGiPathNode &path, bool bDoIt=true, const OdGsView *pView=NULL)
OdGsMaterialCache *	materialCache ()
void	setAdditionMode (AdditionMode mode)
AdditionMode	additionMode () const
void	setRenderType (RenderType renderType)
RenderType	renderType () const
void	setBackground (OdDbStub *backgroundId)
OdDbStub *	background () const
void	setVisualStyle (OdDbStub *visualStyleId)
OdDbStub *	visualStyle () const
void	setVisualStyle (const OdGiVisualStyle &visualStyle)
bool	visualStyle (OdGiVisualStyle &visualStyle) const
const OdGiDrawable *	visualStyleDrawable () const
virtual bool	makeStock (OdDbStub *layoutId)
virtual void	releaseStock (OdDbStub *layoutId)
bool	hasChangedLayers () const
void	addModelReactor (OdGsModelReactor *pReactor)
void	removeModelReactor (OdGsModelReactor *pReactor)
void	setEnableSectioning (bool bEnable)
bool	isSectioningEnabled () const
bool	setSectioning (const OdGePoint3dArray &points, const OdGeVector3d &upVector)
bool	setSectioning (const OdGePoint3dArray &points, const OdGeVector3d &upVector, double dTop, double dBottom)
void	setSectioningVisualStyle (OdDbStub *visualStyleId)
const SectioningSettings &	getSectioning () const
void	setViewClippingOverride (bool bEnable)
bool	isViewClippingOverride () const
void	setEnableLinetypes (bool bEnable)
bool	isLinetypesEnabled () const
void	setSelectable (bool bEnable)
bool	isSelectable () const
void	setEnableLightsInBlocks (bool bEnable)
bool	isLightsInBlocksEnabled () const
virtual bool	saveModelState (OdGsFiler *pFiler, OdGsBaseVectorizer *pVectorizer=NULL) const
virtual bool	loadModelState (OdGsFiler *pFiler, OdGsBaseVectorizer *pVectorizer=NULL)
virtual bool	saveClientModelState (OdGsFiler *pFiler) const
virtual bool	loadClientModelState (OdGsFiler *pFiler)
bool	postprocessModelLoading (OdGsFiler *pFiler)
virtual OdGsNode *	newNode (ENodeType ntp, const OdGiDrawable *drawable, bool bSetGsNode)
Public Member Functions inherited from OdGsModel
	ODRX_DECLARE_MEMBERS (OdGsModel)
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

Public Attributes
unsigned	m_nMfCached
unsigned	m_nMfReused
OdArray< ViewRef, OdMemoryAllocator< ViewRef > >	m_views
OdArray< ModuleRef, OdMemoryAllocator< ModuleRef > >	m_modules

Protected Types
enum	GsModelFlags {   kCheckFaded = (1 << 0), kEnableLinetypes = (1 << 1), kModelSelectable = (1 << 2), kLightsInBlocks = (1 << 3),   kSkipViewClip = (1 << 4), kIdentityXform = (1 << 5) }

Protected Member Functions
void	addNode (OdGsNode *pNode)
void	addViewRef (OdGsViewImpl *pView)
void	removeViewRef (OdGsViewImpl *pView)
void	setInvalidVp (unsigned int viewportId, bool val)
virtual void	clearChangedLayersList ()
	OdGsBaseModel ()
	~OdGsBaseModel ()
void	onModifiedNode (OdGsNode *pCache, OdGiDrawable *pDrawable, OdGiDrawable *pParent)
void	onModifiedDrawable (OdGiDrawable *pDrawable, OdGiDrawable *pParent)
void	onPropertyModifiedImpl (OdGsBaseModelReactor::ModelProperty nProp, bool &bReturnValue)
virtual bool	onPropertyModified (OdGsBaseModelReactor::ModelProperty nProp)

Protected Attributes
OdGiOpenDrawableFn	m_openDrawableFn
OdGsNode *	m_aNodes [kLastNodeType]
OdUInt32	m_gsModelFlags
OdArray< ViewProps >	m_viewProps
OdUInt32	m_nLayers
OdGsLayerNode *	m_pFirstChangedLayer
OdGsView::RenderMode	m_renderModeOverride
OdGeMatrix3d	m_xForm
OdDbStub *	m_modelBackground
OdDbStub *	m_modelVisualStyle
OdGiDrawablePtr	m_pTransVisualStyle
RenderType	m_renderType
OdRxObjectPtr	m_pGsReserved
OdGsMaterialCachePtr	m_pMaterialCache
OdGsBaseModelImpl *	m_impl
SectioningSettings	m_sectioning
OdVector< OdGsModelReactor *, OdMemoryAllocator< OdGsModelReactor * > >	m_modelReactors
OdVector< OdGsBaseModelReactor *, OdMemoryAllocator< OdGsBaseModelReactor * > >	m_baseModelReactors

Friends
class	CFxGsExtension
class	OdGsNode
class	OdGsViewImpl
class	OdGsBaseVectorizer
class	OdGsBaseVectorizeDevice
GS_TOOLKIT_EXPORT OdGiDrawablePtr	fxOpenDrawable (OdGsBaseModel *, OdDbStub *)

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

Detailed Description

This class is the base class for custom GsBaseModel objects which coordinate custom caching support for Teigha vectorization applications.

Remarks

Clients should derive their custom model classes from this class.

Corresponding C++ library: TD_Gs <group OdGs_Classes>

Definition at line 117 of file GsBaseModel.h.

Member Typedef Documentation

ModuleRef

typedef std::pair<const OdGsBaseModule*, OdUInt32> OdGsBaseModel::ModuleRef

Definition at line 167 of file GsBaseModel.h.

ViewRef

typedef std::pair<OdGsViewImpl*, OdUInt32> OdGsBaseModel::ViewRef

Definition at line 165 of file GsBaseModel.h.

Member Enumeration Documentation

AdditionMode

enum OdGsBaseModel::AdditionMode

Enumerator
kAddDrawable
kUneraseDrawable

Definition at line 294 of file GsBaseModel.h.

GsModelFlags

enum OdGsBaseModel::GsModelFlags

protected

Enumerator
kCheckFaded
kEnableLinetypes
kModelSelectable
kLightsInBlocks
kSkipViewClip
kIdentityXform

Definition at line 147 of file GsBaseModel.h.

Constructor & Destructor Documentation

OdGsBaseModel()

OdGsBaseModel::OdGsBaseModel ( )

protected

~OdGsBaseModel()

OdGsBaseModel::~OdGsBaseModel ( )

protected

Member Function Documentation

additionMode()

AdditionMode OdGsBaseModel::additionMode

(

)

const

addModelReactor()

void OdGsBaseModel::addModelReactor ( OdGsModelReactor *  pReactor )

virtual

Adds a model reactor for this Model object.

Parameters

pReactor

[in] Model reactor

Implements OdGsModel.

addNode()

void OdGsBaseModel::addNode ( OdGsNode *  pNode )

protected

Adds the specified Node object to this BaseModel object.

Parameters

pNode

[in] Pointer to the Node to be added.

addViewRef()

void OdGsBaseModel::addViewRef ( OdGsViewImpl *  pView )

protected

background()

OdDbStub* OdGsBaseModel::background ( ) const

virtual

Returns the OdDbBackground object ID if the background was set to this Model object.

Implements OdGsModel.

checkFaded()

bool OdGsBaseModel::checkFaded ( ) const

inline

Definition at line 158 of file GsBaseModel.h.

clearChangedLayersList()

virtual void OdGsBaseModel::clearChangedLayersList ( )

protectedvirtual

detach()

virtual void OdGsBaseModel::detach ( OdGsNode *  pNode )

virtual

Removes the associations between the specified Node object and this BaseModel object.

Parameters

pNode

[in] Pointer to the Node object.

detachAll()

virtual void OdGsBaseModel::detachAll ( )

virtual

Removes all Node objects from this BaseModel object.

detachAllFromDb()

void OdGsBaseModel::detachAllFromDb

(

const OdDbBaseDatabase *

pDb

)

getSectioning()

const SectioningSettings& OdGsBaseModel::getSectioning ( ) const

inline

Definition at line 398 of file GsBaseModel.h.

getViewProps()

const ViewPropsArray& OdGsBaseModel::getViewProps ( ) const

inline

Definition at line 169 of file GsBaseModel.h.

gsLayerNode()

virtual OdGsLayerNode* OdGsBaseModel::gsLayerNode ( OdDbStub *  layerId, const OdGsBaseVectorizer *  pView  )

virtual

gsNode()

virtual OdGsNode* OdGsBaseModel::gsNode ( OdGiDrawable *  pDrawable )

virtual

Returns the OdGsNode object associated with the specified Drawable.

Parameters

pDrawable

[in] Pointer to the Drawable object.

Remarks

If no Node object is associated with the Drawable object, one is created.

hasChangedLayers()

bool OdGsBaseModel::hasChangedLayers ( ) const

inline

Definition at line 387 of file GsBaseModel.h.

highlight()

void OdGsBaseModel::highlight ( const OdGiPathNode &  path, bool  bDoIt = true, const OdGsView *  pView = NULL  )

virtual

Highlights the specified entity in this Model object.

Parameters

path	[in] Path to the entity for highlighting.
bDoIt	[in] Flag that indicates whether highlighting is enabled (true value) or disabled (false value).
pView	[in] Pointer to the view where the specified entity should be highlighted.

Implements OdGsModel.

highlightImpl()

virtual void OdGsBaseModel::highlightImpl ( const OdGiPathNode &  path, bool  bDoIt = true, const OdGsView *  pView = NULL  )

virtual

impl()

OdGsBaseModelImpl* OdGsBaseModel::impl ( )

inline

Definition at line 189 of file GsBaseModel.h.

invalidate() [1/3]

void OdGsBaseModel::invalidate ( InvalidationHint  hint )

virtual

Invalidates the specified cached data contained in this Model object.

Parameters

hint	[in] Invalidation hint.

Remarks

Hint must be one of the following:

Value kInvalidateIsolines 0 kInvalidateViewportCache 1 kInvalidateAll 2 kInvalidateMaterials 3 kInvalidateLinetypes 4

Implements OdGsModel.

invalidate() [2/3]

void OdGsBaseModel::invalidate ( OdGsView *  pView )

virtual

Invalidates cached data associated with the specified View object.

Parameters

pView

[in] Pointer to the OdGsView object for which data is to be invalidated.

Implements OdGsModel.

invalidate() [3/3]

void OdGsBaseModel::invalidate	(	OdGsViewImpl &	view,
		OdUInt32	mask
	)

Parameters

view	[in] BaseVectorizeView object for which data are to be invalidated.
mask	[in] Mask.

invalidateEntRect() [1/2]

virtual void OdGsBaseModel::invalidateEntRect ( OdGiDrawable *  pDrawable, OdGiDrawable *  pParent, bool  bForceIfNoExtents = false  )

virtual

invalidateEntRect() [2/2]

virtual void OdGsBaseModel::invalidateEntRect ( OdGsEntityNode *  pNode, OdGsContainerNode *  pParent, bool  bForceIfNoExtents  )

virtual

invalidateRegenDrawBlocks()

void OdGsBaseModel::invalidateRegenDrawBlocks	(	OdGsViewImpl &	view,
		const OdDbStub *	layoutId
	)

invalidateSectionableBlocks()

void OdGsBaseModel::invalidateSectionableBlocks

(

)

invalidateVisible()

void OdGsBaseModel::invalidateVisible ( OdGsDevice *  pDevice )

virtual

Invalidates cached data that visible on the device.

Parameters

pView

[in] Pointer to the OdGsDevice object for which data is to be invalidated.

Implements OdGsModel.

invalidVp()

bool OdGsBaseModel::invalidVp ( unsigned int  viewportId ) const

inline

For internal needs. Do not use!

Definition at line 182 of file GsBaseModel.h.

isIdentityTransform()

bool OdGsBaseModel::isIdentityTransform ( ) const

inline

Definition at line 479 of file GsBaseModel.h.

isLightsInBlocksEnabled()

bool OdGsBaseModel::isLightsInBlocksEnabled ( ) const

virtual

Returns true if lights in blocks are enabled or returns false in the other case.

Implements OdGsModel.

isLinetypesEnabled()

bool OdGsBaseModel::isLinetypesEnabled ( ) const

virtual

Returns true if the linetype display is enabled or returns false in the other case.

Implements OdGsModel.

isSectioningEnabled()

bool OdGsBaseModel::isSectioningEnabled ( ) const

virtual

Returns true if the sectioning is active in the views displaying this Model object. Returns false in the other case.

Implements OdGsModel.

isSelectable()

bool OdGsBaseModel::isSelectable ( ) const

virtual

Checks whether this Model object is selected. If the returning value is true, the Model object is selectable. If the returning value is false, the Model object is not selectable.

Implements OdGsModel.

isViewClippingOverride()

bool OdGsBaseModel::isViewClippingOverride ( ) const

inline

Definition at line 431 of file GsBaseModel.h.

isViewPropsValid()

virtual bool OdGsBaseModel::isViewPropsValid ( OdUInt32  viewportId ) const

virtual

loadClientModelState()

virtual bool OdGsBaseModel::loadClientModelState ( OdGsFiler *  pFiler )

virtual

loadModelState()

virtual bool OdGsBaseModel::loadModelState ( OdGsFiler *  pFiler, OdGsBaseVectorizer *  pVectorizer = NULL  )

virtual

makeStock()

virtual bool OdGsBaseModel::makeStock ( OdDbStub *  layoutId )

virtual

materialCache()

OdGsMaterialCache* OdGsBaseModel::materialCache ( )

inline

Definition at line 367 of file GsBaseModel.h.

newNode()

virtual OdGsNode* OdGsBaseModel::newNode ( ENodeType  ntp, const OdGiDrawable *  drawable, bool  bSetGsNode  )

virtual

numViewProps()

OdUInt32 OdGsBaseModel::numViewProps ( ) const

inline

Returns the size of the ViewProperties array for this BaseModel object.

Definition at line 451 of file GsBaseModel.h.

onAdded() [1/2]

void OdGsBaseModel::onAdded ( OdGiDrawable *  pAdded, OdDbStub *  parentID  )

virtual

Notification function called whenever a drawable object is added to this Model object.

Parameters

pAdded	[in] Pointer to the added Drawable object.
parentID	[in] Object ID of the parent of the added Drawable object.

Implements OdGsModel.

onAdded() [2/2]

void OdGsBaseModel::onAdded ( OdGiDrawable *  pAdded, OdGiDrawable *  pParent  )

virtual

Notification function called whenever a drawable object is added to this Model object.

Parameters

pAdded	[in] Pointer to the added Drawable object.
pParent	[in] Pointer to the parent of the added Drawable object.

Implements OdGsModel.

onAddedImpl()

virtual void OdGsBaseModel::onAddedImpl ( OdGiDrawable *  pAdded, OdGiDrawable *  pParent, AdditionMode  additionMode = kAddDrawable  )

virtual

onErased() [1/2]

void OdGsBaseModel::onErased ( OdGiDrawable *  pErased, OdDbStub *  parentID  )

virtual

Notification function called whenever a drawable object is erased from this Model object.

Parameters

pErased	[in] Pointer to the erased Drawable object.
parentID	[in] Object ID of the parent of the erased Drawable object.

Implements OdGsModel.

onErased() [2/2]

void OdGsBaseModel::onErased ( OdGiDrawable *  pErased, OdGiDrawable *  pParent  )

virtual

Notification function called whenever a drawable object is erased from this Model object.

Parameters

pErased	[in] Pointer to the erased Drawable object.
pParent	[in] Pointer to the parent of the erased Drawable object.

Implements OdGsModel.

onErasedImpl()

virtual void OdGsBaseModel::onErasedImpl ( OdGiDrawable *  pErased, OdGiDrawable *  pParent  )

virtual

onModified() [1/2]

void OdGsBaseModel::onModified ( OdGiDrawable *  pModified, OdDbStub *  parentID  )

virtual

Notification function called whenever a drawable object is modified in this Model object.

Parameters

pModified	[in] Pointer to the modified Drawable object.
parentID	[in] Object ID of the parent of the modified Drawable object.

Implements OdGsModel.

onModified() [2/2]

void OdGsBaseModel::onModified ( OdGiDrawable *  pModified, OdGiDrawable *  pParent  )

virtual

Notification function called whenever a drawable object is modified in this Model object.

Parameters

pModified	[in] Pointer to the modified Drawable object.
pParent	[in] Pointer to the parent of the modified Drawable object.

Implements OdGsModel.

onModifiedDrawable()

void OdGsBaseModel::onModifiedDrawable ( OdGiDrawable *  pDrawable, OdGiDrawable *  pParent  )

protected

onModifiedImpl()

virtual void OdGsBaseModel::onModifiedImpl ( OdGiDrawable *  pModified, OdGiDrawable *  pParent  )

virtual

onModifiedNode()

void OdGsBaseModel::onModifiedNode ( OdGsNode *  pCache, OdGiDrawable *  pDrawable, OdGiDrawable *  pParent  )

protected

onPropertyModified()

virtual bool OdGsBaseModel::onPropertyModified ( OdGsBaseModelReactor::ModelProperty  nProp )

protectedvirtual

onPropertyModifiedImpl()

void OdGsBaseModel::onPropertyModifiedImpl ( OdGsBaseModelReactor::ModelProperty  nProp, bool &  bReturnValue  )

protected

onUnerased() [1/2]

void OdGsBaseModel::onUnerased ( OdGiDrawable *  pUnerased, OdDbStub *  parentID  )

virtual

Notification function called whenever a drawable object is unerased in this Model object.

Parameters

pUnerased	[in] Pointer to the unerased Drawable object.
parentID	[in] Object ID of the parent of the unerased Drawable object.

Reimplemented from OdGsModel.

onUnerased() [2/2]

void OdGsBaseModel::onUnerased ( OdGiDrawable *  pUnerased, OdGiDrawable *  pParent  )

virtual

Notification function called whenever a drawable object is unerased in this Model object.

Parameters

pUnerased	[in] Pointer to the unerased Drawable object.
pParent	[in] Pointer to the parent of the unerased Drawable object.

Reimplemented from OdGsModel.

open()

OdGiDrawablePtr OdGsBaseModel::open ( OdDbStub *  objectId )

inline

Opens the specified object.

Parameters

objectID

[in] Object ID of the Drawable object to be opened.

Returns

Returns a SmartPointer to the opened object.

Definition at line 438 of file GsBaseModel.h.

openDrawableFn()

OdGiOpenDrawableFn OdGsBaseModel::openDrawableFn

(

)

const

postprocessModelLoading()

bool OdGsBaseModel::postprocessModelLoading

(

OdGsFiler *

pFiler

)

propagateLayerChanges()

virtual void OdGsBaseModel::propagateLayerChanges ( OdGsBaseVectorizeDevice &  device )

virtual

refDevice()

OdGsBaseVectorizeDevice* OdGsBaseModel::refDevice

(

)

const

refModulesCount()

OdUInt32 OdGsBaseModel::refModulesCount ( ) const

inline

Definition at line 172 of file GsBaseModel.h.

refView()

OdGsViewImpl * OdGsBaseModel::refView ( ) const

inline

Definition at line 467 of file GsBaseModel.h.

releaseStock()

virtual void OdGsBaseModel::releaseStock ( OdDbStub *  layoutId )

virtual

removeModelReactor()

void OdGsBaseModel::removeModelReactor ( OdGsModelReactor *  pReactor )

virtual

Removes the specified model reactor from this Model object.

Parameters

pReactor

[in] Pointer to the model reactor that should be removed

Implements OdGsModel.

removeViewRef()

void OdGsBaseModel::removeViewRef ( OdGsViewImpl *  pView )

protected

renderModeOverride()

OdGsView::RenderMode OdGsBaseModel::renderModeOverride ( ) const

inline

Definition at line 426 of file GsBaseModel.h.

renderType()

OdGsModel::RenderType OdGsBaseModel::renderType ( ) const

inlinevirtual

Returns the render type of this Model object.

Implements OdGsModel.

Definition at line 474 of file GsBaseModel.h.

saveClientModelState()

virtual bool OdGsBaseModel::saveClientModelState ( OdGsFiler *  pFiler ) const

virtual

saveModelState()

virtual bool OdGsBaseModel::saveModelState ( OdGsFiler *  pFiler, OdGsBaseVectorizer *  pVectorizer = NULL  ) const

virtual

setAdditionMode()

void OdGsBaseModel::setAdditionMode

(

AdditionMode

mode

)

setBackground()

void OdGsBaseModel::setBackground ( OdDbStub *  backgroundId )

virtual

Sets the background of this Model object.

Parameters

backgroundId

[in] OdDbBackground object ID.

Implements OdGsModel.

setCheckFaded()

void OdGsBaseModel::setCheckFaded ( bool  bOn )

inline

Definition at line 159 of file GsBaseModel.h.

setEnableLightsInBlocks()

void OdGsBaseModel::setEnableLightsInBlocks ( bool  bEnable )

virtual

Enables or disables lights in blocks.

Parameters

bEnable

[in] Boolean flag which enables (true value) or disables (false value) lights in blocks.

Implements OdGsModel.

setEnableLinetypes()

void OdGsBaseModel::setEnableLinetypes ( bool  bEnable )

virtual

Enables or disables linetype display in any OdGsView object that views this Model object.

Parameters

bEnable

[in] Boolean flag which enables (true value) or disables (false value) linetype display.

Implements OdGsModel.

setEnableSectioning()

void OdGsBaseModel::setEnableSectioning ( bool  bEnable )

virtual

Enables the currently specified sectioning in the views displaying this Model object.

Parameters

bEnable

[in] Boolean flag which indicates whether sectioning should be enabled

Implements OdGsModel.

setInvalidVp()

void OdGsBaseModel::setInvalidVp ( unsigned int  viewportId, bool  val  )

inlineprotected

For internal needs. Do not use!

Definition at line 217 of file GsBaseModel.h.

setOpenDrawableFn()

void OdGsBaseModel::setOpenDrawableFn ( OdGiOpenDrawableFn  openDrawableFn )

virtual

Specifies the function called for drawable object open by this Model object.

Parameters

openDrawableFn

[in] Function to be called.

Implements OdGsModel.

setRenderModeOverride()

void OdGsBaseModel::setRenderModeOverride ( OdGsView::RenderMode  mode = OdGsView::kNone )

virtual

Sets the specified rendering mode override for this Model object.

Parameters

mode	[in] Render mode override.

Remarks

Rendering mode specified as OdGsView::kNone cancels currently set rendering mode override.

Implements OdGsModel.

setRenderType()

void OdGsBaseModel::setRenderType ( RenderType  renderType )

virtual

Sets the render type for this Model object.

Parameters

renderType

[in] Render type.

Implements OdGsModel.

setSectioning() [1/2]

bool OdGsBaseModel::setSectioning ( const OdGePoint3dArray &  points, const OdGeVector3d &  upVector  )

virtual

Sets the active sectioning for this Model object. After specifying the sectioning, it should be enabled by the setEnableSectioning() method.

Parameters

points	[in] Array of co-planar points specifying a sectioning region
upVector	[in] Vector that specifies the orientation of the plane that contains points

Remarks

If the last point of the points array is equal to the first point of this array, the sectioning region is closed. The upVector is used to specify the clipped and unclipped sides of the sectioning. The unclipped side is determined by the direction of the cross product of the first line segment defined by the point array, and the upVector.

Implements OdGsModel.

setSectioning() [2/2]

bool OdGsBaseModel::setSectioning ( const OdGePoint3dArray &  points, const OdGeVector3d &  upVector, double  dTop, double  dBottom  )

virtual

Sets the active sectioning for this Model object. The sectioning is capped vertically using the specified top and bottom heights. After specifying the sectioning, it should be enabled by the setEnableSectioning() method.

Parameters

points	[in] Array of co-planar points specifying a sectioning region
upVector	[in] Vector that specifies the orientation of the plane that contains points
dTop	[in] Specifies the top capping height of the sectioning
dBottom	[in] Specifies the bottom capping height of the sectioning

Returns

Returns true if the specified sectioning is valid. Returns false if the specified sectioning is invalid or malformed.

Remarks

If the last point of the points array is equal to the first point of this array, the sectioning region is closed. The upVector is used to specify the clipped and unclipped sides of the sectioning. The unclipped side is determined by the direction of the cross product of the first line segment defined by the point array, and the upVector.

Implements OdGsModel.

setSectioningVisualStyle()

void OdGsBaseModel::setSectioningVisualStyle ( OdDbStub *  visualStyleId )

virtual

Sets the visual style for the objects on the clipped side of the sectioning.

Parameters

visualStyleId

[in] Visual style object ID. Null by default.

Remarks

If the input parameter is a null object ID, the clipped side should not be drawn.

Implements OdGsModel.

setSelectable()

void OdGsBaseModel::setSelectable ( bool  bEnable )

virtual

Enables or disables the ability to select this Model object. If the input value is true, the Model object is selectable. If the input value is false, the Model object is unselectable.

Parameters

bEnable

[in] Boolean flag which indicates whether this Model object is selectable

Implements OdGsModel.

setTransform()

void OdGsBaseModel::setTransform ( const OdGeMatrix3d &  )

virtual

Transforms this Model object by applying the specified transformation matrix to the model contents.

Parameters

OdGeMatrix3d

[in] Transformation matrix.

Implements OdGsModel.

setViewClippingOverride()

void OdGsBaseModel::setViewClippingOverride ( bool  bEnable )

virtual

Enables this model's geometry to ignore the view's front and back clipping planes (if any) and viewport 3d clipping (if set). If the method's input value is false, the view's clipping planes and viewport 3d clipping are allowed by this Model object.

Parameters

bEnable

[in] Boolean flag which indicates that the model ignores the view's clipping planes and viewport 3d clipping (true value).

Implements OdGsModel.

setVisualStyle() [1/2]

void OdGsBaseModel::setVisualStyle ( const OdGiVisualStyle &  visualStyle )

virtual

Sets the visual style for this Model object. This method is used to direct views to display the model in the specified visual style. By default, models are displayed in the visual style assigned to the view.

Parameters

visualStyle

[in] Visual style object

Implements OdGsModel.

setVisualStyle() [2/2]

void OdGsBaseModel::setVisualStyle ( OdDbStub *  visualStyleId )

virtual

Sets the visual style for this Model object. This method is used to direct views to display the model in the specified visual style. By default, models are displayed in the visual style assigned to the view.

Parameters

visualStyleId

[in] Visual style object ID used by objects in this model

Remarks

Specify the OdDbObjectId::kNull as an input value to clear the model's visual style and use the view visual style for displaying the model's objects.

Implements OdGsModel.

transform()

OdGeMatrix3d OdGsBaseModel::transform ( ) const

virtual

Obtains the current transformation matrix of this Model object.

Implements OdGsModel.

updateViewProps()

virtual void OdGsBaseModel::updateViewProps ( const OdGsViewImpl &  viewport )

virtual

Updates the ViewProps structure for the specified Viewport.

Parameters

viewport

[in] Viewport.

viewChanges()

OdUInt32 OdGsBaseModel::viewChanges ( OdUInt32  viewportId ) const

inline

Returns the view properties that have changed for the specified Viewport

Parameters

viewportId

[in] Viewport ID.

Definition at line 462 of file GsBaseModel.h.

viewProps()

const ViewProps & OdGsBaseModel::viewProps ( OdUInt32  viewportId ) const

inline

Returns a reference to the the ViewProp structure for the specified Viewport.

Parameters

viewportId

[in] Viewport ID.

Definition at line 456 of file GsBaseModel.h.

visualStyle() [1/2]

OdDbStub* OdGsBaseModel::visualStyle ( ) const

virtual

Returns the visual style of this Model object.

Implements OdGsModel.

visualStyle() [2/2]

bool OdGsBaseModel::visualStyle ( OdGiVisualStyle &  visualStyle ) const

virtual

Returns the visual style of this Model object.

Parameters

visualStyle

[out] Visual style

Returns

Returns true if the visual style is set for the model, false otherwise.

Implements OdGsModel.

visualStyleDrawable()

const OdGiDrawable * OdGsBaseModel::visualStyleDrawable ( ) const

inline

Definition at line 484 of file GsBaseModel.h.

Friends And Related Function Documentation

CFxGsExtension

friend class CFxGsExtension

friend

Definition at line 120 of file GsBaseModel.h.

fxOpenDrawable

GS_TOOLKIT_EXPORT OdGiDrawablePtr fxOpenDrawable ( OdGsBaseModel *  , OdDbStub *    )

friend

OdGsBaseVectorizeDevice

friend class OdGsBaseVectorizeDevice

friend

Definition at line 130 of file GsBaseModel.h.

OdGsBaseVectorizer

friend class OdGsBaseVectorizer

friend

Definition at line 129 of file GsBaseModel.h.

OdGsNode

friend class OdGsNode

friend

Definition at line 127 of file GsBaseModel.h.

OdGsViewImpl

friend class OdGsViewImpl

friend

Definition at line 128 of file GsBaseModel.h.

Member Data Documentation

m_aNodes

OdGsNode* OdGsBaseModel::m_aNodes[kLastNodeType]

protected

Definition at line 125 of file GsBaseModel.h.

m_baseModelReactors

OdVector<OdGsBaseModelReactor*, OdMemoryAllocator<OdGsBaseModelReactor*> > OdGsBaseModel::m_baseModelReactors

protected

Definition at line 252 of file GsBaseModel.h.

m_gsModelFlags

OdUInt32 OdGsBaseModel::m_gsModelFlags

protected

Definition at line 156 of file GsBaseModel.h.

m_impl

OdGsBaseModelImpl* OdGsBaseModel::m_impl

protected

Definition at line 243 of file GsBaseModel.h.

m_modelBackground

OdDbStub* OdGsBaseModel::m_modelBackground

protected

Definition at line 232 of file GsBaseModel.h.

m_modelReactors

OdVector<OdGsModelReactor*, OdMemoryAllocator<OdGsModelReactor*> > OdGsBaseModel::m_modelReactors

protected

Definition at line 251 of file GsBaseModel.h.

m_modelVisualStyle

OdDbStub* OdGsBaseModel::m_modelVisualStyle

protected

Definition at line 233 of file GsBaseModel.h.

m_modules

OdArray<ModuleRef, OdMemoryAllocator<ModuleRef> > OdGsBaseModel::m_modules

Definition at line 168 of file GsBaseModel.h.

m_nLayers

OdUInt32 OdGsBaseModel::m_nLayers

protected

Definition at line 227 of file GsBaseModel.h.

m_nMfCached

unsigned OdGsBaseModel::m_nMfCached

Definition at line 143 of file GsBaseModel.h.

m_nMfReused

unsigned OdGsBaseModel::m_nMfReused

Definition at line 144 of file GsBaseModel.h.

m_openDrawableFn

OdGiOpenDrawableFn OdGsBaseModel::m_openDrawableFn

protected

Definition at line 124 of file GsBaseModel.h.

m_pFirstChangedLayer

OdGsLayerNode* OdGsBaseModel::m_pFirstChangedLayer

protected

Definition at line 228 of file GsBaseModel.h.

m_pGsReserved

OdRxObjectPtr OdGsBaseModel::m_pGsReserved

protected

Definition at line 238 of file GsBaseModel.h.

m_pMaterialCache

OdGsMaterialCachePtr OdGsBaseModel::m_pMaterialCache

protected

Definition at line 241 of file GsBaseModel.h.

m_pTransVisualStyle

OdGiDrawablePtr OdGsBaseModel::m_pTransVisualStyle

protected

Definition at line 234 of file GsBaseModel.h.

m_renderModeOverride

OdGsView::RenderMode OdGsBaseModel::m_renderModeOverride

protected

Definition at line 230 of file GsBaseModel.h.

m_renderType

RenderType OdGsBaseModel::m_renderType

protected

Definition at line 236 of file GsBaseModel.h.

m_sectioning

SectioningSettings OdGsBaseModel::m_sectioning

protected

Definition at line 245 of file GsBaseModel.h.

m_viewProps

OdArray<ViewProps> OdGsBaseModel::m_viewProps

protected

Definition at line 226 of file GsBaseModel.h.

m_views

OdArray<ViewRef, OdMemoryAllocator<ViewRef> > OdGsBaseModel::m_views

Definition at line 166 of file GsBaseModel.h.

m_xForm

OdGeMatrix3d OdGsBaseModel::m_xForm

protected

Definition at line 231 of file GsBaseModel.h.

---

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

• GsBaseModel.h