IDOMPolyBezierSegment Class Reference

Interface to a path segment node describing a set of cubic Bézier curves. More...

#include <idompathgeometry.h>

Inheritance diagram for IDOMPolyBezierSegment:

Classes
class	Data
	Initialization data. More...

Public Member Functions
virtual const CFPointVect &	getPoints () const =0
	Retrieves the points that make up this segment. For beziers, the number of points will be a multiple of three.
virtual uint32	getPointsCount () const =0
	Retrieves the number of points in the points list. For beziers, the number of points will be a multiple of three.
virtual void	clearPoints ()=0
	Clears the points list. An exception is thrown if this segment is immutable.
virtual void	addPoint (const FPoint &point)=0
	Append 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 IDOMPolyBezierSegment.
static EDL_API IDOMPolyBezierSegmentPtr	create (IEDLClassFactory *factory, bool isStroked=true, const CFPointVect &points=CFPointVect())
	Simplified creator for a bezier segment.

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

Detailed Description

Interface to a path segment node describing a set of cubic Bézier curves.

      Bézier curves are drawn from the previous point in the path figure or the previous Bézier curve in the
      segment and terminate at the third point (x3n,y3n) in the Points attribute (where n is the curve being
      drawn). The tangents and curvature of each Bézier curve are controlled by the first two control points
      (x3n-2,y3n-2 and x3n-1,y3n-1) in the Points attribute. The Points attribute contains a multiple of three
      whitespace delimited pairs of comma delimited x,y values.

Member Function Documentation

addPoint()

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

pure virtual

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

Parameters

point

Point to append.

classID()

static const CClassID & IDOMPolyBezierSegment::classID ( )

inlinestatic

Retrieves class id of IDOMPolyBezierSegment.

Returns

CClassID class id of the element.

create()

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

static

Simplified creator for a bezier segment.

Parameters

factory	The factory to use.
isStroked	Should the segment be stroked, if used in a stroking path.
points	The segment points. Must be a multiple of three in length.

Returns

IDOMPolyLineSegmentPtr The new segment.

getPoints()

virtual const CFPointVect & IDOMPolyBezierSegment::getPoints ( ) const

pure virtual

Retrieves the points that make up this segment. For beziers, the number of points will be a multiple of three.

Returns

CFPointVect The points.

getPointsCount()

virtual uint32 IDOMPolyBezierSegment::getPointsCount ( ) const

pure virtual

Retrieves the number of points in the points list. For beziers, the number of points will be a multiple of three.

Returns

uint32 The size of the points list.

---

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

• idompathgeometry.h