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

#include <AECDbDispRepConfig.h>

Inheritance diagram for AECDbDispRepConfig:
AECDbDictRecord AECDbObject OdDbObject OdGiDrawable OdRxObject

Public Member Functions

OdUInt32 GetDisplaySetCount () const
 
OdDbObjectId GetDisplaySetByIndex (OdUInt32 iIndex, OdGeVector3d &vViewDirection) const
 
OdDbObjectId GetDefaultDisplaySet () const
 
void AssignDisplaySet (OdDb::OrthographicView eViewDirection, const OdDbObjectId &idDisplaySet)
 
bool IsViewportDependent () const
 
void SetIsViewportDependent (bool bViewportDependent)
 
bool IsUseFixedViewDirection () const
 
void SetIsUseFixedViewDirection (bool bUseFixedViewDirection)
 
const OdGeVector3dGetFixedViewDirection () const
 
void SetFixedViewDirection (const OdGeVector3d &vViewDirection)
 
OdDbObjectId GetFixedDisplaySet () const
 
void SetFixedDisplaySet (const OdDbObjectId &idFixedDisplaySet)
 
OdDbObjectId GetDisplaySet (const OdGeVector3d &vViewDirection) const
 
OdDbObjectId GetDisplaySet (OdDb::OrthographicView eViewDirection) const
 
double GetCutPlane () const
 
void SetCutPlane (double dCutPlane)
 
double GetAboveRange () const
 
void SetAboveRange (double dCutPlane)
 
double GetBelowRange () const
 
void SetBelowRange (double dCutPlane)
 
void SetAsDefault ()
 
- Public Member Functions inherited from AECDbDictRecord
const OdStringGetDictRecordDescription () const
 
void SetDictRecordDescription (const OdString &strDescription)
 
AECClassificationArraySubPtr GetClassificationArray () const
 
OdString GetName () const
 
- Public Member Functions inherited from AECDbObject
virtual void subClose ()
 
virtual OdResult dwgInFields (OdDbDwgFiler *pFiler)
 
virtual void dwgOutFields (OdDbDwgFiler *pFiler) const
 
virtual void dxfOut (OdDbDxfFiler *pFiler) const
 
virtual void audit (OdDbAuditInfo *pAuditInfo)
 
const OdStringGetDescription () const
 
void SetDescription (const OdString &strDescription)
 
OdUInt32 GetOverrideCount () const
 
AECOverrideSubPtr GetOverrideByIndex (OdUInt32 iIndex) const
 
AECImpArraySubPtr GetOverrides ()
 
OdDbObjectId GetCurrentDispProps (const OdDbObjectId &idDispRep)
 
OdDbObjectId OverrideDispProps (const OdDbObjectId &idDispRep, bool bCopyContents=true)
 
void RemoveDispProps (const OdDbObjectId &idDispRep)
 
- 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)
 
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)
 
void dwgIn (OdDbDwgFiler *pFiler)
 
void dwgOut (OdDbDwgFiler *pFiler) const
 
virtual OdResult dxfIn (OdDbDxfFiler *pFiler)
 
virtual OdResult dxfInFields (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields (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 AECDbObject
AECImpObjPtr m_pImpObject
 
AECImpArrayPtr m_pOverrides
 
- Protected Attributes inherited from OdDbObject
OdDbObjectImplm_pImpl
 

Detailed Description

Display Configuration.

Remarks
Stores the collection of Display Sets assigned to view directions. This allows to assign various display representations for AEC entities.

<group TA_API_Objects>

Definition at line 39 of file AECDbDispRepConfig.h.

Member Function Documentation

◆ AssignDisplaySet()

void AECDbDispRepConfig::AssignDisplaySet ( OdDb::OrthographicView  eViewDirection,
const OdDbObjectId idDisplaySet 
)

Assigns Display Set to the specified standard view direction.

Parameters
eViewDirection[in] - Type of standard view direction.
idDisplaySet[in] - Object ID of Display Set to assign.

◆ GetAboveRange()

double AECDbDispRepConfig::GetAboveRange ( ) const

Returns above cut plane level.

◆ GetBelowRange()

double AECDbDispRepConfig::GetBelowRange ( ) const

Returns below cut plane level.

◆ GetCutPlane()

double AECDbDispRepConfig::GetCutPlane ( ) const

Returns default cut plane height.

◆ GetDefaultDisplaySet()

OdDbObjectId AECDbDispRepConfig::GetDefaultDisplaySet ( ) const

Returns default Display Set.

◆ GetDisplaySet() [1/2]

OdDbObjectId AECDbDispRepConfig::GetDisplaySet ( const OdGeVector3d vViewDirection) const

Returns Display Set to use in viewport with specified view direction.

Remarks
There may be 7 different Display Sets assigned:

To be recognized as standard view direction the vector passed should be collinear with it.

◆ GetDisplaySet() [2/2]

OdDbObjectId AECDbDispRepConfig::GetDisplaySet ( OdDb::OrthographicView  eViewDirection) const

Returns Display Set to use in viewport with specified standard view direction.

◆ GetDisplaySetByIndex()

OdDbObjectId AECDbDispRepConfig::GetDisplaySetByIndex ( OdUInt32  iIndex,
OdGeVector3d vViewDirection 
) const

Returns Display Set by index.

Parameters
iIndex[in] - Index of Display Set.
vViewDirection[out] - View direction returned Display Set is assigned to.

Returns Value: Object ID of Display Set.

Throws:

Cause eInvalidIndex Specified index is out of bounds

◆ GetDisplaySetCount()

OdUInt32 AECDbDispRepConfig::GetDisplaySetCount ( ) const

Returns the number of Display Sets assigned for standard view directions:

◆ GetFixedDisplaySet()

OdDbObjectId AECDbDispRepConfig::GetFixedDisplaySet ( ) const

Returns Fixed Display Set.

Remarks
This Display Set should be used for viewport independent Display Configuration with "Use Fixed View Direction" flag set to false.

◆ GetFixedViewDirection()

const OdGeVector3d& AECDbDispRepConfig::GetFixedViewDirection ( ) const

Returns fixed view direction.

Remarks
Used only for viewport dependent Display Configuration.

◆ IsUseFixedViewDirection()

bool AECDbDispRepConfig::IsUseFixedViewDirection ( ) const

Returns whether fixed view direction is used.

Remarks
Used only for viewport dependent Display Configuration.

◆ IsViewportDependent()

bool AECDbDispRepConfig::IsViewportDependent ( ) const

Returns whether Display Configuration is viewport dependent.

◆ SetAboveRange()

void AECDbDispRepConfig::SetAboveRange ( double  dCutPlane)

Sets above cut plane level.

◆ SetAsDefault()

void AECDbDispRepConfig::SetAsDefault ( )

Sets this Display Configuration as database default.

Remarks
Only works on Display Configuration attached to database.

◆ SetBelowRange()

void AECDbDispRepConfig::SetBelowRange ( double  dCutPlane)

Sets below cut plane level.

◆ SetCutPlane()

void AECDbDispRepConfig::SetCutPlane ( double  dCutPlane)

Sets default cut plane level.

◆ SetFixedDisplaySet()

void AECDbDispRepConfig::SetFixedDisplaySet ( const OdDbObjectId idFixedDisplaySet)

Sets Fixed Display Set.

Remarks
This Display Set should be used for viewport independent Display Configuration with "Use Fixed View Direction" flag set to false.

◆ SetFixedViewDirection()

void AECDbDispRepConfig::SetFixedViewDirection ( const OdGeVector3d vViewDirection)

Sets fixed view direction.

Remarks
Used only for viewport dependent Display Configuration.

◆ SetIsUseFixedViewDirection()

void AECDbDispRepConfig::SetIsUseFixedViewDirection ( bool  bUseFixedViewDirection)

Returns whether fixed view direction is used.

Remarks
Used only for viewport dependent Display Configuration.

◆ SetIsViewportDependent()

void AECDbDispRepConfig::SetIsViewportDependent ( bool  bViewportDependent)

Sets whether Display Configuration is viewport dependent.


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