CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
OdDbMlineStyle Class Reference

#include <DbMlineStyle.h>

Inheritance diagram for OdDbMlineStyle:
OdDbObject OdGiDrawable OdRxObject

Public Member Functions

 ODDB_DECLARE_MEMBERS (OdDbMlineStyle)
 
 OdDbMlineStyle ()
 
void initMlineStyle ()
 
void set (const OdDbMlineStyle &source, bool checkIfReferenced=true)
 
void setDescription (const OdString &description)
 
const OdString description () const
 
void setName (const OdString &name)
 
const OdString name () const
 
void setShowMiters (bool showThem)
 
bool showMiters () const
 
void setStartSquareCap (bool showThem)
 
bool startSquareCap () const
 
void setStartRoundCap (bool showThem)
 
bool startRoundCap () const
 
void setStartInnerArcs (bool showThem)
 
bool startInnerArcs () const
 
void setEndSquareCap (bool showThem)
 
bool endSquareCap () const
 
void setEndRoundCap (bool showThem)
 
bool endRoundCap () const
 
void setEndInnerArcs (bool showThem)
 
bool endInnerArcs () const
 
void setFillColor (const OdCmColor &fillColor)
 
OdCmColor fillColor () const
 
void setFilled (bool filled)
 
bool filled () const
 
void setStartAngle (double startAngle)
 
double startAngle () const
 
void setEndAngle (double endAngle)
 
double endAngle () const
 
int addElement (double offset, const OdCmColor &color, OdDbObjectId linetypeId, bool checkIfReferenced=true)
 
void removeElementAt (int elem)
 
int numElements () const
 
void setElement (int elementIndex, double offset, const OdCmColor &color, OdDbObjectId linetypeId)
 
void getElementAt (int elementIndex, double &offset, OdCmColor &color, OdDbObjectId &linetypeId) const
 
virtual OdResult dwgInFields (OdDbDwgFiler *pFiler)
 
virtual void dwgOutFields (OdDbDwgFiler *pFiler) const
 
virtual OdResult dxfInFields (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields (OdDbDxfFiler *pFiler) const
 
OdResult subGetClassID (void *pClsid) const
 
virtual void appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &ownerIdMap)
 
- Public Member Functions inherited from OdDbObject
 ODDB_DECLARE_MEMBERS (OdDbObject)
 
 ~OdDbObject ()
 
void addRef ()
 
void release ()
 
long numRefs () const
 
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 OdResult subOpen (OdDb::OpenMode mode)
 
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 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 &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr wblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
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_SEALED
 
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_SEALED
 
ODRX_SEALED_VIRTUAL bool worldDraw (OdGiWorldDraw *pWd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL void viewportDraw (OdGiViewportDraw *pVd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdUInt32 viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_SEALED
 
virtual OdResult getGeomExtents (OdGeExtents3d &extents) const
 
ODRX_SEALED_VIRTUAL OdUInt32 regenSupportFlags () const ODRX_SEALED
 
- 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
 

Additional Inherited Members

- 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 ,
  kLastFlag = kDrawableNotPlottable
}
 
enum  DrawableType {
  kGeometry = 0 , kDistantLight = 1 , kPointLight = 2 , kSpotLight = 3 ,
  kAmbientLight , kSolidBackground , kGradientBackground , kImageBackground ,
  kGroundPlaneBackground , kViewport , kWebLight , kSkyBackground ,
  kImageBasedLightingBackground
}
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
- Protected Member Functions inherited from OdDbObject
 OdDbObject ()
 
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
 
- Protected Attributes inherited from OdDbObject
OdDbObjectImplm_pImpl
 

Detailed Description

This class represents Mline Style objects in an OdDbDatabase instance.

See also
TD_Db

OdDbMlineStyle objects are stored in the ACAD_MLINESTYLE dictionary in the Named Object Dictionary of an OdDbDatabase. <group OdDb_Classes>

Definition at line 59 of file DbMlineStyle.h.

Constructor & Destructor Documentation

◆ OdDbMlineStyle()

OdDbMlineStyle::OdDbMlineStyle ( )

Member Function Documentation

◆ addElement()

int OdDbMlineStyle::addElement ( double  offset,
const OdCmColor color,
OdDbObjectId  linetypeId,
bool  checkIfReferenced = true 
)

Adds an element to this MLine Style object.

Parameters
offset[in] Offset of this element.
color[in] Color of this element.
linetypeId[in] Object ID of the linetype of this element.
checkIfReferenced[in] Currently ignored.
Returns
Returns the index of the newly added element.

◆ appendToOwner()

virtual void OdDbMlineStyle::appendToOwner ( OdDbIdPair idPair,
OdDbObject pOwnerObject,
OdDbIdMapping ownerIdMap 
)
virtual

This function appends this object to the specified owner object.

Parameters
idPair[in] ID pair to append.
pOwnerObject[in] Pointer to the owner object.
ownerIdMap[in/out] Owner's ID map.
Remarks
Adds a record to the specified ID map.

This function is used internally to subDeepClone() and subWblockClone().

Throws:

Cause eInvalidOwnerObject !pOwnerObject->get()

Reimplemented from OdDbObject.

◆ description()

const OdString OdDbMlineStyle::description ( ) const

Returns the description for this Mline Style object (DXF 3).

◆ dwgInFields()

virtual OdResult OdDbMlineStyle::dwgInFields ( OdDbDwgFiler pFiler)
virtual

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.

◆ dwgOutFields()

virtual void OdDbMlineStyle::dwgOutFields ( OdDbDwgFiler pFiler) const
virtual

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.

◆ dxfInFields()

virtual OdResult OdDbMlineStyle::dxfInFields ( OdDbDxfFiler pFiler)
virtual

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.

◆ dxfOutFields()

virtual void OdDbMlineStyle::dxfOutFields ( OdDbDxfFiler pFiler) const
virtual

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.

◆ endAngle()

double OdDbMlineStyle::endAngle ( ) const

Returns the end angle for this Mline Style object (DXF 52).

◆ endInnerArcs()

bool OdDbMlineStyle::endInnerArcs ( ) const

Returns the display of End Inner Arcs for this Mline Style object (DXF 70, bit 0x100).

Returns
Returns true if and only if End Inner Arcs are to be displayed.

◆ endRoundCap()

bool OdDbMlineStyle::endRoundCap ( ) const

Returns the display of End Round Caps for this Mline Style object (DXF 70, bit 0x200).

Returns
Returns true if and only if End Round Caps are to be displayed.

◆ endSquareCap()

bool OdDbMlineStyle::endSquareCap ( ) const

Returns the display of End Square Caps for this Mline Style object (DXF 70, bit 0x80).

Remarks
True if and only if End Square Caps are to be displayed.

◆ fillColor()

OdCmColor OdDbMlineStyle::fillColor ( ) const

Returns the fill color for this Mline Style object (DXF 62).

◆ filled()

bool OdDbMlineStyle::filled ( ) const

Returns the filled flag for this Mline Style object (DXF 70, bit 0x01).

◆ getElementAt()

void OdDbMlineStyle::getElementAt ( int  elementIndex,
double &  offset,
OdCmColor color,
OdDbObjectId linetypeId 
) const

Returns the values for the specified element of this MLine Style.

Parameters
elementIndex[in] Index of element to return.
offset[out] Receives the offset of this element.
color[out] Receives the color of this element.
linetypeId[out] Receives the Object ID for the linetype of this element.

◆ initMlineStyle()

void OdDbMlineStyle::initMlineStyle ( )

Initializes or re-initializes this Mline Style object.

Remarks
Initialization is done as follows:

Value Name Empty string Description Empty string FillColor 0 StartAngle 90° EndAngle 90° ElementList Empty

◆ name()

const OdString OdDbMlineStyle::name ( ) const

Returns the name for this Mline Style object (DXF 2).

◆ numElements()

int OdDbMlineStyle::numElements ( ) const

Returns the number of elements in this MLine Style (DXF 71).

◆ ODDB_DECLARE_MEMBERS()

OdDbMlineStyle::ODDB_DECLARE_MEMBERS ( OdDbMlineStyle  )

◆ removeElementAt()

void OdDbMlineStyle::removeElementAt ( int  elem)

Removes the specified element from this MLine Style object.

Parameters
elementIndex[in] Index of element to be removed.

◆ set()

void OdDbMlineStyle::set ( const OdDbMlineStyle source,
bool  checkIfReferenced = true 
)

Copies the specified OdDdMlineStyle object to this Mline Style object.

Parameters
source[in] Object to be cloned.
checkIfReferenced[in] Currently ignored.

◆ setDescription()

void OdDbMlineStyle::setDescription ( const OdString description)

Sets the description for this Mline Style object (DXF 3).

Parameters
description[in] Description.

◆ setElement()

void OdDbMlineStyle::setElement ( int  elementIndex,
double  offset,
const OdCmColor color,
OdDbObjectId  linetypeId 
)

Sets the specified element of this MLine Style object.

Parameters
elementIndex[in] Index of element to modify.
offset[in] Offset of this element.
color[in] Color of this element.
linetypeId[in] Object ID of the linetype of this element.
Returns
Returns the index of the newly added element.

◆ setEndAngle()

void OdDbMlineStyle::setEndAngle ( double  endAngle)

Sets the end angle for this Mline Style object (DXF 52).

Parameters
endAngle[in] End angle.

◆ setEndInnerArcs()

void OdDbMlineStyle::setEndInnerArcs ( bool  showThem)

Controls the display of End Inner Arcs for this Mline Style object (DXF 70, bit 0x100).

Parameters
showThem[in] True if and only if End Inner Arcs are to be displayed.

◆ setEndRoundCap()

void OdDbMlineStyle::setEndRoundCap ( bool  showThem)

Controls the display of End Round Caps for this Mline Style object (DXF 70, bit 0x200).

Parameters
showThem[in] True if and only if End Round Caps are to be displayed.

◆ setEndSquareCap()

void OdDbMlineStyle::setEndSquareCap ( bool  showThem)

Controls the display of End Square Caps for this Mline Style object (DXF 70, bit 0x80).

Parameters
showThem[in] True if and only if End Square Caps are to be displayed.

◆ setFillColor()

void OdDbMlineStyle::setFillColor ( const OdCmColor fillColor)

Sets the fill color for this Mline Style object (DXF 62).

Parameters
fillColor[in] Fill Color.

◆ setFilled()

void OdDbMlineStyle::setFilled ( bool  filled)

Controls the filled flag for this Mline Style object (DXF 70, bit 0x01).

Parameters
filled[in] True for filled, false for not filled.

◆ setName()

void OdDbMlineStyle::setName ( const OdString name)

Sets the name for this Mline Style object (DXF 2).

Parameters
name[in] Name.

◆ setShowMiters()

void OdDbMlineStyle::setShowMiters ( bool  showThem)

Controls the display of Miters for this Mline Style object (DXF 70, bit 0x02).

Parameters
showThem[in] True if and only if miters are to be displayed.

◆ setStartAngle()

void OdDbMlineStyle::setStartAngle ( double  startAngle)

Sets the start angle for this Mline Style object (DXF 51).

Parameters
startAngle[in] Start angle.

◆ setStartInnerArcs()

void OdDbMlineStyle::setStartInnerArcs ( bool  showThem)

Controls the display of Start Inner Arcs for this Mline Style object (DXF 70, bit 0x20).

Parameters
showThem[in] True if and only if Start Inners Arcs are to be displayed.

◆ setStartRoundCap()

void OdDbMlineStyle::setStartRoundCap ( bool  showThem)

Controls the display of Start Round Caps for this Mline Style object (DXF 70, bit 0x40).

Parameters
showThem[in] True if and only if Start Round Caps are to be displayed.

◆ setStartSquareCap()

void OdDbMlineStyle::setStartSquareCap ( bool  showThem)

Controls the display of Start Square Caps for this Mline Style object (DXF 70, bit 0x01).

Parameters
showThem[in] True if and only if Start Square Caps are to be displayed.

◆ showMiters()

bool OdDbMlineStyle::showMiters ( ) const

Returns the display of Miters for this Mline Style object (DXF 70, bit 0x02).

Returns
Returns true if and only if miters are displayed.

◆ startAngle()

double OdDbMlineStyle::startAngle ( ) const

Returns the start angle for this Mline Style object (DXF 51).

◆ startInnerArcs()

bool OdDbMlineStyle::startInnerArcs ( ) const

Returns the display of Start Inner Arcs for this Mline Style object (DXF 70, bit 0x20).

Returns
Returns true if and only if Start Inners Arcs are to be displayed.

◆ startRoundCap()

bool OdDbMlineStyle::startRoundCap ( ) const

Returns the display of Start Round Caps for this Mline Style object (DXF 70, bit 0x40).

Returns
Returns true if and only if Start Round Caps are to be displayed.

◆ startSquareCap()

bool OdDbMlineStyle::startSquareCap ( ) const

Returns the display of Start Square Caps for this Mline Style object (DXF 70, bit 0x01).

Returns
Returns true if and only if Start Square Caps are to be displayed.

◆ subGetClassID()

OdResult OdDbMlineStyle::subGetClassID ( void pClsid) const
virtual

Reimplemented from OdDbObject.


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