IDOMPolyLineSegment Class Reference

Interface to a polyline segment node. A polyline segment describes a polygonal drawing containing an arbitrary number of individual vertices. The Points attribute defines the vertices. More...

#include <idompathgeometry.h>

Inheritance diagram for IDOMPolyLineSegment:

Classes
class	Data
	Initialization data. More...

Public Member Functions
virtual const CFPointVect &	getPoints () const =0
	Retrieves the points that make up this segment.
virtual uint32	getPointsCount () const =0
	Retrieves the number of points in the segment.
virtual void	clearPoints ()=0
	Clears the points list. An exception is thrown if this segment is immutable.
virtual void	addPoint (const FPoint &point)=0
	Appends a point to the list. An exception is thrown if this segment is immutable.
Public Member Functions inherited from IDOMPathSegment
virtual bool	getIsStroked () const =0
	Retrieves the value for IsStroked. IsStroked specifies whether the stroke for this segment of the path is drawn. Can be true or false.
virtual void	setIsStroked (bool isStroked)=0
	Sets the value of IsStroked. IsStroked specifies whether the stroke for this segment of the path is drawn. Can be true or false. An exception is thrown if this segment is immutable.
virtual FRect	getBounds (FPoint &startPoint) const =0
	Gets the conservative bounding box of the segment given the start point.
virtual const FPoint &	getEndPoint () const =0
	Gets the end point of the segment.
virtual bool	getIsImmutable () const =0
	Determine if the segment is immutable (non-editable).
virtual void	setImmutable ()=0
	Force the segment to be flagged immutable.
Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject.
virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory.
virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.
Public Member Functions inherited from IDOMHashable
virtual	~IDOMHashable ()
	Virtual destructor.
virtual bool	hash (uint64 &hash)=0
	Retrieve a hash for this object.
virtual uint64	hashE ()
	As hash(), but throws an exception if the operation fails.

Static Public Member Functions
static const CClassID &	classID ()
	Retrieves class id of IDOMPolyLineSegment.
static EDL_API IDOMPolyLineSegmentPtr	create (IEDLClassFactory *factory, bool isStroked=true, const CFPointVect &points=CFPointVect())
	Simplified creator for a line segment.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

Interface to a polyline segment node. A polyline segment describes a polygonal drawing containing an arbitrary number of individual vertices. The Points attribute defines the vertices.

Member Function Documentation

addPoint()

virtual void IDOMPolyLineSegment::addPoint ( const FPoint & point )

pure virtual

Appends a point to the list. An exception is thrown if this segment is immutable.

Parameters

point

Point to append.

classID()

static const CClassID & IDOMPolyLineSegment::classID ( )

inlinestatic

Retrieves class id of IDOMPolyLineSegment.

Returns

CClassID class id of the element.

create()

static EDL_API IDOMPolyLineSegmentPtr IDOMPolyLineSegment::create ( IEDLClassFactory * factory, bool isStroked = true, const CFPointVect & points = CFPointVect() )

static

Simplified creator for a line segment.

Parameters

factory	The factory to use.
isStroked	Should the segment be stroked, if used in a stroking path.
points	The segment points.

Returns

IDOMPolyLineSegmentPtr The new segment.

getPoints()

virtual const CFPointVect & IDOMPolyLineSegment::getPoints ( ) const

pure virtual

Retrieves the points that make up this segment.

Returns

CFPointVect The points.

getPointsCount()

virtual uint32 IDOMPolyLineSegment::getPointsCount ( ) const

pure virtual

Retrieves the number of points in the segment.

Returns

uint32 The size of the points list.

---

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

• idompathgeometry.h