CFx SDK Documentation  2022 SP0
Public Member Functions | List of all members
OdDbLSDefinition Class Reference

#include <DbLSDefinition.h>

Inheritance diagram for OdDbLSDefinition:
OdDbLSObject OdDbObject OdGiDrawable OdRxObject

Public Member Functions

 ODDB_DECLARE_MEMBERS (OdDbLSDefinition)
 
 OdDbLSDefinition ()
 
OdDbObjectId component () const
 
void setComponent (const OdDbObjectId &compId)
 
const OdUInt8componentUID () const
 
bool isContinuous () const
 
void setIsContinuous (bool bSet)
 
bool isElement () const
 
void setIsElement (bool bSet)
 
bool isPhysical () const
 
void setIsPhysical (bool bSet)
 
bool isSCScaleIndependent () const
 
void setIsSCScaleIndependent (bool bSet)
 
bool isSnappable () const
 
void setIsSnappable (bool bSet)
 
OdString name () const
 
void setName (const OdString &str)
 
OdInt32 styleNumber () const
 
void setStyleNumber (OdInt32 nStyle)
 
double unitDef () const
 
void setUnitDef (double fUnit)
 
double unitScale () const
 
void setUnitScale (double fUnit)
 
MSLSUnits unitsType () const
 
void setUnitsType (MSLSUnits type)
 
- Public Member Functions inherited from OdDbLSObject
 ODDB_DECLARE_MEMBERS (OdDbLSObject)
 
 OdDbLSObject ()
 
virtual OdResult dwgInFields (OdDbDwgFiler *pFiler)
 
virtual void dwgOutFields (OdDbDwgFiler *pFiler) const
 
virtual OdResult dxfInFields (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields (OdDbDxfFiler *pFiler) const
 
void setComponentUID (const OdUInt8 *pUID)
 
- 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
 
virtual void appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &ownerIdMap)
 
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 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
 
- Protected Attributes inherited from OdDbObject
OdDbObjectImplm_pImpl
 

Detailed Description

Dgn Line Style Definition.

See also
TD_Db <group OdDbLS_Classes>

Definition at line 44 of file DbLSDefinition.h.

Constructor & Destructor Documentation

◆ OdDbLSDefinition()

OdDbLSDefinition::OdDbLSDefinition ( )

Member Function Documentation

◆ component()

OdDbObjectId OdDbLSDefinition::component ( ) const

Returns initial component for Line Style.

◆ componentUID()

const OdUInt8* OdDbLSDefinition::componentUID ( ) const
virtual

Returns component unique identifier.

Remarks
16 bytes of data.

Implements OdDbLSObject.

◆ isContinuous()

bool OdDbLSDefinition::isContinuous ( ) const

Returns true if Line Style marked as continuous.

◆ isElement()

bool OdDbLSDefinition::isElement ( ) const

Returns true if Line Style comes from RSC file, elsewhere it is embedded in Design file.

◆ isPhysical()

bool OdDbLSDefinition::isPhysical ( ) const

Returns true if Line Style marked as physical.

Remarks
If true, prevents the Global Line Style Scale and the Annotation Scale factors from being applied.

◆ isSCScaleIndependent()

bool OdDbLSDefinition::isSCScaleIndependent ( ) const

Returns true if Line Style marked to scale inside shared cells independently.

◆ isSnappable()

bool OdDbLSDefinition::isSnappable ( ) const

Returns true if Line Style marked as snappable.

Remarks
If true, allows you to snap to the individual components of a line style. If false, allows you to snap to the underlying line of a line style.

◆ name()

OdString OdDbLSDefinition::name ( ) const

Returns name of this Line Style.

◆ ODDB_DECLARE_MEMBERS()

OdDbLSDefinition::ODDB_DECLARE_MEMBERS ( OdDbLSDefinition  )

◆ setComponent()

void OdDbLSDefinition::setComponent ( const OdDbObjectId compId)

Sets initial component for Line Style.

Parameters
compId[in] Identifier of component.

◆ setIsContinuous()

void OdDbLSDefinition::setIsContinuous ( bool  bSet)

Marks Line Style as continuous.

Parameters
bSet[in] New value to set.

◆ setIsElement()

void OdDbLSDefinition::setIsElement ( bool  bSet)

Sets flag which indicate that this Line Style comes from RSC file.

Parameters
bSet[in] New value to set.

◆ setIsPhysical()

void OdDbLSDefinition::setIsPhysical ( bool  bSet)

Marks this Line Style as physical.

Parameters
bSet[in] New value to set.

◆ setIsSCScaleIndependent()

void OdDbLSDefinition::setIsSCScaleIndependent ( bool  bSet)

Sets shared cell scale independent flag to this Line Style.

Parameters
bSet[in] New value to set.

◆ setIsSnappable()

void OdDbLSDefinition::setIsSnappable ( bool  bSet)

Sets snappable flag for this Line Style.

Parameters
bSet[in] New value to set.

◆ setName()

void OdDbLSDefinition::setName ( const OdString str)

Sets name for this Line Style.

Parameters
str[in] Name to set.

◆ setStyleNumber()

void OdDbLSDefinition::setStyleNumber ( OdInt32  nStyle)

Sets style number for this Line Style.

Parameters
nStyle[in] Style number to set.
Remarks
Typically it is null.

◆ setUnitDef()

void OdDbLSDefinition::setUnitDef ( double  fUnit)

Sets the Line Style scale stored in definition.

Parameters
fUnit[in] New scale factor to set.
Remarks
It will be used as multiplier for unitScale if will be set as non-zero.

◆ setUnitScale()

void OdDbLSDefinition::setUnitScale ( double  fUnit)

Sets the unit scale factor for this Line Style.

Parameters
fUnit[in] New scale factor to set.

◆ setUnitsType()

void OdDbLSDefinition::setUnitsType ( MSLSUnits  type)

Sets type of units used for this Line Style.

Parameters
type[in] New type to set.

◆ styleNumber()

OdInt32 OdDbLSDefinition::styleNumber ( ) const

Returns the style number for this Line Style.

◆ unitDef()

double OdDbLSDefinition::unitDef ( ) const

Returns the Line Style scale stored in definition.

Remarks
Typically it is null.

◆ unitScale()

double OdDbLSDefinition::unitScale ( ) const

Returns unit scale for this Line Style.

Remarks
Typically it is 1.0.

◆ unitsType()

MSLSUnits OdDbLSDefinition::unitsType ( ) const

Returns type of units used for this Line Style.

Remarks
Typically it is set to kMSLSMasterUnits.

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