CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
OdDbSectionSettings Class Reference

#include <DbSection.h>

Inheritance diagram for OdDbSectionSettings:
OdDbObject OdGiDrawable OdRxObject

Public Types

enum  SectionType { kLiveSection = 0x1 , k2dSection = 0x2 , k3dSection = 0x4 }
 
enum  Geometry {
  kIntersectionBoundary = 0x1 , kIntersectionFill = 0x2 , kBackgroundGeometry = 0x4 , kForegroundGeometry = 0x8 ,
  kCurveTangencyLines = 0x10
}
 
enum  Generation {
  kSourceAllObjects = 0x1 , kSourceSelectedObjects = 0x2 , kDestinationNewBlock = 0x10 , kDestinationReplaceBlock = 0x20 ,
  kDestinationFile = 0x40
}
 
- 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
}
 

Public Member Functions

 ODDB_DECLARE_MEMBERS (OdDbSectionSettings)
 
 OdDbSectionSettings ()
 
virtual OdResult dwgInFields (OdDbDwgFiler *pFiler)
 
virtual void dwgOutFields (OdDbDwgFiler *pFiler) const
 
virtual OdResult dxfInFields (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields (OdDbDxfFiler *pFiler) const
 
virtual OdResult subGetClassID (void *pClsid) const
 
void reset ()
 
void reset (OdDbSectionSettings::SectionType nSecType)
 
OdDbSectionSettings::SectionType currentSectionType () const
 
void setCurrentSectionType (OdDbSectionSettings::SectionType nSecType)
 
OdDbSectionSettings::Generation generationOptions (OdDbSectionSettings::SectionType nSecType) const
 
void setGenerationOptions (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Generation nOptions)
 
void getSourceObjects (OdDbSectionSettings::SectionType nSecType, OdDbObjectIdArray &ids) const
 
void setSourceObjects (OdDbSectionSettings::SectionType nSecType, const OdDbObjectIdArray &ids)
 
OdDbObjectId destinationBlock (OdDbSectionSettings::SectionType nSecType) const
 
void setDestinationBlock (OdDbSectionSettings::SectionType nSecType, const OdDbObjectId &id)
 
const OdString destinationFile (OdDbSectionSettings::SectionType nSecType) const
 
void setDestinationFile (OdDbSectionSettings::SectionType nSecType, const OdString &pszFileName)
 
bool visibility (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry) const
 
void setVisibility (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry, bool bVisible)
 
OdCmColor color (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry) const
 
void setColor (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry, const OdCmColor &color)
 
OdString layer (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry) const
 
void setLayer (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry, const OdString &pszLayer)
 
OdString linetype (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry) const
 
void setLinetype (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry, const OdString &pszLinetype)
 
double linetypeScale (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry) const
 
void setLinetypeScale (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry, double fScale)
 
OdString plotStyleName (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry) const
 
void setPlotStyleName (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry, const OdString &pszPlotStyleName)
 
OdDb::LineWeight lineWeight (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry) const
 
void setLineWeight (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry, OdDb::LineWeight nLineWeight)
 
int faceTransparency (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry) const
 
void setFaceTransparency (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry, int nTransparency)
 
int edgeTransparency (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry) const
 
void setEdgeTransparency (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry, int nTransparency)
 
bool hatchVisibility (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry) const
 
void setHatchVisibility (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry, bool bVisible)
 
void getHatchPattern (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry, OdDbHatch::HatchPatternType &nPatternType, OdString &pszPatternName) const
 
void setHatchPattern (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry, OdDbHatch::HatchPatternType nPatternType, const OdString &pszPatternName)
 
double hatchAngle (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry) const
 
void setHatchAngle (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry, double fAngle)
 
double hatchSpacing (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry) const
 
void setHatchSpacing (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry, double fSpacing)
 
double hatchScale (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry) const
 
void setHatchScale (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry, double fScale)
 
bool hiddenLine (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry) const
 
void setHiddenLine (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry, bool bHiddenLine)
 
bool divisionLines (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry) const
 
void setDivisionLines (OdDbSectionSettings::SectionType nSecType, OdDbSectionSettings::Geometry nGeometry, bool bShow)
 
- 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 dwgInFields (OdDbDwgFiler *pFiler)
 
virtual void dwgOutFields (OdDbDwgFiler *pFiler) const
 
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 &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr wblockClone (OdDbIdMapping &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
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_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
 
virtual bool isPersistent () const =0
 
virtual OdDbStub * id () const =0
 
virtual void setGsNode (OdGsCache *pGsNode)=0
 
virtual OdGsCachegsNode () const =0
 
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
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- 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 subSetAttributes (OdGiDrawableTraits *traits) const =0
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const =0
 
virtual void subViewportDraw (OdGiViewportDraw *vd) const =0
 
virtual OdUInt32 subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const
 
virtual OdUInt32 subRegenSupportFlags () const
 
- Protected Attributes inherited from OdDbObject
OdDbObjectImplm_pImpl
 

Detailed Description

This class represent section plane settings. <group OdDb_Classes>

Definition at line 530 of file DbSection.h.

Member Enumeration Documentation

◆ Generation

Generation properties for section generation.

Enumerator
kSourceAllObjects 

Section planes cuts through all objects.

kSourceSelectedObjects 

Section plane cuts only through selected objects.

kDestinationNewBlock 

Section will be created as a new block.

kDestinationReplaceBlock 

Section will replace an existing block.

kDestinationFile 

Section will be saved in a file.

Definition at line 572 of file DbSection.h.

◆ Geometry

Defines geometry properties for section generation.

Enumerator
kIntersectionBoundary 

Intersection boundary properties.

kIntersectionFill 

Intersection fill properties.

kBackgroundGeometry 

Background geometry properties.

kForegroundGeometry 

Foreground geometry properties.

kCurveTangencyLines 

Curve tangency lines properties.

Definition at line 551 of file DbSection.h.

◆ SectionType

Defines section types for section generation.

Enumerator
kLiveSection 

Live section.

k2dSection 

2-dimensional section.

k3dSection 

3-dimensional section.

Definition at line 536 of file DbSection.h.

Constructor & Destructor Documentation

◆ OdDbSectionSettings()

OdDbSectionSettings::OdDbSectionSettings ( )

Constructor. Sets default values to fields.

Member Function Documentation

◆ color()

OdCmColor OdDbSectionSettings::color ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry 
) const

Returns color of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which color will be returned.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ currentSectionType()

OdDbSectionSettings::SectionType OdDbSectionSettings::currentSectionType ( ) const

Returns an enum value stating the current section type.

Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

◆ destinationBlock()

OdDbObjectId OdDbSectionSettings::destinationBlock ( OdDbSectionSettings::SectionType  nSecType) const

Returns ID of a block that will be replaced after section, if generation option is set to kDestinationReplaceBlock.

Parameters
nSecType[in] Section type enum value.

◆ destinationFile()

const OdString OdDbSectionSettings::destinationFile ( OdDbSectionSettings::SectionType  nSecType) const

Returns the name of the file to which the generated section will be saved, if the generation option is set to kDestinationFile.

Parameters
nSecType[in] Section type enum value.

◆ divisionLines()

bool OdDbSectionSettings::divisionLines ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry 
) const

Checks if division lines are visible for the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, for which the division lines visibility will be checked.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ dwgInFields()

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

◆ edgeTransparency()

int OdDbSectionSettings::edgeTransparency ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry 
) const

Returns edge transparency value of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which edge transparency value will be returned.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ faceTransparency()

int OdDbSectionSettings::faceTransparency ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry 
) const

Returns face transparency value of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which face transparency value will be returned.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ generationOptions()

OdDbSectionSettings::Generation OdDbSectionSettings::generationOptions ( OdDbSectionSettings::SectionType  nSecType) const

Returns an enum value stating the current generation options for specified section type.

Parameters
nSecType[in] Section type for which generation options will be returned.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible generation options are:

- 0x1, kSourceSelectedObjects - 0x2, kDestinationNewBlock - 0x10,
kDestinationReplaceBlock - 0x20, kDestinationFile - 0x40

◆ getHatchPattern()

void OdDbSectionSettings::getHatchPattern ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry,
OdDbHatch::HatchPatternType nPatternType,
OdString pszPatternName 
) const

Retrieves hatch pattern and its name from the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, from which hatch pattern is retrieved.
nPatternType[out] Hatch pattern type.
pszPatternName[out] Hatch pattern name.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

Possible hatch pattern types are:

- 0, User-defined hatch. kPreDefined - 1, Defined in acad.pat and acadiso.pat. kCustomDefined - 2, In its own PAT file.

◆ getSourceObjects()

void OdDbSectionSettings::getSourceObjects ( OdDbSectionSettings::SectionType  nSecType,
OdDbObjectIdArray ids 
) const

Returns an array of source objects for kSourceSelectedObjects section type.

Parameters
nSecType[in] Section type.
ids[out] Array of source objects.

◆ hatchAngle()

double OdDbSectionSettings::hatchAngle ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry 
) const

Returns the hatch angle value of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which hatch angle value will be returned.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ hatchScale()

double OdDbSectionSettings::hatchScale ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry 
) const

Returns the hatch scale value of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which hatch scale value will be returned.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ hatchSpacing()

double OdDbSectionSettings::hatchSpacing ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry 
) const

Returns the hatch spacing value of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which hatch spacing value will be returned.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ hatchVisibility()

bool OdDbSectionSettings::hatchVisibility ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry 
) const

Checks if the hatch is visible in the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which hatch visibility will be checked.
Returns
true if the hatch is visible, false - otherwise.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ hiddenLine()

bool OdDbSectionSettings::hiddenLine ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry 
) const

Checks if hidden lines are visible for the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, for which the hidden lines visibility will be checked.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ layer()

OdString OdDbSectionSettings::layer ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry 
) const

Returns the name of the layer of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which layer name will be returned.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ linetype()

OdString OdDbSectionSettings::linetype ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry 
) const

Returns the linetype of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which linetype will be returned.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ linetypeScale()

double OdDbSectionSettings::linetypeScale ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry 
) const

Returns the linetype scale of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which linetype scale will be returned.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ lineWeight()

OdDb::LineWeight OdDbSectionSettings::lineWeight ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry 
) const

Returns the line weight of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which line weight will be returned.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ ODDB_DECLARE_MEMBERS()

OdDbSectionSettings::ODDB_DECLARE_MEMBERS ( OdDbSectionSettings  )

◆ plotStyleName()

OdString OdDbSectionSettings::plotStyleName ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry 
) const

Returns the plot style name of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which plot style name will be returned.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ reset() [1/2]

void OdDbSectionSettings::reset ( )

Resets all settings for all section types to default values.

◆ reset() [2/2]

void OdDbSectionSettings::reset ( OdDbSectionSettings::SectionType  nSecType)

Resets all settings for a specific section type to default values.

Parameters
nSecType[in] Section type for which settings will be reset.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

◆ setColor()

void OdDbSectionSettings::setColor ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry,
const OdCmColor color 
)

Sets color of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which color will be changed.
color[in] Color to be set.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ setCurrentSectionType()

void OdDbSectionSettings::setCurrentSectionType ( OdDbSectionSettings::SectionType  nSecType)

Sets an enum value stating the current section type.

Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

◆ setDestinationBlock()

void OdDbSectionSettings::setDestinationBlock ( OdDbSectionSettings::SectionType  nSecType,
const OdDbObjectId id 
)

Sets ID of a block that will be replaced after section, if the generation option is set to kDestinationReplaceBlock.

Parameters
nSecType[in] Section type enum value.
id[in] ID of a block that will be replaced.

◆ setDestinationFile()

void OdDbSectionSettings::setDestinationFile ( OdDbSectionSettings::SectionType  nSecType,
const OdString pszFileName 
)

Sets the name of the file to which the generated section will be saved, if the generation option is set to kDestinationFile.

Parameters
nSecType[in] Section type enum value.
pszFileName[in] File name to be set.

◆ setDivisionLines()

void OdDbSectionSettings::setDivisionLines ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry,
bool  bShow 
)

Sets the division lines visibility flag for this geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, for which the division lines visibility will be set.
bShow[in] New division lines visibility flag value.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ setEdgeTransparency()

void OdDbSectionSettings::setEdgeTransparency ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry,
int  nTransparency 
)

Sets edge transparency value of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which face transparency value will be set.
nTransparency[in] Edge transparency value to be set.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ setFaceTransparency()

void OdDbSectionSettings::setFaceTransparency ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry,
int  nTransparency 
)

Sets face transparency value of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which face transparency value will be set.
nTransparency[in] Face transparency value to be set.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ setGenerationOptions()

void OdDbSectionSettings::setGenerationOptions ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Generation  nOptions 
)

Sets an enum value stating the current generation options.

Parameters
nSecType[in] Section type for which generation options will be set.
nOptions[in] Generation options.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible generation options are:

- 0x1, kSourceSelectedObjects - 0x2, kDestinationNewBlock - 0x10, kDestinationReplaceBlock - 0x20, kDestinationFile - 0x40

◆ setHatchAngle()

void OdDbSectionSettings::setHatchAngle ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry,
double  fAngle 
)

Sets the hatch angle value of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which hatch angle value will be set.
fAngle[in] Hatch angle value to be set.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ setHatchPattern()

void OdDbSectionSettings::setHatchPattern ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry,
OdDbHatch::HatchPatternType  nPatternType,
const OdString pszPatternName 
)

Sets hatch pattern and its name to the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which hatch pattern will be set.
nPatternType[in] Hatch pattern type.
pszPatternName[in] Hatch pattern name.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

Possible hatch pattern types are:

- 0, User-defined hatch. kPreDefined - 1, Defined in acad.pat and acadiso.pat. kCustomDefined - 2, In its own PAT file.

◆ setHatchScale()

void OdDbSectionSettings::setHatchScale ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry,
double  fScale 
)

Sets the hatch scale value of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which hatch scale value will be set.
fAngle[in] Hatch scale value to be set.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ setHatchSpacing()

void OdDbSectionSettings::setHatchSpacing ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry,
double  fSpacing 
)

Sets the hatch spacing value of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which hatch spacing value will be set.
fAngle[in] Hatch spacing value to be set.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ setHatchVisibility()

void OdDbSectionSettings::setHatchVisibility ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry,
bool  bVisible 
)

Sets the hatch visibility flag for the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which hatch visibility will be set.
bVisible[in] Visibility flag value.
Returns
true if the hatch is visible, false - otherwise.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ setHiddenLine()

void OdDbSectionSettings::setHiddenLine ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry,
bool  bHiddenLine 
)

Sets the hidden lines visibility flag for this geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, for which the hidden lines visibility will be set.
bHiddenLine[in] New hidden line visibility flag value.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ setLayer()

void OdDbSectionSettings::setLayer ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry,
const OdString pszLayer 
)

Sets the name of the layer of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which layer name will be set.
pszLayer[in] Name of the layer.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ setLinetype()

void OdDbSectionSettings::setLinetype ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry,
const OdString pszLinetype 
)

Sets the linetype of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which linetype will be set.
pszLinetype[in] Linetype to set.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ setLinetypeScale()

void OdDbSectionSettings::setLinetypeScale ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry,
double  fScale 
)

Sets the linetype scale of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which linetype scale will be set.
fScale[in] Linetype scale value to set.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ setLineWeight()

void OdDbSectionSettings::setLineWeight ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry,
OdDb::LineWeight  nLineWeight 
)

Sets the line weight of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which line weight will be set.
nLineWeight[in] Line weight value to be set.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ setPlotStyleName()

void OdDbSectionSettings::setPlotStyleName ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry,
const OdString pszPlotStyleName 
)

Sets the plot style name of the specified geometry.

Parameters
nSecType[in] Section type.
nGeometry[in] Geometry, which plot style name will be set.
pszPlotStyleName[in] Plot style name to set.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ setSourceObjects()

void OdDbSectionSettings::setSourceObjects ( OdDbSectionSettings::SectionType  nSecType,
const OdDbObjectIdArray ids 
)

Sets an array of source objects for kSourceSelectedObjects section type.

Parameters
nSecType[in] Section type.
ids[in] Array of source objects.

◆ setVisibility()

void OdDbSectionSettings::setVisibility ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry,
bool  bVisible 
)

Sets a visibility flag of the specified geometry.

Parameters
nSecType[in] Section type enum value.
nGeometry[in] Geometry, which visibility will be set.
bVisible[in] Flag value.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10

◆ subGetClassID()

virtual OdResult OdDbSectionSettings::subGetClassID ( void pClsid) const
virtual

Reimplemented from OdDbObject.

◆ visibility()

bool OdDbSectionSettings::visibility ( OdDbSectionSettings::SectionType  nSecType,
OdDbSectionSettings::Geometry  nGeometry 
) const

Checks if the specified geometry is visible.

Parameters
nSecType[in] Section type enum value.
nGeometry[in] Geometry to check.
Returns
true if the geometry is visible, false - otherwise.
Remarks
Possible section types are:
- 0x1, k2dSection - 0x2, k3dSection - 0x4

Possible geometries are:

- 0x1, kIntersectionFill - 0x2, kBackgroundGeometry - 0x4, kForegroundGeometry - 0x8, kCurveTangencyLines - 0x10


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