OdDbVertexRef Class Reference

#include <DbGeomRef.h>

Inheritance diagram for OdDbVertexRef:

Public Types
enum	ImpliedType {   kExplicitVertex , kUnknownType , kEdgeStart , kEdgeEnd ,   kEdgeMid , kEdgeCenter , kEdgeSplineControlPoint , kEdgeSplineFitPoint }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbVertexRef)
	OdDbVertexRef ()
	OdDbVertexRef (const OdDbCompoundObjectId &comId, const OdDbSubentId &subentId=OdDbSubentId(), const OdGePoint3d &point3d=OdGePoint3d::kOrigin)
	OdDbVertexRef (const OdDbFullSubentPath &fullPath)
	OdDbVertexRef (const OdDbEntity *pEnt)
	OdDbVertexRef (const OdGePoint3d &point3d)
	OdDbVertexRef (ImpliedType implType, const OdDbEdgeRef &edgeRef, int controlOrFitPointIndex=0, const OdGePoint3d &point3d=OdGePoint3d::kOrigin)
	OdDbVertexRef (const OdDbVertexRef &src)
virtual	~OdDbVertexRef ()
OdDbVertexRef &	operator= (const OdDbVertexRef &other)
virtual void	copyFrom (const OdRxObject *src)
virtual void	reset ()
virtual bool	isValid () const
virtual const OdDbCompoundObjectId &	entity () const
virtual OdDbSubentId	subentId () const
ImpliedType	impliedType () const
const OdDbGeomRef *	referencedRef () const
int	index () const
OdGePoint3d	point () const
virtual OdResult	evaluatePoint (OdGePoint3d &point) const
OdDbEntityPtr	createEntity () const
virtual OdResult	evaluateAndCacheGeometry ()
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())
OdDbSubentRef &	operator= (const OdDbSubentRef &src)
virtual void	copyFrom (const OdRxObject *src)
virtual void	reset ()
virtual bool	isValid () const
virtual bool	isEmpty () const
virtual const OdDbCompoundObjectId &	entity () 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 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

Static Public Member Functions
static OdSmartPtr< OdDbVertexRef >	createObject (const OdGePoint3d &)
static OdSmartPtr< OdDbVertexRef >	createObject (const OdDbObjectId entId, const OdDbSubentId subId, const OdGePoint3d &point)
Static Public Member Functions inherited from OdRxObjectImpl< OdDbSubentRef >
static OdSmartPtr< OdDbSubentRef >	createObject ()
Static Public Member Functions inherited from OdDbSubentRef
static OdSmartPtr< OdDbSubentRef >	createObject (const OdDbCompoundObjectId &compId, const OdDbSubentId &subent=OdDbSubentId())
static OdSmartPtr< OdDbSubentRef >	createObject (const OdDbCompoundObjectId *pid, const OdDbSubentId &subentid=OdDbSubentId())
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

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 a vertex object.

<group OdDb_Classes>

Definition at line 524 of file DbGeomRef.h.

Member Enumeration Documentation

ImpliedType

enum OdDbVertexRef::ImpliedType

Declares the implied types.

Enumerator
kExplicitVertex	Directly specified vertex.
kUnknownType	Unknown type vertex.
kEdgeStart	Edge start vertex
kEdgeEnd	Edge end vertex
kEdgeMid	Edge mid vertex
kEdgeCenter	Edge center vertex
kEdgeSplineControlPoint	Edge spline control point
kEdgeSplineFitPoint	Edge spline fit point

Definition at line 532 of file DbGeomRef.h.

Constructor & Destructor Documentation

OdDbVertexRef() [1/7]

OdDbVertexRef::OdDbVertexRef

(

)

Constructor creates an instance of this class.

OdDbVertexRef() [2/7]

OdDbVertexRef::OdDbVertexRef	(	const OdDbCompoundObjectId &	comId,
		const OdDbSubentId &	subentId = OdDbSubentId(),
		const OdGePoint3d &	point3d = OdGePoint3d::kOrigin
	)

Sets the data members of the OdDbVertexRef.

Parameters

comId	[in] Component id.
subentId	[in] subentid.
point3d	[in] face subentid.

OdDbVertexRef() [3/7]

OdDbVertexRef::OdDbVertexRef

(

const OdDbFullSubentPath &

fullPath

)

Creates the OdDbVertexRef from an entity in a block table recordand referenced via a path of block inserts.

Parameters

fullPath

[in] Component id.

OdDbVertexRef() [4/7]

OdDbVertexRef::OdDbVertexRef

(

const OdDbEntity *

pEnt

)

Causes the OdDbVertexRef to maintain the OdDbObjectId of the given OdDbEntity. Moreover, if the entity is derived from OdDbPoint, it maintains its OdGePoint3d as OdGePoint3d.

Parameters

pEnt	[in] given entity.

OdDbVertexRef() [5/7]

OdDbVertexRef::OdDbVertexRef

(

const OdGePoint3d &

point3d

)

The constructor causes the OdDbVertexRef to maintain the OdGePoint3d.

Parameters

point3d

[in] given point.

OdDbVertexRef() [6/7]

OdDbVertexRef::OdDbVertexRef	(	ImpliedType	implType,
		const OdDbEdgeRef &	edgeRef,
		int	controlOrFitPointIndex = 0,
		const OdGePoint3d &	point3d = OdGePoint3d::kOrigin
	)

Creates the OdDbVertexRef from set of parameters.

Parameters

implType	[in] implied type.
controlOrFitPointIndex	[in] point index.
point3d	[in] point.

OdDbVertexRef() [7/7]

OdDbVertexRef::OdDbVertexRef

(

const OdDbVertexRef &

src

)

Creates the OdDbVertexRef from other OdDbVertexRef.

Parameters

src	[in] other OdDbVertexRef.

~OdDbVertexRef()

virtual OdDbVertexRef::~OdDbVertexRef ( )

virtual

Destructor destroys an instance of this class.

Member Function Documentation

copyFrom()

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

virtual

Initializes this reference using a given object.

Parameters

other

[in] other vertex.

Reimplemented from OdDbSubentRef.

createEntity()

OdDbEntityPtr OdDbVertexRef::createEntity ( ) const

virtual

Creates an entity using this vertex reference.

Returns

created entity.

Reimplemented from OdDbSubentRef.

createObject() [1/2]

static OdSmartPtr< OdDbVertexRef > OdDbVertexRef::createObject ( const OdDbObjectId  entId, const OdDbSubentId  subId, const OdGePoint3d &  point  )

static

The method sets the data members of the OdDbVertexRef.

Parameters

entId	[in] object id.
subId	[in] subentid.
point	[in] point.

createObject() [2/2]

static OdSmartPtr< OdDbVertexRef > OdDbVertexRef::createObject ( const OdGePoint3d &  )

static

Causes the OdDbVertexRef to maintain the OdGePoint3d.

Parameters

point3d

[in] given point.

entity()

virtual const OdDbCompoundObjectId & OdDbVertexRef::entity ( ) const

virtual

Checks whether this vertex reference is empty.

\If referencedRef() is not NULL, returns its OdDbCompoundObjectId, otherwise returns OdDbCompoundObjectId from the base-class OdDbSubentRef.

Reimplemented from OdDbSubentRef.

evaluateAndCacheGeometry()

virtual OdResult OdDbVertexRef::evaluateAndCacheGeometry ( )

virtual

Evaluates and caches the geometry.

Returns

eOk if geometry is cached.

Reimplemented from OdDbSubentRef.

evaluatePoint()

virtual OdResult OdDbVertexRef::evaluatePoint ( OdGePoint3d &  point ) const

virtual

Evaluates the point from the referenced geometry. If no geometry, returns the cached point coordinates.

Parameters

point

[out] evaluated point.

Returns

eOk if point is evaluated.

impliedType()

ImpliedType OdDbVertexRef::impliedType

(

)

const

Returns the implied type.

index()

int OdDbVertexRef::index

(

)

const

Returns the vertex index.

isValid()

virtual bool OdDbVertexRef::isValid ( ) const

virtual

Checks whether this vertex reference is valid.

Returns

true if veretex reference is valid.

Reimplemented from OdDbSubentRef.

ODRX_DECLARE_MEMBERS()

OdDbVertexRef::ODRX_DECLARE_MEMBERS

(

OdDbVertexRef

)

operator=()

OdDbVertexRef & OdDbVertexRef::operator=

(

const OdDbVertexRef &

other

)

Copies a given vertex reference to this reference.

Parameters

other

[in] other vertex.

point()

OdGePoint3d OdDbVertexRef::point

(

)

const

Returns the three-dimensional point directly held by this vertex reference.

referencedRef()

const OdDbGeomRef * OdDbVertexRef::referencedRef

(

)

const

Returns the geometry reference referenced by this vertex reference.

reset()

virtual void OdDbVertexRef::reset ( )

virtual

Resets this vertex reference.

Reimplemented from OdDbSubentRef.

subentId()

virtual OdDbSubentId OdDbVertexRef::subentId ( ) const

virtual

Returns the subent ID.

Reimplemented from OdDbSubentRef.

---

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

• DbGeomRef.h