CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
OdHatchPatternManager Class Referenceabstract

#include <HatchPatternManager.h>

Inheritance diagram for OdHatchPatternManager:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdHatchPatternManager)
 
virtual void setApplicationService (OdDbHostAppServices *pServices)=0
 
virtual OdResult retrievePattern (OdDbHatch::HatchPatternType hatchPatternType, const OdString &hatchPatternName, OdDb::MeasurementValue measurementValue, OdHatchPattern &hatchPattern)=0
 
virtual void appendPattern (OdDbHatch::HatchPatternType hatchPatternType, const OdString &hatchPatternName, const OdHatchPattern &hatchPattern, OdDb::MeasurementValue measurementValue=OdDb::kEnglish)=0
 
virtual OdResult retrievePatternList (OdDbHatch::HatchPatternType hatchPatternType, OdDb::MeasurementValue measurementValue, OdStringArray &patternNames)=0
 
virtual void reset ()=0
 
- 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
 

Protected Member Functions

 OdHatchPatternManager ()
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

This class manages hatch patterns within a client application. Corresponding C++ library: TD_Db <group Other_Classes>

Definition at line 42 of file HatchPatternManager.h.

Constructor & Destructor Documentation

◆ OdHatchPatternManager()

OdHatchPatternManager::OdHatchPatternManager ( )
inlineprotected

Definition at line 45 of file HatchPatternManager.h.

Member Function Documentation

◆ appendPattern()

virtual void OdHatchPatternManager::appendPattern ( OdDbHatch::HatchPatternType  hatchPatternType,
const OdString hatchPatternName,
const OdHatchPattern hatchPattern,
OdDb::MeasurementValue  measurementValue = OdDb::kEnglish 
)
pure virtual

Appends the specified hatch pattern to this hatchPatternManager object.

Parameters
hatchPatternName[in] Hatch pattern name.
hatchPatternType[in] Hatch pattern type.
measurementValue[in] Measurement value.
hatchPattern[in] Hatch pattern.
Remarks
hatchPatternType must be one of the following:

Value Description OdDbHatch::kUserDefined 0 User-defined hatch. OdDbHatch::kPreDefined 1 Defined in acad.pat and acadiso.pat. OdDbHatch::kCustomDefined 2 In its own PAT file.

measurementValue must be one of the following:

Value OdDb::kEnglish 0 OdDb::kMetric 1

◆ ODRX_DECLARE_MEMBERS()

OdHatchPatternManager::ODRX_DECLARE_MEMBERS ( OdHatchPatternManager  )

◆ reset()

virtual void OdHatchPatternManager::reset ( )
pure virtual

Clears all loaded patterns.

◆ retrievePattern()

virtual OdResult OdHatchPatternManager::retrievePattern ( OdDbHatch::HatchPatternType  hatchPatternType,
const OdString hatchPatternName,
OdDb::MeasurementValue  measurementValue,
OdHatchPattern hatchPattern 
)
pure virtual

Retrieves the specified hatch pattern from this hatchPatternManager object.

Parameters
hatchPatternName[in] Hatch pattern name.
hatchPatternType[in] Hatch pattern type.
measurementValue[in] Measurement value.
hatchPattern[out] Hatch pattern.
Remarks
hatchPatternType must be one of the following:

Value Description OdDbHatch::kUserDefined 0 User-defined hatch. OdDbHatch::kPreDefined 1 Defined in acad.pat and acadiso.pat. OdDbHatch::kCustomDefined 2 In its own PAT file.

measurementValue must be one of the following:

Value OdDb::kEnglish 0 OdDb::kMetric 1

◆ retrievePatternList()

virtual OdResult OdHatchPatternManager::retrievePatternList ( OdDbHatch::HatchPatternType  hatchPatternType,
OdDb::MeasurementValue  measurementValue,
OdStringArray patternNames 
)
pure virtual

Retrieves names of loaded patterns.

Parameters
hatchPatternType[in] Hatch pattern type.
measurementValue[in] Measurement value.
patternNames[out] Receive loaded pattern names.
Remarks
hatchPatternType must be one of the following:

Value Description OdDbHatch::kUserDefined 0 User-defined hatch. OdDbHatch::kPreDefined 1 Defined in acad.pat and acadiso.pat. OdDbHatch::kCustomDefined 2 In its own PAT file.

measurementValue must be one of the following:

Value OdDb::kEnglish 0 OdDb::kMetric 1

◆ setApplicationService()

virtual void OdHatchPatternManager::setApplicationService ( OdDbHostAppServices pServices)
pure virtual

Sets the Host Application Services object for this hatchPatternManager object.

Parameters
pServices[in] Pointer to the HostAppServices object.

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