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

#include <DbDimAssoc.h>

Inheritance diagram for OdDbOsnapPointRef:
OdDbPointRef OdRxObject

Public Member Functions

 OdDbOsnapPointRef ()
 
 ODRX_DECLARE_MEMBERS (OdDbOsnapPointRef)
 
OdDb::OsnapMode osnapType () const
 
void setOsnapType (OdDb::OsnapMode osnapMode)
 
OdDbXrefFullSubentPathmainEntity ()
 
OdDbXrefFullSubentPathintersectEntity ()
 
void getIdPath (OdDbFullSubentPath &idPath) const
 
void setIdPath (const OdDbFullSubentPath &idPath)
 
void getIntIdPath (OdDbFullSubentPath &intIdPath) const
 
void setIntIdPath (const OdDbFullSubentPath &intIdPath)
 
double nearPointParam () const
 
void setNearPointParam (double nearOsnap)
 
OdGePoint3d point () const
 
void setPoint (const OdGePoint3d &pt)
 
const OdDbOsnapPointReflastPointRef () const
 
OdDbOsnapPointReflastPointRef ()
 
void setLastPointRef (OdDbOsnapPointRefPtr pOsnapPointRef)
 
virtual bool isGeomErased () const
 
virtual bool isXrefObj (OdDbObjectIdArray &ids1, OdDbObjectIdArray &ids2, bool isMainObj=true) const
 
virtual OdResult updateXrefSubentPath ()
 
virtual OdResult updateSubentPath (OdDbIdMapping &idMap)
 
virtual OdResult evalPoint (OdGePoint3d &pt)
 
virtual OdResult getEntities (OdDbFullSubentPathArray &ents, bool getLastPtRef=true) const
 
virtual void updateDueToMirror (bool inMirror=false)
 
void getXrefHandles (OdHandleArray &xrefHandles) const
 
void setXrefHandles (const OdHandleArray &xrefHandles)
 
void getXrefIntHandles (OdHandleArray &xrefHandles) const
 
void setXrefIntHandles (const OdHandleArray &xrefHandles)
 
void dwgInFields (OdDbDwgFiler *pFiler)
 
void dwgOutFields (OdDbDwgFiler *pFiler) const
 
void dxfOutFields (OdDbDxfFiler *pFiler) const
 
OdResult dxfInFields (OdDbDxfFiler *filer)
 
- Public Member Functions inherited from OdDbPointRef
 ODRX_DECLARE_MEMBERS (OdDbPointRef)
 
- 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 OdDbPointRef
static bool calcTransform (const OdDbObjectIdArray &ids, OdGeMatrix3d &A_Ecs2Wcs)
 
static OdGeMatrix3d mswcsToPswcs (const OdDbViewport *pVPort)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

<group OdDb_Classes>

Definition at line 151 of file DbDimAssoc.h.

Constructor & Destructor Documentation

◆ OdDbOsnapPointRef()

OdDbOsnapPointRef::OdDbOsnapPointRef ( )

Member Function Documentation

◆ dwgInFields()

void OdDbOsnapPointRef::dwgInFields ( OdDbDwgFiler pFiler)
virtual

Reads the .dwg file format data of this object from the specified file.

Parameters
pFiler[in] Pointer to the filer from which the data are to be read.

Implements OdDbPointRef.

◆ dwgOutFields()

void OdDbOsnapPointRef::dwgOutFields ( OdDbDwgFiler pFiler) const
virtual

Writes the .dwg file format data of this object to the specified filer.

Parameters
pFiler[in] Pointer to the filer to which the data are to be written.

Implements OdDbPointRef.

◆ dxfInFields()

OdResult OdDbOsnapPointRef::dxfInFields ( OdDbDxfFiler filer)
virtual

Implements OdDbPointRef.

◆ dxfOutFields()

void OdDbOsnapPointRef::dxfOutFields ( OdDbDxfFiler pFiler) const
virtual

Writes the DXF format data of this object to the specified filer.

Parameters
pFiler[in] Pointer to the filer to which the data are to be written.

Implements OdDbPointRef.

◆ evalPoint()

virtual OdResult OdDbOsnapPointRef::evalPoint ( OdGePoint3d pt)
virtual

Implements OdDbPointRef.

◆ getEntities()

virtual OdResult OdDbOsnapPointRef::getEntities ( OdDbFullSubentPathArray ents,
bool  getLastPtRef = true 
) const
virtual

Implements OdDbPointRef.

◆ getIdPath()

void OdDbOsnapPointRef::getIdPath ( OdDbFullSubentPath idPath) const

◆ getIntIdPath()

void OdDbOsnapPointRef::getIntIdPath ( OdDbFullSubentPath intIdPath) const

◆ getXrefHandles()

void OdDbOsnapPointRef::getXrefHandles ( OdHandleArray xrefHandles) const

◆ getXrefIntHandles()

void OdDbOsnapPointRef::getXrefIntHandles ( OdHandleArray xrefHandles) const

◆ intersectEntity()

OdDbXrefFullSubentPath & OdDbOsnapPointRef::intersectEntity ( )
inline

Returns a reference to the OdDbXrefFullSubentPath of the intersecting entity for the OsnapPointRef object.

Definition at line 500 of file DbDimAssoc.h.

◆ isGeomErased()

virtual bool OdDbOsnapPointRef::isGeomErased ( ) const
virtual

Implements OdDbPointRef.

◆ isXrefObj()

virtual bool OdDbOsnapPointRef::isXrefObj ( OdDbObjectIdArray ids1,
OdDbObjectIdArray ids2,
bool  isMainObj = true 
) const
virtual

Implements OdDbPointRef.

◆ lastPointRef() [1/2]

OdDbOsnapPointRef * OdDbOsnapPointRef::lastPointRef ( )
inline

Returns the last OsnapPointRef for this OsnapPointRef object.

Definition at line 534 of file DbDimAssoc.h.

◆ lastPointRef() [2/2]

const OdDbOsnapPointRef * OdDbOsnapPointRef::lastPointRef ( ) const
inline

Returns the last OsnapPointRef for this OsnapPointRef object.

Definition at line 529 of file DbDimAssoc.h.

◆ mainEntity()

OdDbXrefFullSubentPath & OdDbOsnapPointRef::mainEntity ( )
inline

Returns a reference to the OdDbXrefFullSubentPath of the main entity for the OsnapPointRef object.

Definition at line 494 of file DbDimAssoc.h.

◆ nearPointParam()

double OdDbOsnapPointRef::nearPointParam ( ) const
inline

Returns the near Osnap value for this OsnapPointRef object.

Definition at line 506 of file DbDimAssoc.h.

◆ ODRX_DECLARE_MEMBERS()

OdDbOsnapPointRef::ODRX_DECLARE_MEMBERS ( OdDbOsnapPointRef  )

◆ osnapType()

OdDb::OsnapMode OdDbOsnapPointRef::osnapType ( ) const
inline

Returns the object snap mode for this OsnapPointRef object.

Remarks
osnapMode() returns one of the following:

Value Description OdDb::kOsModeEnd 1 End Point OdDb::kOsModeMid 2 Mid Point OdDb::kOsModeCen 3 Center OdDb::kOsModeNode 4 Node OdDb::kOsModeQuad 5 Quadrant OdDb::kOsModeIntersec 6 Intersection OdDb::kOsModeIns 7 Insertion point OdDb::kOsModePerp 8 Perpendicular OdDb::kOsModeTan 9 Tangent OdDb::kOsModeNear 10 Nearest OdDb::kOsModeApint 11 Apparent intersection OdDb::kOsModePar 12 Parallel OdDb::kOsModeStart 13 Start Point

Definition at line 482 of file DbDimAssoc.h.

◆ point()

OdGePoint3d OdDbOsnapPointRef::point ( ) const
inline

Returns a reference to the Osnap point for this OsnapPointRef object.

Definition at line 518 of file DbDimAssoc.h.

◆ setIdPath()

void OdDbOsnapPointRef::setIdPath ( const OdDbFullSubentPath idPath)

◆ setIntIdPath()

void OdDbOsnapPointRef::setIntIdPath ( const OdDbFullSubentPath intIdPath)

◆ setLastPointRef()

void OdDbOsnapPointRef::setLastPointRef ( OdDbOsnapPointRefPtr  pOsnapPointRef)
inline

Sets the last OsnapPointRef for this OsnapPointRef object.

Parameters
pOsnapPointRef[in] Pointer to the last OsnapPointRef object.

Definition at line 540 of file DbDimAssoc.h.

◆ setNearPointParam()

void OdDbOsnapPointRef::setNearPointParam ( double  nearOsnap)
inline

Returns the near Osnap value for this OsnapPointRef object.

Parameters
nearOsnap[in] Near Osnap value.

Definition at line 512 of file DbDimAssoc.h.

◆ setOsnapType()

void OdDbOsnapPointRef::setOsnapType ( OdDb::OsnapMode  osnapMode)
inline

Sets the object snap mode for this OsnapPointRef object.

Remarks
osnapMode must be one of the following:

Value Description OdDb::kOsModeEnd 1 End Point OdDb::kOsModeMid 2 Mid Point OdDb::kOsModeCen 3 Center OdDb::kOsModeNode 4 Node OdDb::kOsModeQuad 5 Quadrant OdDb::kOsModeIntersec 6 Intersection OdDb::kOsModeIns 7 Insertion point OdDb::kOsModePerp 8 Perpendicular OdDb::kOsModeTan 9 Tangent OdDb::kOsModeNear 10 Nearest OdDb::kOsModeApint 11 Apparent intersection OdDb::kOsModePar 12 Parallel OdDb::kOsModeStart 13 Start Point

Definition at line 488 of file DbDimAssoc.h.

◆ setPoint()

void OdDbOsnapPointRef::setPoint ( const OdGePoint3d pt)
inline

Definition at line 523 of file DbDimAssoc.h.

◆ setXrefHandles()

void OdDbOsnapPointRef::setXrefHandles ( const OdHandleArray xrefHandles)

◆ setXrefIntHandles()

void OdDbOsnapPointRef::setXrefIntHandles ( const OdHandleArray xrefHandles)

◆ updateDueToMirror()

virtual void OdDbOsnapPointRef::updateDueToMirror ( bool  inMirror = false)
virtual

Implements OdDbPointRef.

◆ updateSubentPath()

virtual OdResult OdDbOsnapPointRef::updateSubentPath ( OdDbIdMapping idMap)
virtual

Implements OdDbPointRef.

◆ updateXrefSubentPath()

virtual OdResult OdDbOsnapPointRef::updateXrefSubentPath ( )
virtual

Implements OdDbPointRef.


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