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

#include <DbGeomRef.h>

Inheritance diagram for OdDbEdgeRef:
OdRxObjectImpl< OdDbSubentRef > OdDbSubentRef OdDbGeomRef OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdDbEdgeRef)
 
 OdDbEdgeRef ()
 
 OdDbEdgeRef (const OdDbFullSubentPath &path)
 
 OdDbEdgeRef (const OdDbCompoundObjectId &comId, const OdDbSubentId &edgeSubentId=OdDbSubentId(), const OdDbSubentId &faceSubentId=OdDbSubentId(), const OdGeCurve3d *pCurve=NULL)
 
 OdDbEdgeRef (const OdGeCurve3d *pGeCurve)
 
 OdDbEdgeRef (const OdDbEdgeRef &src)
 
virtual ~OdDbEdgeRef ()
 
OdDbEdgeRefoperator= (const OdDbEdgeRef &src)
 
virtual void copyFrom (const OdRxObject *src)
 
virtual void reset ()
 
virtual bool isValid () const
 
virtual bool isEmpty () const
 
void setFaceSubentity (const OdDbSubentId &faceSubentId)
 
OdDbSubentId faceSubentId () const
 
const OdGeCurve3dcurve () const
 
virtual OdResult evaluateCurve (OdGeCurve3d *&src) const
 
virtual OdDbEntityPtr createEntity () const
 
virtual OdResult evaluateAndCacheGeometry ()
 
void setCurve (const OdGeCurve3d *pCurve)
 
- Public Member Functions inherited from OdRxObjectImpl< OdDbSubentRef >
 OdRxObjectImpl ()
 
void addRef ()
 
void release ()
 
long numRefs () const
 
- Public Member Functions inherited from OdDbSubentRef
 ODRX_DECLARE_MEMBERS (OdDbSubentRef)
 
 OdDbSubentRef ()
 
 OdDbSubentRef (const OdDbCompoundObjectId &compId, const OdDbSubentId &subent=OdDbSubentId())
 
OdDbSubentRefoperator= (const OdDbSubentRef &src)
 
virtual void copyFrom (const OdRxObject *src)
 
virtual void reset ()
 
virtual bool isValid () const
 
virtual bool isEmpty () const
 
virtual const OdDbCompoundObjectIdentity () const
 
virtual OdDbSubentId subentId () const
 
virtual OdDbEntityPtr createEntity () const
 
virtual OdResult evaluateAndCacheGeometry ()
 
- Public Member Functions inherited from OdDbGeomRef
 ODRX_DECLARE_MEMBERS (OdDbGeomRef)
 
virtual ~OdDbGeomRef ()
 
virtual void reset ()
 
virtual bool isValid () const
 
virtual bool isEmpty () const
 
virtual OdDbEntityPtr createEntity () const
 
virtual OdResult evaluateAndCacheGeometry ()
 
- 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
 

Static Public Member Functions

static OdSmartPtr< OdDbEdgeRefcreateObject (const OdDbCompoundObjectIdPtr &pid, const OdGeCurve3d *pCurve)
 
static OdSmartPtr< OdDbEdgeRefcreateObject (const OdDbCompoundObjectId &compId, const OdGeCurve3d *pCurve)
 
static OdSmartPtr< OdDbEdgeRefcreateObject (const OdDbEntity *pEnt)
 
static OdSmartPtr< OdDbEdgeRefcreateObject (const OdGeCurve3d *pCurve)
 
- Static Public Member Functions inherited from OdRxObjectImpl< OdDbSubentRef >
static OdSmartPtr< OdDbSubentRefcreateObject ()
 
- Static Public Member Functions inherited from OdDbSubentRef
static OdSmartPtr< OdDbSubentRefcreateObject (const OdDbCompoundObjectId &compId, const OdDbSubentId &subent=OdDbSubentId())
 
static OdSmartPtr< OdDbSubentRefcreateObject (const OdDbCompoundObjectId *pid, const OdDbSubentId &subentid=OdDbSubentId())
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Additional Inherited Members

- Protected Member Functions inherited from OdRxObjectImpl< OdDbSubentRef >
 ODRX_HEAP_OPERATORS ()
 
- Protected Member Functions inherited from OdDbSubentRef
void setEntity (const OdDbCompoundObjectId &entityId)
 
void setSubent (const OdDbSubentId &subentId)
 
void setFromSubentPath (const OdDbFullSubentPath &pathSubEnt)
 

Detailed Description

This class represents a reference to an edge object.

<group OdDb_Classes>

Definition at line 344 of file DbGeomRef.h.

Constructor & Destructor Documentation

◆ OdDbEdgeRef() [1/5]

OdDbEdgeRef::OdDbEdgeRef ( )

Constructor creates an instance of this class.

◆ OdDbEdgeRef() [2/5]

OdDbEdgeRef::OdDbEdgeRef ( const OdDbFullSubentPath path)

Creates OdDbEdgeRef from an entity in a block table record and referenced via a path of block inserts.

Parameters
path[in] path.

◆ OdDbEdgeRef() [3/5]

OdDbEdgeRef::OdDbEdgeRef ( const OdDbCompoundObjectId comId,
const OdDbSubentId edgeSubentId = OdDbSubentId(),
const OdDbSubentId faceSubentId = OdDbSubentId(),
const OdGeCurve3d pCurve = NULL 
)

Creates an instance of this class.

Parameters
comId[in] Component id.
edgeSubentId[in] edge subentid.
faceSubentId[in] face subentid.
pCurve[in] geometry curve.

◆ OdDbEdgeRef() [4/5]

OdDbEdgeRef::OdDbEdgeRef ( const OdGeCurve3d pGeCurve)

◆ OdDbEdgeRef() [5/5]

OdDbEdgeRef::OdDbEdgeRef ( const OdDbEdgeRef src)

Creates an OdDbEdgeRef based on another OdDbEdgeRef object.

Parameters
src[in] edge reference that will be copied.

◆ ~OdDbEdgeRef()

virtual OdDbEdgeRef::~OdDbEdgeRef ( )
virtual

Destructor destroys an instance of this class.

Member Function Documentation

◆ copyFrom()

virtual void OdDbEdgeRef::copyFrom ( const OdRxObject src)
virtual

Initializes this reference using a given object.

Parameters
src[in] edge reference that will be copied.

Reimplemented from OdDbSubentRef.

◆ createEntity()

virtual OdDbEntityPtr OdDbEdgeRef::createEntity ( ) const
virtual

Creates an entity using this edge reference.

Returns
created entity.

Reimplemented from OdDbSubentRef.

◆ createObject() [1/4]

static OdSmartPtr< OdDbEdgeRef > OdDbEdgeRef::createObject ( const OdDbCompoundObjectId compId,
const OdGeCurve3d pCurve 
)
static

Creates an instance of this class.

Parameters
compId[in]input component id
pCurve[in]input geometry curve

◆ createObject() [2/4]

static OdSmartPtr< OdDbEdgeRef > OdDbEdgeRef::createObject ( const OdDbCompoundObjectIdPtr pid,
const OdGeCurve3d pCurve 
)
inlinestatic

Deprecated.

Definition at line 385 of file DbGeomRef.h.

◆ createObject() [3/4]

static OdSmartPtr< OdDbEdgeRef > OdDbEdgeRef::createObject ( const OdDbEntity pEnt)
static

Creates an instance of this class.

Parameters
pEnt[in]entity

◆ createObject() [4/4]

static OdSmartPtr< OdDbEdgeRef > OdDbEdgeRef::createObject ( const OdGeCurve3d pCurve)
static

Creates an instance of this class.

Parameters
pCurve[in]geometry curve

◆ curve()

const OdGeCurve3d * OdDbEdgeRef::curve ( ) const

Returns the constant three-dimensional curve which the edge reference can hold.

◆ evaluateAndCacheGeometry()

virtual OdResult OdDbEdgeRef::evaluateAndCacheGeometry ( )
virtual

Evaluates and caches the geometry.

Returns
eOk if geometry is cached.

Reimplemented from OdDbSubentRef.

◆ evaluateCurve()

virtual OdResult OdDbEdgeRef::evaluateCurve ( OdGeCurve3d *&  src) const
virtual

Evaluates the curve.

Parameters
pCurve[out] evaluated curve.
Returns
eOk if curve is evaluated.

◆ faceSubentId()

OdDbSubentId OdDbEdgeRef::faceSubentId ( ) const

Returns the face subent ID of one of the faces adjacent to the referenced edge.

◆ isEmpty()

virtual bool OdDbEdgeRef::isEmpty ( ) const
virtual

Checks whether this edge reference is empty.

Returns
true if edge reference is empty.

Reimplemented from OdDbSubentRef.

◆ isValid()

virtual bool OdDbEdgeRef::isValid ( ) const
virtual

Checks whether this edge reference is valid.

Returns
true if edge reference is valid.

Reimplemented from OdDbSubentRef.

◆ ODRX_DECLARE_MEMBERS()

OdDbEdgeRef::ODRX_DECLARE_MEMBERS ( OdDbEdgeRef  )

◆ operator=()

OdDbEdgeRef & OdDbEdgeRef::operator= ( const OdDbEdgeRef src)

Copies a given edge reference to this reference.

Parameters
src[in] edge reference that will be copied.

◆ reset()

virtual void OdDbEdgeRef::reset ( )
virtual

Resets this edge reference.

Reimplemented from OdDbSubentRef.

◆ setCurve()

void OdDbEdgeRef::setCurve ( const OdGeCurve3d pCurve)

Sets the constant three-dimensional curve to be hold by this edge reference.

Parameters
pCurve[in] input curve.

◆ setFaceSubentity()

void OdDbEdgeRef::setFaceSubentity ( const OdDbSubentId faceSubentId)

The edge reference can use the subent ID of a face subentity. The face entity is used to restrict the referenced edge subentity.

Parameters
src[in] Face subentityid.

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