Mako 7.3.0 API
IDOMPolyQuadraticBezierSegment Class Referenceabstract

Interface to a polyqualdratic Bézier segment. A polyqualdratic Bézier segment describes a set of quadratic Bézier curves from the starting point defined in the IDOMPathFigure, or from the end point of the previous segment, through a set of vertices, using specified control points. The Points attribute stores an off-curve control point (x2n-1, y2n-1) followed by the end point (x2n, y2n) for each quadratic Bézier curve (where n represents the quadratic Bézier curve). More...

#include <idompathgeometry.h>

Inheritance diagram for IDOMPolyQuadraticBezierSegment:

Classes

class  Data
 Initialization data. More...
 

Public Member Functions

virtual const CFPointVect & getPoints () const =0
 Retrieves the points that make up this segment. For quadratic beziers, the number of points will be a multiple of two. More...
 
virtual uint32 getPointsCount () const =0
 Retrieves the number of points in the points list. For quadratic beziers, the number of points will be a multiple of two. More...
 
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. More...
 
virtual IDOMPolyBezierSegmentPtr convertToCubicBezierSegment (IEDLClassFactory *factory, const FPoint &startPoint) const =0
 Create a segment that represents this curve using a cubic bezier. More...
 
- 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. More...
 
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. More...
 
virtual FRect getBounds (FPoint &startPoint) const =0
 Gets the conservative bounding box of the segment given the start point. More...
 
virtual const FPointgetEndPoint () const =0
 Gets the end point of the segment. More...
 
virtual bool getIsImmutable () const =0
 Determine if the segment is immutable (non-editable). More...
 
virtual void setImmutable ()=0
 Force the segment to be flagged immutable.
 
- Public Member Functions inherited from IEDLObject
virtual const CClassIDgetClassID () const =0
 Returns class ID of IEDLObject. More...
 
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. More...
 
virtual bool clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
 Create a copy of EDLObject. More...
 
- 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. More...
 
virtual int32 getRefCount () const =0
 Retrieve the current reference count of the actual object pointed to. More...
 
- Public Member Functions inherited from IDOMHashable
virtual ~IDOMHashable ()
 Virtual destructor.
 
virtual bool hash (uint64 &hash)=0
 Retrieve a hash for this object. More...
 
virtual uint64 hashE ()
 As hash(), but throws an exception if the operation fails. More...
 

Static Public Member Functions

static const CClassIDclassID ()
 Retrieves the class id of IDOMPolyQuadraticBezierSegment. More...
 
static EDL_API IDOMPolyQuadraticBezierSegmentPtr create (IEDLClassFactory *factory, bool isStroked=true, const CFPointVect &points=CFPointVect())
 Simplified creator for a quadratic bezier segment. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.
 

Detailed Description

Interface to a polyqualdratic Bézier segment. A polyqualdratic Bézier segment describes a set of quadratic Bézier curves from the starting point defined in the IDOMPathFigure, or from the end point of the previous segment, through a set of vertices, using specified control points. The Points attribute stores an off-curve control point (x2n-1, y2n-1) followed by the end point (x2n, y2n) for each quadratic Bézier curve (where n represents the quadratic Bézier curve).

Member Function Documentation

◆ addPoint()

virtual void IDOMPolyQuadraticBezierSegment::addPoint ( const FPoint point)
pure virtual

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

Parameters
pointPoint to append.

◆ classID()

static const CClassID& IDOMPolyQuadraticBezierSegment::classID ( )
inlinestatic

Retrieves the class id of IDOMPolyQuadraticBezierSegment.

Returns
CClassID. Returns the class id of the element.

◆ convertToCubicBezierSegment()

virtual IDOMPolyBezierSegmentPtr IDOMPolyQuadraticBezierSegment::convertToCubicBezierSegment ( IEDLClassFactory factory,
const FPoint startPoint 
) const
pure virtual

Create a segment that represents this curve using a cubic bezier.

Parameters
factoryPointer to the class factory to be used.
startPointThe start point for the curve.
Returns
IDOMPolyBezierSegmentPtr The resulting cubic bezier.

◆ create()

static EDL_API IDOMPolyQuadraticBezierSegmentPtr IDOMPolyQuadraticBezierSegment::create ( IEDLClassFactory factory,
bool  isStroked = true,
const CFPointVect &  points = CFPointVect() 
)
static

Simplified creator for a quadratic bezier segment.

Parameters
factoryThe factory to use.
isStrokedShould the segment be stroked, if used in a stroking path.
pointsThe segment points. Must be a multiple of two in length.
Returns
IDOMPolyLineSegmentPtr The new segment.

◆ getPoints()

virtual const CFPointVect& IDOMPolyQuadraticBezierSegment::getPoints ( ) const
pure virtual

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

Returns
CFPointVect The points.

◆ getPointsCount()

virtual uint32 IDOMPolyQuadraticBezierSegment::getPointsCount ( ) const
pure virtual

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

Returns
uint32 The size of the points list.

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