CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdDbDetailViewStyle Class Reference

#include <DbDetailViewStyle.h>

Inheritance diagram for OdDbDetailViewStyle:
OdDbModelDocViewStyle OdDbObject OdGiDrawable OdRxObject

Public Types

enum  IdentifierPlacement { kOutsideBoundary = 0 , kOutsideBoundaryWithLeader = 1 , kOnBoundary = 2 , kOnBoundaryWithLeader }
 
enum  ModelEdge { kSmooth = 0 , kSmoothWithBorder , kSmoothWithConnectionLine , kJagged }
 
- Public Types inherited from OdDbModelDocViewStyle
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 (OdDbDetailViewStyle)
 
 OdDbDetailViewStyle ()
 
 ~OdDbDetailViewStyle ()
 
OdDbObjectId identifierStyleId () const
 
OdResult setIdentifierStyleId (const OdDbObjectId &objId)
 
OdCmColor identifierColor () const
 
OdResult setIdentifierColor (const OdCmColor &color)
 
double identifierHeight () const
 
OdResult setIdentifierHeight (double height)
 
double identifierOffset () const
 
OdResult setIdentifierOffset (double offset)
 
OdDbDetailViewStyle::IdentifierPlacement identifierPlacement () const
 
OdResult setIdentifierPlacement (OdDbDetailViewStyle::IdentifierPlacement placement)
 
OdDbObjectId arrowSymbolId () const
 
OdResult setArrowSymbolId (const OdDbObjectId &arrowSymbolId)
 
OdCmColor arrowSymbolColor () const
 
OdResult setArrowSymbolColor (const OdCmColor &color)
 
double arrowSymbolSize () const
 
OdResult setArrowSymbolSize (double size)
 
bool showArrows () const
 
OdResult setShowArrows (bool bValue)
 
OdDb::LineWeight boundaryLineWeight () const
 
OdResult setBoundaryLineWeight (OdDb::LineWeight lineweight)
 
OdCmColor boundaryLineColor () const
 
OdResult setBoundaryLineColor (const OdCmColor &color)
 
OdDbObjectId boundaryLineTypeId () const
 
OdResult setBoundaryLineTypeId (const OdDbObjectId &objId)
 
OdDb::LineWeight connectionLineWeight () const
 
OdResult setConnectionLineWeight (OdDb::LineWeight lineweight)
 
OdCmColor connectionLineColor () const
 
OdResult setConnectionLineColor (const OdCmColor &color)
 
OdDbObjectId connectionLineTypeId () const
 
OdResult setConnectionLineTypeId (const OdDbObjectId &objId)
 
OdDbObjectId viewLabelTextStyleId () const
 
OdResult setViewLabelTextStyleId (const OdDbObjectId &objId)
 
OdCmColor viewLabelTextColor () const
 
OdResult setViewLabelTextColor (const OdCmColor &color)
 
double viewLabelTextHeight () const
 
OdResult setViewLabelTextHeight (double height)
 
double viewLabelOffset () const
 
OdResult setViewLabelOffset (double offset)
 
OdDbModelDocViewStyle::AttachmentPoint viewLabelAttachment () const
 
OdResult setViewLabelAttachment (OdDbModelDocViewStyle::AttachmentPoint attachment)
 
OdDbModelDocViewStyle::TextAlignment viewLabelAlignment () const
 
OdResult setViewLabelAlignment (OdDbModelDocViewStyle::TextAlignment alignment)
 
OdString viewLabelPattern () const
 
OdString getViewLabelPattern (OdDbField *pField=NULL) const
 
OdResult setViewLabelPattern (const OdString &pattern, const OdDbField *pField=NULL)
 
bool showViewLabel () const
 
OdResult setShowViewLabel (bool bValue)
 
OdDbDetailViewStyle::ModelEdge modelEdge () const
 
OdResult setModelEdge (OdDbDetailViewStyle::ModelEdge placement)
 
OdDb::LineWeight borderLineWeight () const
 
OdResult setBorderLineWeight (OdDb::LineWeight lineweight)
 
OdCmColor borderLineColor () const
 
OdResult setBorderLineColor (const OdCmColor &color)
 
OdDbObjectId borderLineTypeId () const
 
OdResult setBorderLineTypeId (const OdDbObjectId &objId)
 
virtual OdDbObjectId postViewStyleToDb (OdDbDatabase *pDb, const OdString &styleName)
 
- Public Member Functions inherited from OdDbModelDocViewStyle
 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)
 
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)
 
- 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)
 
OdDbDatabasedatabase () 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
 
OdDbDwgFilerundoFiler ()
 
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 OdGiDrawabledrawable ()
 
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)
 
OdGsCachegsNode () 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 OdRxClasssaveAsClass (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 OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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
 

Static Public Member Functions

static OdDbObjectId defaultDetailViewStyle (OdDbDatabase *db, bool init=true)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
static void rxInit ()
 
static void rxUninit ()
 

Protected Member Functions

virtual OdResult dwgInFields (OdDbDwgFiler *pFiler)
 
virtual void dwgOutFields (OdDbDwgFiler *pFiler) const
 
virtual OdResult dxfInFields (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields (OdDbDxfFiler *pFiler) const
 
virtual OdDbObjectPtr subWblockClone (OdDbIdMapping &idMap, OdDbObject *pOwner, bool isPrimary=true) const
 
- Protected Member Functions inherited from OdDbModelDocViewStyle
 OdDbModelDocViewStyle ()
 
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
 
- Protected Member Functions inherited from OdGiDrawable
 OdGiDrawable ()
 
virtual OdUInt32 subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const
 
virtual OdUInt32 subRegenSupportFlags () const
 

Additional Inherited Members

- Protected Types inherited from OdDbModelDocViewStyle
enum  { kCanRename = 1 }
 
- Protected Attributes inherited from OdDbObject
OdDbObjectImplm_pImpl
 

Detailed Description

This class represents detail view style object.

Corresponding C++ library: TD_Db <group OdDb_Classes>

Definition at line 37 of file DbDetailViewStyle.h.

Member Enumeration Documentation

◆ IdentifierPlacement

Defines the identifier placement inside the detail view symbol.

Enumerator
kOutsideBoundary 
kOutsideBoundaryWithLeader 
kOnBoundary 
kOnBoundaryWithLeader 

Definition at line 45 of file DbDetailViewStyle.h.

◆ ModelEdge

Defines the edge type of the detail view symbol boundary.

Enumerator
kSmooth 
kSmoothWithBorder 
kSmoothWithConnectionLine 
kJagged 

Definition at line 55 of file DbDetailViewStyle.h.

Constructor & Destructor Documentation

◆ OdDbDetailViewStyle()

OdDbDetailViewStyle::OdDbDetailViewStyle ( )

Default constructor. Creates an OdDbDetailViewStyle instance.

◆ ~OdDbDetailViewStyle()

OdDbDetailViewStyle::~OdDbDetailViewStyle ( )

Member Function Documentation

◆ arrowSymbolColor()

OdCmColor OdDbDetailViewStyle::arrowSymbolColor ( ) const

Returns the arrow symbol's color.

◆ arrowSymbolId()

OdDbObjectId OdDbDetailViewStyle::arrowSymbolId ( ) const

Returns the arrow symbol's object ID.

◆ arrowSymbolSize()

double OdDbDetailViewStyle::arrowSymbolSize ( ) const

Returns the arrow symbol's size.

◆ borderLineColor()

OdCmColor OdDbDetailViewStyle::borderLineColor ( ) const

Returns the border line's color.

◆ borderLineTypeId()

OdDbObjectId OdDbDetailViewStyle::borderLineTypeId ( ) const

Returns the object ID of the border line's linetype.

◆ borderLineWeight()

OdDb::LineWeight OdDbDetailViewStyle::borderLineWeight ( ) const

Returns the border line's lineweight.

◆ boundaryLineColor()

OdCmColor OdDbDetailViewStyle::boundaryLineColor ( ) const

Returns the boundary line's color.

◆ boundaryLineTypeId()

OdDbObjectId OdDbDetailViewStyle::boundaryLineTypeId ( ) const

Returns the object ID of the boundary line's linetype.

◆ boundaryLineWeight()

OdDb::LineWeight OdDbDetailViewStyle::boundaryLineWeight ( ) const

Returns the boundary line's lineweight.

◆ connectionLineColor()

OdCmColor OdDbDetailViewStyle::connectionLineColor ( ) const

Returns the connection line's color.

◆ connectionLineTypeId()

OdDbObjectId OdDbDetailViewStyle::connectionLineTypeId ( ) const

Returns the object ID of the connection line's linetype.

◆ connectionLineWeight()

OdDb::LineWeight OdDbDetailViewStyle::connectionLineWeight ( ) const

Returns the connection line's lineweight.

◆ defaultDetailViewStyle()

static OdDbObjectId OdDbDetailViewStyle::defaultDetailViewStyle ( OdDbDatabase * db,
bool init = true )
static

Gets current detail view style to use as default for initialization of new detail symbol.

Parameters
db[in] database context.
init[in] Optional. If true then new style object may be created in the database if not exists.
Returns
Object ID of the current OdDbDetailViewStyle object that defines the appearence of this view symbol.
Remarks
This method checks if CVIEWDETAILSTYLE variable is initialized and checks if default OdDbDetailViewStyle object exists in detail-view-style dictioinary. When init parameter is true, method may create new object in the database and initialize CVIEWDETAILSTYLE variable if necessary.

◆ dwgInFields()

virtual OdResult OdDbDetailViewStyle::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 OdDbModelDocViewStyle.

◆ dwgOutFields()

virtual void OdDbDetailViewStyle::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 OdDbModelDocViewStyle.

◆ dxfInFields()

virtual OdResult OdDbDetailViewStyle::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 OdDbModelDocViewStyle.

◆ dxfOutFields()

virtual void OdDbDetailViewStyle::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 OdDbModelDocViewStyle.

◆ getViewLabelPattern()

OdString OdDbDetailViewStyle::getViewLabelPattern ( OdDbField * pField = NULL) const

Returns the view label's pattern.

pField If the pattern uses fields, they are copied 'pField'.

Returns
Pattern of the view label.

◆ identifierColor()

OdCmColor OdDbDetailViewStyle::identifierColor ( ) const

Returns the identifier's color.

◆ identifierHeight()

double OdDbDetailViewStyle::identifierHeight ( ) const

Returns the identifier's text height.

◆ identifierOffset()

double OdDbDetailViewStyle::identifierOffset ( ) const

Returns the identifier's offset between its arrow line and extension line.

◆ identifierPlacement()

OdDbDetailViewStyle::IdentifierPlacement OdDbDetailViewStyle::identifierPlacement ( ) const

Returns the placement for the label and identifier.

◆ identifierStyleId()

OdDbObjectId OdDbDetailViewStyle::identifierStyleId ( ) const

Returns the object ID of the identifier's text style.

Returns
Text style object ID.

◆ modelEdge()

OdDbDetailViewStyle::ModelEdge OdDbDetailViewStyle::modelEdge ( ) const

Returns label and model edge.

◆ ODDB_DECLARE_MEMBERS()

OdDbDetailViewStyle::ODDB_DECLARE_MEMBERS ( OdDbDetailViewStyle )

◆ postViewStyleToDb()

virtual OdDbObjectId OdDbDetailViewStyle::postViewStyleToDb ( OdDbDatabase * pDb,
const OdString & styleName )
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.

Implements OdDbModelDocViewStyle.

◆ setArrowSymbolColor()

OdResult OdDbDetailViewStyle::setArrowSymbolColor ( const OdCmColor & color)

Sets the arrow symbol's color.

◆ setArrowSymbolId()

OdResult OdDbDetailViewStyle::setArrowSymbolId ( const OdDbObjectId & arrowSymbolId)

Sets the arrow symbol's block.

◆ setArrowSymbolSize()

OdResult OdDbDetailViewStyle::setArrowSymbolSize ( double size)

Sets the arrow symbol's size.

◆ setBorderLineColor()

OdResult OdDbDetailViewStyle::setBorderLineColor ( const OdCmColor & color)

Sets the border line's color.

◆ setBorderLineTypeId()

OdResult OdDbDetailViewStyle::setBorderLineTypeId ( const OdDbObjectId & objId)

Sets the border line's linetype.

◆ setBorderLineWeight()

OdResult OdDbDetailViewStyle::setBorderLineWeight ( OdDb::LineWeight lineweight)

Sets the border line's lineweight.

◆ setBoundaryLineColor()

OdResult OdDbDetailViewStyle::setBoundaryLineColor ( const OdCmColor & color)

Sets the boundary line's color.

◆ setBoundaryLineTypeId()

OdResult OdDbDetailViewStyle::setBoundaryLineTypeId ( const OdDbObjectId & objId)

Sets the boundary line's linetype.

◆ setBoundaryLineWeight()

OdResult OdDbDetailViewStyle::setBoundaryLineWeight ( OdDb::LineWeight lineweight)

Sets the boundary line's lineweight.

◆ setConnectionLineColor()

OdResult OdDbDetailViewStyle::setConnectionLineColor ( const OdCmColor & color)

Sets the connection line's color.

◆ setConnectionLineTypeId()

OdResult OdDbDetailViewStyle::setConnectionLineTypeId ( const OdDbObjectId & objId)

Sets the connection line's linetype.

◆ setConnectionLineWeight()

OdResult OdDbDetailViewStyle::setConnectionLineWeight ( OdDb::LineWeight lineweight)

Sets the connection line's lineweight.

◆ setIdentifierColor()

OdResult OdDbDetailViewStyle::setIdentifierColor ( const OdCmColor & color)

Sets the identifier's color.

Parameters
color[in] Color for the identifier.
Returns
Return OdDb::eOk if successful.

◆ setIdentifierHeight()

OdResult OdDbDetailViewStyle::setIdentifierHeight ( double height)

Sets the identifier's text height.

Parameters
height[in] Text height.
Returns
Return OdDb::eOk if successful.

◆ setIdentifierOffset()

OdResult OdDbDetailViewStyle::setIdentifierOffset ( double offset)

Sets the identifier's offset between its arrow line and extension line.

◆ setIdentifierPlacement()

OdResult OdDbDetailViewStyle::setIdentifierPlacement ( OdDbDetailViewStyle::IdentifierPlacement placement)

Sets the placement for the label and identifier.

Parameters
placement[in] Bit coded value that defines the placements of label and identifier.
Returns
OdDb::eOk if successful.

◆ setIdentifierStyleId()

OdResult OdDbDetailViewStyle::setIdentifierStyleId ( const OdDbObjectId & objId)

Sets the identifier's text style.

Parameters
objId[in] Object ID of the text style.
\returns
OdDb::eOk if successful.

◆ setModelEdge()

OdResult OdDbDetailViewStyle::setModelEdge ( OdDbDetailViewStyle::ModelEdge placement)

Sets the placement of labels and identifiers.

◆ setShowArrows()

OdResult OdDbDetailViewStyle::setShowArrows ( bool bValue)

◆ setShowViewLabel()

OdResult OdDbDetailViewStyle::setShowViewLabel ( bool bValue)

◆ setViewLabelAlignment()

OdResult OdDbDetailViewStyle::setViewLabelAlignment ( OdDbModelDocViewStyle::TextAlignment alignment)

Sets the view label's text alignment.

◆ setViewLabelAttachment()

OdResult OdDbDetailViewStyle::setViewLabelAttachment ( OdDbModelDocViewStyle::AttachmentPoint attachment)

Sets the view label's attachment.

◆ setViewLabelOffset()

OdResult OdDbDetailViewStyle::setViewLabelOffset ( double offset)

Sets the view label's offset.

◆ setViewLabelPattern()

OdResult OdDbDetailViewStyle::setViewLabelPattern ( const OdString & pattern,
const OdDbField * pField = NULL )

Sets the view label's pattern.

pattern Pattern to assign to the view label. pField (Optional) Specify a field to assign the pattern from the field (instead of the pattern itself).

Returns
OdDb::eOk if successful.

◆ setViewLabelTextColor()

OdResult OdDbDetailViewStyle::setViewLabelTextColor ( const OdCmColor & color)

Sets the view label's color.

◆ setViewLabelTextHeight()

OdResult OdDbDetailViewStyle::setViewLabelTextHeight ( double height)

◆ setViewLabelTextStyleId()

OdResult OdDbDetailViewStyle::setViewLabelTextStyleId ( const OdDbObjectId & objId)

Sets the view label's text style.

◆ showArrows()

bool OdDbDetailViewStyle::showArrows ( ) const

Returns whether arrowheads display.

◆ showViewLabel()

bool OdDbDetailViewStyle::showViewLabel ( ) const

Returns whether view label.

◆ subWblockClone()

virtual OdDbObjectPtr OdDbDetailViewStyle::subWblockClone ( OdDbIdMapping & idMap,
OdDbObject * pOwner,
bool isPrimary = true ) const
protectedvirtual

Reimplemented from OdDbObject.

◆ viewLabelAlignment()

OdDbModelDocViewStyle::TextAlignment OdDbDetailViewStyle::viewLabelAlignment ( ) const
virtual

Returns the view label's text alignment.

Implements OdDbModelDocViewStyle.

◆ viewLabelAttachment()

OdDbModelDocViewStyle::AttachmentPoint OdDbDetailViewStyle::viewLabelAttachment ( ) const
virtual

Returns the view label's attachment.

Implements OdDbModelDocViewStyle.

◆ viewLabelOffset()

double OdDbDetailViewStyle::viewLabelOffset ( ) const
virtual

Returns the view label's offset.

Implements OdDbModelDocViewStyle.

◆ viewLabelPattern()

OdString OdDbDetailViewStyle::viewLabelPattern ( ) const
virtual

Returns the view label's pattern.

Implements OdDbModelDocViewStyle.

◆ viewLabelTextColor()

OdCmColor OdDbDetailViewStyle::viewLabelTextColor ( ) const
virtual

Returns the view label's color.

Implements OdDbModelDocViewStyle.

◆ viewLabelTextHeight()

double OdDbDetailViewStyle::viewLabelTextHeight ( ) const
virtual

Returns the view label's text height.

Implements OdDbModelDocViewStyle.

◆ viewLabelTextStyleId()

OdDbObjectId OdDbDetailViewStyle::viewLabelTextStyleId ( ) const
virtual

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

Implements OdDbModelDocViewStyle.


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