OdDbPathRef Class Reference

#include <DbGeomRef.h>

Inheritance diagram for OdDbPathRef:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbPathRef)
	OdDbPathRef ()
	OdDbPathRef (const OdArray< OdDbEdgeRef > &edges)
	OdDbPathRef (const OdDbFullSubentPathArray &edgeSubentPathArr, const OdDbFullSubentPathArray &faceSubentPathArr)
	OdDbPathRef (const OdDbPathRef &src)
virtual	~OdDbPathRef ()
OdDbPathRef &	operator= (const OdDbPathRef &)
virtual void	copyFrom (const OdRxObject *src)
virtual void	reset ()
virtual bool	isValid () const
virtual bool	isEmpty () const
void	setEdgeRefs (const OdArray< OdDbEdgeRef > &edges)
OdResult	getEntityArray (OdArray< OdDbEntity * > &entities, bool concatenate) const
const OdArray< OdDbEdgeRef > &	edgeRefs () const
bool	isEqualTo (const OdGeCurve3d *pOther)
bool	isReferencePath ()
virtual OdDbEntityPtr	createEntity () const
virtual OdResult	evaluateAndCacheGeometry ()
Public Member Functions inherited from OdRxObjectImpl< OdDbGeomRef >
	OdRxObjectImpl ()
void	addRef ()
void	release ()
long	numRefs () const
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 OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () 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 OdRxObjectImpl< OdDbGeomRef >
static OdSmartPtr< OdDbGeomRef >	createObject ()
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()
Protected Member Functions inherited from OdRxObjectImpl< OdDbGeomRef >
	ODRX_HEAP_OPERATORS ()

Detailed Description

This class represents a reference to a path object.

<group OdDb_Classes>

Definition at line 742 of file DbGeomRef.h.

Constructor & Destructor Documentation

OdDbPathRef() [1/4]

OdDbPathRef::OdDbPathRef

(

)

Constructor creates an instance of this class.

OdDbPathRef() [2/4]

OdDbPathRef::OdDbPathRef

(

const OdArray< OdDbEdgeRef > &

edges

)

Creates an OdDbPathRef from a sequence of OdDbEdgeRefs.

Parameters

edges

[in] sequence of OdDbEdgeRefs.

OdDbPathRef() [3/4]

OdDbPathRef::OdDbPathRef	(	const OdDbFullSubentPathArray &	edgeSubentPathArr,
		const OdDbFullSubentPathArray &	faceSubentPathArr
	)

Creates for an OdDbPathRef that is a sequence of connected edges.

Parameters

edgeSubentPathArr	[in] Subent paths of the edges that make up the path.
faceSubentPathArr	[in] Optional subent paths of the faces for each edge. The number of elements in this array must be 0 or be the same as the number of elements in edgeSubentPathArr.

OdDbPathRef() [4/4]

OdDbPathRef::OdDbPathRef

(

const OdDbPathRef &

src

)

Creates an OdDbPathRef based on another OdDbPathRef object.

Parameters

src	[in] Input a reference to the object to copy.

~OdDbPathRef()

virtual OdDbPathRef::~OdDbPathRef ( )

virtual

Destructor destroys an instance of this class.

Member Function Documentation

copyFrom()

virtual void OdDbPathRef::copyFrom ( const OdRxObject *  src )

virtual

Initializes this reference using a given object.

Parameters

src	[in] Input a reference to the object to copy.

Reimplemented from OdRxObject.

createEntity()

virtual OdDbEntityPtr OdDbPathRef::createEntity ( ) const

virtual

Creates an entity using this path reference.

Returns

created entity

Reimplemented from OdDbGeomRef.

edgeRefs()

const OdArray< OdDbEdgeRef > & OdDbPathRef::edgeRefs

(

)

const

Returns the array of edge references stored in the path reference.

evaluateAndCacheGeometry()

virtual OdResult OdDbPathRef::evaluateAndCacheGeometry ( )

virtual

Evaluates and caches the geometry.

Returns

eOk if geometry is evaluated and cached

Reimplemented from OdDbGeomRef.

getEntityArray()

OdResult OdDbPathRef::getEntityArray	(	OdArray< OdDbEntity * > &	entities,
		bool	concatenate
	)		const

Returns an array of entities created from the edge references in the path. If the second argument is True, it tries to concatenate them.

Parameters

entities	[out] array of OdDbEntities created from the individual OdDbEdgeRefs in the path.
concatenate	[out] If concatenate is true, it tries to concatenate them.

Returns

eOk if array of OdDbEntities created

isEmpty()

virtual bool OdDbPathRef::isEmpty ( ) const

virtual

Checks whether this path reference is empty.

Returns

true if path reference is empty.

Reimplemented from OdDbGeomRef.

isEqualTo()

bool OdDbPathRef::isEqualTo

(

const OdGeCurve3d *

pOther

)

Checks whether the geometry of the path is equal to the geometry of a given curve.

Parameters

pOther

[in] input other curve which will be compared.

Returns

true if this path geometry is equal with given curve

isReferencePath()

bool OdDbPathRef::isReferencePath

(

)

Checks whether all elements of this path reference are the references to the entities.

Returns

true if this path is referenced to the entity

isValid()

virtual bool OdDbPathRef::isValid ( ) const

virtual

Checks whether this path reference is valid.

Returns

true if path reference is valid.

Reimplemented from OdDbGeomRef.

ODRX_DECLARE_MEMBERS()

OdDbPathRef::ODRX_DECLARE_MEMBERS

(

OdDbPathRef

)

operator=()

OdDbPathRef & OdDbPathRef::operator=

(

const OdDbPathRef &

)

Copies a given path reference to this reference.

reset()

virtual void OdDbPathRef::reset ( )

virtual

Resets this path reference.

Reimplemented from OdDbGeomRef.

setEdgeRefs()

void OdDbPathRef::setEdgeRefs

(

const OdArray< OdDbEdgeRef > &

edges

)

Sets the path reference from a sequence of edge references.

Parameters

edges

[in] sequence of edge references.

---

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

• DbGeomRef.h