OdGiPolyline Class Reference

#include <GiPolyline.h>

Inheritance diagram for OdGiPolyline:

Public Types
enum	SegType {   kLine , kArc , kCoincident , kPoint ,   kEmpty }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiPolyline)
virtual unsigned int	numVerts () const =0
virtual bool	isClosed () const =0
virtual OdGeVector3d	normal () const =0
virtual double	thickness () const =0
virtual double	getConstantWidth () const =0
virtual bool	hasWidth () const =0
virtual bool	hasPlinegen () const =0
virtual double	elevation () const =0
virtual SegType	segType (unsigned int index) const =0
virtual void	getLineSegAt (unsigned int index, OdGeLineSeg2d &ln) const =0
virtual void	getLineSegAt (unsigned int index, OdGeLineSeg3d &ln) const =0
virtual void	getArcSegAt (unsigned int index, OdGeCircArc2d &arc) const =0
virtual void	getArcSegAt (unsigned int index, OdGeCircArc3d &arc) const =0
virtual void	getPointAt (unsigned int index, OdGePoint2d &pt) const =0
virtual double	getBulgeAt (unsigned int index) const =0
virtual void	getWidthsAt (unsigned int index, double &startWidth, double &endWidth) const =0
virtual OdRxObjectPtr	getDbPolyline () const =0
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 OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

This class implements the OdGi equivalent of an OdDbPolyline or "lightweight" polyline.

Remarks

Instances of this class are used to pass lightweight polyline data through the ODA Platform vectorization framework.

<group OdGi_Classes>

Definition at line 49 of file GiPolyline.h.

Member Enumeration Documentation

SegType

enum OdGiPolyline::SegType

Represents segment types.

Enumerator
kLine
kArc
kCoincident
kPoint
kEmpty

Definition at line 57 of file GiPolyline.h.

Member Function Documentation

elevation()

virtual double OdGiPolyline::elevation ( ) const

pure virtual

Retrieves the elevation for this entity.

Returns

an elevation as a value of the double type.

getArcSegAt() [1/2]

virtual void OdGiPolyline::getArcSegAt ( unsigned int  index, OdGeCircArc2d &  arc  ) const

pure virtual

Retrieves the arc segment starting at the specified index.

Parameters

index	[in] Segment index.
arc	[out] 2D arc segment to get.

getArcSegAt() [2/2]

virtual void OdGiPolyline::getArcSegAt ( unsigned int  index, OdGeCircArc3d &  arc  ) const

pure virtual

Retrieves the arc segment starting at the specified index.

Parameters

index	[in] Segment index.
arc	[out] 3D arc segment to get.

getBulgeAt()

virtual double OdGiPolyline::getBulgeAt ( unsigned int  index ) const

pure virtual

Retrieves the bulge value for a specified point.

Parameters

index

[in] Segment index.

Returns

bulge as a value of the double type.

getConstantWidth()

virtual double OdGiPolyline::getConstantWidth ( ) const

pure virtual

Retrieves the constant width for this entity.

Returns

constant width for this entity as a value of the double type.

getDbPolyline()

virtual OdRxObjectPtr OdGiPolyline::getDbPolyline ( ) const

pure virtual

Retrieves the original OdDbPolyline object from which this OdGiPolyline was created.

Returns

smart pointer to the underlaying OdDbPolyline object.

getLineSegAt() [1/2]

virtual void OdGiPolyline::getLineSegAt ( unsigned int  index, OdGeLineSeg2d &  ln  ) const

pure virtual

Retrieves the line segment starting at the specified index.

Parameters

index	[in] Segment index.
ln	[out] 2D line segment to get.

getLineSegAt() [2/2]

virtual void OdGiPolyline::getLineSegAt ( unsigned int  index, OdGeLineSeg3d &  ln  ) const

pure virtual

Retrieves the line segment starting at the specified index.

Parameters

index	[in] Segment index.
ln	[out] 3D line segment to get.

getPointAt()

virtual void OdGiPolyline::getPointAt ( unsigned int  index, OdGePoint2d &  pt  ) const

pure virtual

Retrieves a specified point from this entity.

Parameters

index	[in] Segment index.
arc	[out] 2D point to get.

getWidthsAt()

virtual void OdGiPolyline::getWidthsAt ( unsigned int  index, double &  startWidth, double &  endWidth  ) const

pure virtual

Retrieves the start and end widths for a specified point.

Parameters

index	[in] Segment index.
startWidth	[out] Start width.
endWidth	[out] End width.

hasPlinegen()

virtual bool OdGiPolyline::hasPlinegen ( ) const

pure virtual

Retrieves the PLINEGEN flag for this entity. If PLINEGEN is true, linetype generation will be patterned across the entire polyline, rather than being done for each segment individually.

Returns

true if this entity has the PLINEGEN flag set to true, false otherwise.

hasWidth()

virtual bool OdGiPolyline::hasWidth ( ) const

pure virtual

Checks whether this entity has width data.

Returns

true if the vertices in this entity contain start and end width data, false otherwise.

isClosed()

virtual bool OdGiPolyline::isClosed ( ) const

pure virtual

Checks whether this polyline is closed.

Returns

true if polyline is closed, false otherwise

normal()

virtual OdGeVector3d OdGiPolyline::normal ( ) const

pure virtual

Retrieves the normal vector for this entity.

Returns

normal to this entity.

numVerts()

virtual unsigned int OdGiPolyline::numVerts ( ) const

pure virtual

Retrieves the number of vertices in the entity. returns quantity of vertices in the entity.

ODRX_DECLARE_MEMBERS()

OdGiPolyline::ODRX_DECLARE_MEMBERS

(

OdGiPolyline

)

segType()

virtual SegType OdGiPolyline::segType ( unsigned int  index ) const

pure virtual

Retrieves the segment type at the specified index.

Parameters

index

[in] Segment index.

Returns

segment type as a value from the SegType enumeration.

thickness()

virtual double OdGiPolyline::thickness ( ) const

pure virtual

Retrieves the thickness for this entity.

Returns

thickness as a value of the double type.

---

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

• GiPolyline.h