#include <DbModelDocViewStyle.h>

Inheritance diagram for OdDbModelDocViewStyle:

Public Types
enum	AttachmentPoint { kAboveView = 0 , kBelowView = 1 }

enum	TextAlignment { kTextAlignmentLeft = 0 , kTextAlignmentCenter = 1 , kTextAlignmentRight = 2 }

Public Types inherited from OdGiDrawable
enum	SetAttributesFlags { kDrawableNone = 0 , kDrawableIsAnEntity = 1 , kDrawableUsesNesting = 2 , kDrawableIsCompoundObject = 4 , kDrawableViewIndependentViewportDraw = 8 , kDrawableIsInvisible = 16 , kDrawableHasAttributes = 32 , kDrawableRegenTypeDependantGeometry = 64 , kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128) , kDrawableRegenDraw = 256 , kDrawableStandardDisplaySingleLOD = 512 , kDrawableShadedDisplaySingleLOD = 1024 , kDrawableViewDependentViewportDraw = 2048 , kDrawableBlockDependentViewportDraw = 4096 , kDrawableIsExternalReference = 8192 , kDrawableNotPlottable = 16384 , kDrawableNotAllowLCS = 32768 , kDrawableMergeControlOff = 65536 , kLastFlag = kDrawableMergeControlOff }

enum	DrawableType { kGeometry = 0 , kDistantLight = 1 , kPointLight = 2 , kSpotLight = 3 , kAmbientLight , kSolidBackground , kGradientBackground , kImageBackground , kGroundPlaneBackground , kViewport , kWebLight , kSkyBackground , kImageBasedLightingBackground , kEnvironmentBackground = 16 , kCustomBackground }

Public Member Functions
	ODDB_DECLARE_MEMBERS (OdDbModelDocViewStyle)

virtual	~OdDbModelDocViewStyle ()=0

virtual OdString	getName () const

virtual void	setName (const OdString &name)

virtual OdString	description () const

virtual void	setDescription (const OdString &description)

virtual void	setDatabaseDefaults (OdDbDatabase *pDb)

virtual OdDbObjectId	postViewStyleToDb (OdDbDatabase *pDb, const OdString &styleName)=0

bool	isModifiedForRecompute () const

OdString	defaultViewName (int index) const

bool	isViewNameValid (const OdString &name) const

OdString	getDisplayName () const

OdResult	setDispayName (const OdString &name)

bool	canRename () const

OdResult	setCanRename (bool canRename)

virtual OdDbObjectId	viewLabelTextStyleId () const =0

virtual OdCmColor	viewLabelTextColor () const =0

virtual double	viewLabelTextHeight () const =0

virtual double	viewLabelOffset () const =0

virtual AttachmentPoint	viewLabelAttachment () const =0

virtual TextAlignment	viewLabelAlignment () const =0

virtual OdString	viewLabelPattern () const =0

Public Member Functions inherited from OdDbObject
	ODDB_DECLARE_MEMBERS (OdDbObject)

	~OdDbObject ()

virtual void	addRef () override

virtual void	release () ODRX_NOEXCEPT override

virtual long	numRefs () const override

OdDbObjectId	objectId () const

OdDbHandle	getDbHandle () const

OdDbHandle	handle () const

OdDbObjectId	ownerId () const

virtual void	setOwnerId (OdDbObjectId ownerId)

OdDbDatabase *	database () const

void	createExtensionDictionary ()

OdDbObjectId	extensionDictionary () const

bool	releaseExtensionDictionary ()

OdDbXrecordPtr	createXrecord (const OdString &xrecordName, OdDb::DuplicateRecordCloning style=OdDb::kDrcIgnore)

void	upgradeOpen ()

void	downgradeOpen ()

void	cancel ()

virtual void	subClose ()

OdResult	erase (bool eraseIt=true)

virtual OdResult	subErase (bool erasing)

void	handOverTo (OdDbObject *pNewObject, bool keepXData=true, bool keepExtDict=true)

virtual void	subHandOverTo (OdDbObject *pNewObject)

void	swapIdWith (OdDbObjectId otherId, bool swapXdata=false, bool swapExtDict=false)

virtual void	subSwapIdWith (const OdDbObjectId &otherId, bool swapXdata=false, bool swapExtDict=false)

virtual void	audit (OdDbAuditInfo *pAuditInfo)

void	dwgIn (OdDbDwgFiler *pFiler)

void	dwgOut (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfIn (OdDbDxfFiler *pFiler)

virtual void	dxfOut (OdDbDxfFiler *pFiler) const

virtual OdResult	dxfInFields_R12 (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields_R12 (OdDbDxfFiler *pFiler) const

virtual OdDb::DuplicateRecordCloning	mergeStyle () const

virtual OdResBufPtr	xData (const OdString &regappName=OdString::kEmpty) const

virtual void	setXData (const OdResBuf *pRb)

bool	hasXData (const OdChar *regappName=nullptr) const

bool	isEraseStatusToggled () const

bool	isErased () const

bool	isReadEnabled () const

bool	isWriteEnabled () const

bool	isNotifyEnabled () const

bool	isModified () const

bool	isModifiedXData () const

bool	isModifiedGraphics () const

bool	isNewObject () const

bool	isNotifying () const

bool	isUndoing () const

bool	isReallyClosing () const

bool	isDBRO () const

void	assertReadEnabled () const

void	assertWriteEnabled (bool autoUndo=true, bool recordModified=true)

void	assertNotifyEnabled () const

void	disableUndoRecording (bool disable)

bool	isUndoRecordingDisabled () const

OdDbDwgFiler *	undoFiler ()

virtual void	applyPartialUndo (OdDbDwgFiler pUndoFiler, OdRxClass pClassObj)

void	addReactor (OdDbObjectReactor *pReactor) const

void	removeReactor (OdDbObjectReactor *pReactor) const

virtual void	addPersistentReactor (const OdDbObjectId &objId)

virtual void	removePersistentReactor (const OdDbObjectId &objId)

bool	hasPersistentReactor (const OdDbObjectId &objId) const

OdDbObjectIdArray	getPersistentReactors () const

OdDbObjectReactorArray	getTransientReactors () const

virtual void	recvPropagateModify (const OdDbObject *pSubObj)

virtual void	xmitPropagateModify () const

ODRX_SEALED_VIRTUAL OdDbObjectPtr	deepClone (OdDbIdMapping &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_FINAL

ODRX_SEALED_VIRTUAL OdDbObjectPtr	wblockClone (OdDbIdMapping &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_FINAL

virtual void	appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &idMap)

void	setOdDbObjectIdsInFlux ()

bool	isOdDbObjectIdsInFlux () const

virtual void	copied (const OdDbObject pObject, const OdDbObject pNewObject)

virtual void	erased (const OdDbObject *pObject, bool erasing=true)

virtual void	goodbye (const OdDbObject *pObject)

virtual void	openedForModify (const OdDbObject *pObject)

virtual void	modified (const OdDbObject *pObject)

virtual void	subObjModified (const OdDbObject pObject, const OdDbObject pSubObj)

virtual void	modifyUndone (const OdDbObject *pObject)

virtual void	modifiedXData (const OdDbObject *pObject)

virtual void	unappended (const OdDbObject *pObject)

virtual void	reappended (const OdDbObject *pObject)

bool	isAProxy () const

virtual void	objectClosed (const OdDbObjectId &objectId)

virtual void	modifiedGraphics (const OdDbObject *pObject)

virtual void	copyFrom (const OdRxObject *pSource)

bool	hasSaveVersionOverride () const

void	setHasSaveVersionOverride (bool hasSaveVersionOverride)

virtual OdDb::DwgVersion	getObjectSaveVersion (const OdDbFiler pFiler, OdDb::MaintReleaseVer pMaintVer=0) const

virtual OdDbObjectPtr	decomposeForSave (OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)

virtual OdDbObjectPtr	decomposeForSave (OdDb::SaveType format, OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)

void	convertForSave (OdDb::DwgVersion ver)

virtual void	composeForLoad (OdDb::SaveType format, OdDb::DwgVersion version, OdDbAuditInfo *pAuditInfo)

virtual OdGiDrawable *	drawable ()

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *pTraits) const

virtual bool	subWorldDraw (OdGiWorldDraw *pWd) const

virtual void	subViewportDraw (OdGiViewportDraw *pVd) const

virtual bool	isPersistent () const

virtual OdDbStub *	id () const

ODRX_SEALED_VIRTUAL OdResult	getClassID (void *pClsid) const ODRX_FINAL

void	setGsNode (OdGsCache *pNode)

OdGsCache *	gsNode () const

void	xDataTransformBy (const OdGeMatrix3d &xfm)

bool	hasFields () const

OdDbObjectId	getField (const OdString &fieldName) const

OdDbObjectPtr	getField (const OdString &fieldName, OdDb::OpenMode mode) const

virtual OdDbObjectId	setField (const OdString &fieldName, OdDbField *pField)

virtual OdResult	removeField (OdDbObjectId fieldId)

virtual OdDbObjectId	removeField (const OdString &fieldName)

OdDbObjectId	getFieldDictionary () const

OdDbObjectPtr	getFieldDictionary (OdDb::OpenMode mode) const

virtual OdRxClass *	saveAsClass (OdRxClass *pClass) const

Public Member Functions inherited from OdGiDrawable
	ODRX_DECLARE_MEMBERS (OdGiDrawable)

virtual DrawableType	drawableType () const

ODRX_SEALED_VIRTUAL OdUInt32	setAttributes (OdGiDrawableTraits *pTraits) const ODRX_FINAL

ODRX_SEALED_VIRTUAL bool	worldDraw (OdGiWorldDraw *pWd) const ODRX_FINAL

ODRX_SEALED_VIRTUAL void	viewportDraw (OdGiViewportDraw *pVd) const ODRX_FINAL

ODRX_SEALED_VIRTUAL OdUInt32	viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_FINAL

virtual OdResult	getGeomExtents (OdGeExtents3d &extents) const

ODRX_SEALED_VIRTUAL OdUInt32	regenSupportFlags () const ODRX_FINAL

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

bool	isKindOf (const OdRxClass *pClass) const

virtual OdRxObjectPtr	clone () const

virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const

virtual bool	isEqualTo (const OdRxObject *pOther) const

Protected Types
enum	{ kCanRename = 1 }

Protected Member Functions
	OdDbModelDocViewStyle ()

virtual OdResult	dwgInFields (OdDbDwgFiler *pFiler)

virtual void	dwgOutFields (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfInFields (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields (OdDbDxfFiler *pFiler) const

virtual OdResult	subOpen (OdDb::OpenMode mode) ODRX_OVERRIDE

Protected Member Functions inherited from OdDbObject
	OdDbObject ()

virtual OdResult	subGetClassID (void *pClsid) const

virtual OdDbObjectPtr	subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const

virtual OdDbObjectPtr	subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const

Protected Member Functions inherited from OdGiDrawable
	OdGiDrawable ()

virtual OdUInt32	subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const

virtual OdUInt32	subRegenSupportFlags () const

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

static OdRxClass *	desc ()

static void	rxInit ()

static void	rxUninit ()

Protected Attributes inherited from OdDbObject
OdDbObjectImpl *	m_pImpl

Detailed Description

Corresponding C++ library: TD_Db <group OdDb_Classes>

Definition at line 35 of file DbModelDocViewStyle.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerator
kCanRename

Definition at line 224 of file DbModelDocViewStyle.h.

◆ AttachmentPoint

enum OdDbModelDocViewStyle::AttachmentPoint

Defines the attachment point for the model documentation view label text.

Enumerator
kAboveView
kBelowView

Definition at line 47 of file DbModelDocViewStyle.h.

◆ TextAlignment

enum OdDbModelDocViewStyle::TextAlignment

Defines the alignment for the model documentation view label text.

Enumerator
kTextAlignmentLeft
kTextAlignmentCenter
kTextAlignmentRight

Definition at line 55 of file DbModelDocViewStyle.h.

Constructor & Destructor Documentation

◆ OdDbModelDocViewStyle()

OdDbModelDocViewStyle::OdDbModelDocViewStyle ( )

protected

◆ ~OdDbModelDocViewStyle()

virtual OdDbModelDocViewStyle::~OdDbModelDocViewStyle ( )

pure virtual

Member Function Documentation

◆ canRename()

bool OdDbModelDocViewStyle::canRename ( ) const

◆ defaultViewName()

OdString OdDbModelDocViewStyle::defaultViewName ( int index ) const

Returns the default view name based on the specified index.

Parameters

index [in] Index of default name.

◆ description()

virtual OdString OdDbModelDocViewStyle::description ( ) const

virtual

Returns the description of this view style.

◆ dwgInFields()

virtual OdResult OdDbModelDocViewStyle::dwgInFields ( OdDbDwgFiler * pFiler )

protectedvirtual

Reads the .dwg file data of this object.

Parameters

pFiler [in] Filer object from which data are read.

Returns: Returns the filer status.

This function is called by dwgIn() to allow the object to read its data.

When overriding this function:

1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().

Reimplemented from OdDbObject.

Reimplemented in OdDbDetailViewStyle, and OdDbSectionViewStyle.

◆ dwgOutFields()

virtual void OdDbModelDocViewStyle::dwgOutFields ( OdDbDwgFiler * pFiler ) const

protectedvirtual

Writes the .dwg file data of this object.

Parameters

pFiler [in] Pointer to the filer to which data are written.

Remarks

This function is called by dwgIn() to allow the object to write its data.

When overriding this function:

1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.

Reimplemented from OdDbObject.

Reimplemented in OdDbDetailViewStyle, and OdDbSectionViewStyle.

◆ dxfInFields()

virtual OdResult OdDbModelDocViewStyle::dxfInFields ( OdDbDxfFiler * pFiler )

protectedvirtual

Reads the DXF data of this object.

Parameters

pFiler [in] Pointer to the filer from which data are read.

Returns: Returns the filer status.

This function is called by dxfIn() to allow the object to read its data.

When overriding this function:

1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().

Reimplemented from OdDbObject.

Reimplemented in OdDbDetailViewStyle, and OdDbSectionViewStyle.

◆ dxfOutFields()

virtual void OdDbModelDocViewStyle::dxfOutFields ( OdDbDxfFiler * pFiler ) const

protectedvirtual

Writes the DXF data of this object.

Parameters

pFiler [in] Pointer to the filer to which data are to be written.

Remarks

This function is called by dxfOut() to allow the object to write its data.

When overriding this function:

1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.

Reimplemented from OdDbObject.

Reimplemented in OdDbDetailViewStyle, and OdDbSectionViewStyle.

◆ getDisplayName()

OdString OdDbModelDocViewStyle::getDisplayName ( ) const

Calculates a view label's position.

Parameters

offsetVector	[out] Offset (vector) of the view label.
textAlignment	[out] Text alignment of the view label.
attachment	[in] Use with the offset argument to specify label position.
offset	[in] Use with the attachment argument to specify label position.
minPt	[in] Point located in the lower left corner of the view's bounding box.
maxPt	[in] Point located in the upper right corner of the view's bounding box.

Returns: Position of the view label.

Sets the position of a view label.

Parameters

pMText	[in] Pointer to MText object to be positioned as a label.
attachment	[in] Use with the offset argument to specify label position.
offset	[in] Use with the attachment argument to specify label position.
minPt	[in] Point located in the lower left corner of the view's bounding box.
maxPt	[in] Point located in the upper right corner of the view's bounding box.

Returns: Position of the view label.

Updates the position of a view label.

Parameters

pMText	[in] Pointer to MText object to be positioned as a label.
attachment	[in] Specifies whether the label is attached.
minPt	[in] Point located in the lower left corner of the view's bounding box.
maxPt	[in] Point located in the upper right corner of the view's bounding box.

Returns: Position of the view label.

◆ getName()

virtual OdString OdDbModelDocViewStyle::getName ( ) const

virtual

Returns the name of this OdDbModelDocViewStyle object.

◆ isModifiedForRecompute()

bool OdDbModelDocViewStyle::isModifiedForRecompute ( ) const

Specifies whether properties were changed.

\returns

True if properties were changed; returns false otherwise.

◆ isViewNameValid()

bool OdDbModelDocViewStyle::isViewNameValid ( const OdString & name ) const

Checks whether a label name is valid.

Parameters

name	[in] Label name to check.

Returns: True if the specified name is a valid string.

◆ ODDB_DECLARE_MEMBERS()

OdDbModelDocViewStyle::ODDB_DECLARE_MEMBERS ( OdDbModelDocViewStyle )

◆ postViewStyleToDb()

virtual OdDbObjectId OdDbModelDocViewStyle::postViewStyleToDb	(	OdDbDatabase *	pDb,
		const OdString &	styleName )

pure virtual

Includes this view style object in a OdDbDatabase object.

Parameters

pDb	[in] Pointer of the database to receive the OdDbModelDocViewStyle object.
styleName	[in] Name of the view style.

Returns: Returns the OdDbObjectID of the newly added OdDbModelDocViewStyle object.

Implemented in OdDbDetailViewStyle, and OdDbSectionViewStyle.

◆ setCanRename()

OdResult OdDbModelDocViewStyle::setCanRename ( bool canRename )

◆ setDatabaseDefaults()

virtual void OdDbModelDocViewStyle::setDatabaseDefaults ( OdDbDatabase * pDb )

virtual

Sets defaults values for the properties of this view style.

◆ setDescription()

virtual void OdDbModelDocViewStyle::setDescription ( const OdString & description )

virtual

Sets the description of this view style.

Parameters

description [in] Description.

◆ setDispayName()

OdResult OdDbModelDocViewStyle::setDispayName ( const OdString & name )

◆ setName()

virtual void OdDbModelDocViewStyle::setName ( const OdString & name )

virtual

Sets the name of this OdDbModelDocViewStyle object.

Parameters

name	[in] Name.

◆ subOpen()

virtual OdResult OdDbModelDocViewStyle::subOpen ( OdDb::OpenMode mode )

protectedvirtual

Notification function called by the Teigha framework immediately before an object is opened.

Parameters

mode	[in] Mode in which the object is being opened.

Remarks: This function is notified just before an object is to be opened; giving this function the ability to cancel the object being opened.

Returns eOk if and only if open() is to continue.

Overriding this function in a child class allows a child instance to be notified each time an object is opened.

When overriding this function:

1) If the OdDbObject's state is incorrect, return something other than eOk.

2) If the parent class's subOpen() returns anything other than eOk, immediately return it.

3) If other actions are required before open, do them.

4) Return eOk.

The default implementation of this function does nothing but return eOk. This function can be overridden in custom classes.

Reimplemented from OdDbObject.

◆ viewLabelAlignment()

virtual TextAlignment OdDbModelDocViewStyle::viewLabelAlignment ( ) const

pure virtual

Returns the view label's text alignment.

Implemented in OdDbDetailViewStyle, and OdDbSectionViewStyle.

◆ viewLabelAttachment()

virtual AttachmentPoint OdDbModelDocViewStyle::viewLabelAttachment ( ) const

pure virtual

Returns the view label's attachment.

Implemented in OdDbDetailViewStyle, and OdDbSectionViewStyle.

◆ viewLabelOffset()

virtual double OdDbModelDocViewStyle::viewLabelOffset ( ) const

pure virtual

Returns the view label's offset.

Implemented in OdDbDetailViewStyle, and OdDbSectionViewStyle.

◆ viewLabelPattern()

virtual OdString OdDbModelDocViewStyle::viewLabelPattern ( ) const

pure virtual

Returns the view label's pattern.

Implemented in OdDbDetailViewStyle, and OdDbSectionViewStyle.

◆ viewLabelTextColor()

virtual OdCmColor OdDbModelDocViewStyle::viewLabelTextColor ( ) const

pure virtual

Returns the view label's color.

Implemented in OdDbDetailViewStyle, and OdDbSectionViewStyle.

◆ viewLabelTextHeight()

virtual double OdDbModelDocViewStyle::viewLabelTextHeight ( ) const

pure virtual

Returns the view label's text height.

Implemented in OdDbDetailViewStyle, and OdDbSectionViewStyle.

◆ viewLabelTextStyleId()

virtual OdDbObjectId OdDbModelDocViewStyle::viewLabelTextStyleId ( ) const

pure virtual

Returns the object ID of the view label's text style.

Implemented in OdDbDetailViewStyle, and OdDbSectionViewStyle.

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

DbModelDocViewStyle.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ AttachmentPoint

◆ TextAlignment

Constructor & Destructor Documentation

◆ OdDbModelDocViewStyle()

◆ ~OdDbModelDocViewStyle()

Member Function Documentation

◆ canRename()

◆ defaultViewName()

◆ description()

◆ dwgInFields()

◆ dwgOutFields()

◆ dxfInFields()

◆ dxfOutFields()

◆ getDisplayName()

◆ getName()

◆ isModifiedForRecompute()

◆ isViewNameValid()

◆ ODDB_DECLARE_MEMBERS()

◆ postViewStyleToDb()

◆ setCanRename()

◆ setDatabaseDefaults()

◆ setDescription()

◆ setDispayName()

◆ setName()

◆ subOpen()

◆ viewLabelAlignment()

◆ viewLabelAttachment()

◆ viewLabelOffset()

◆ viewLabelPattern()

◆ viewLabelTextColor()

◆ viewLabelTextHeight()

◆ viewLabelTextStyleId()