Mako 7.5.0 API
Loading...
Searching...
No Matches
IDOMPathGeometryBuilder Class Referenceabstract

Interface to a path geometry builder. More...

#include <idompathgeometry.h>

Inheritance diagram for IDOMPathGeometryBuilder:

Public Member Functions

virtual void moveTo (const FPoint &point, bool absolute=true)=0
 Move to the given user point. Throws an IEDLError exception on failure.
 
virtual void lineTo (const FPoint &point, bool absolute=true, bool stroked=true)=0
 Append a line segment to the current path. Throws an IEDLError exception on failure.
 
virtual void curveTo (const FPoint &control0, const FPoint &control1, const FPoint &point, bool absolute=true, bool stroked=true)=0
 Append a section of a cubic Bézier curve to the current path. Throws an IEDLError exception on failure.
 
virtual void quadCurveTo (const FPoint &control, const FPoint &point, bool absolute=true, bool stroked=true)=0
 Append a section of a quadratic Bézier curve to the current path. Throws an IEDLError exception on failure.
 
virtual void arcTo (const FPoint &radius, double rotation, bool isLargeArc, IDOMArcSegment::eSweepDirection sweepDirection, const FPoint &point, bool absolute=true, bool stroked=true)=0
 Append an elliptical arc segment to the current path. Throws an IEDLError exception on failure.
 
virtual void close (bool stroked=true)=0
 Close the subpath, if it is not already. Throws an IEDLError exception on failure.
 
virtual IDOMPathGeometryPtr createGeometry (IEDLClassFactory *pFactory, IDOMPathGeometry::eFillRule fillRule, bool ignoreDegenerateSubpaths=false, const FMatrix &renderTransform=FMatrix()) const =0
 Get the path as geometry, in user units according to the given CTM and fill rule. Throws an IEDLError exception on failure.
 
- Public Member Functions inherited from IEDLObject
virtual const CClassIDgetClassID () 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.
 

Static Public Member Functions

static const CClassIDclassID ()
 Retrieves class id of IDOMPathGeometryBuilder.
 
static EDL_API IDOMPathGeometryBuilderPtr create (IEDLClassFactory *factory)
 Simplified creation function for IDOMPathGeometryBuilder. Throws an IEDLError exception on failure.
 

Additional Inherited Members

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

Detailed Description

Interface to a path geometry builder.

See also
IDOMPathGeometry
      A path geometry builder can be used to build geometry using PostScript style path construction commands.

      Instances of this type use exceptions of IEDLError for error handling.

Member Function Documentation

◆ arcTo()

virtual void IDOMPathGeometryBuilder::arcTo ( const FPoint & radius,
double rotation,
bool isLargeArc,
IDOMArcSegment::eSweepDirection sweepDirection,
const FPoint & point,
bool absolute = true,
bool stroked = true )
pure virtual

Append an elliptical arc segment to the current path. Throws an IEDLError exception on failure.

Parameters
radiusThe x and y radius of the arc.
rotationThe rotation angle.
isLargeArcWhether or not the large arc should be used.
sweepDirectionThe direction of the sweep - clockwise or counter clockwise - between the start and end points.
pointThe end point of the arc.
absoluteWhether the points are specified in absolute coordinates. The default value is true.
strokedWhether the stroke for this segment of the path is drawn. The default value is true.

◆ classID()

static const CClassID & IDOMPathGeometryBuilder::classID ( )
inlinestatic

Retrieves class id of IDOMPathGeometryBuilder.

Returns
CClassID class id of the path geometry builder.

◆ close()

virtual void IDOMPathGeometryBuilder::close ( bool stroked = true)
pure virtual

Close the subpath, if it is not already. Throws an IEDLError exception on failure.

Parameters
strokedWhether the stroke for this segment of the path is drawn. The default value is true.

◆ create()

static EDL_API IDOMPathGeometryBuilderPtr IDOMPathGeometryBuilder::create ( IEDLClassFactory * factory)
static

Simplified creation function for IDOMPathGeometryBuilder. Throws an IEDLError exception on failure.

Parameters
factoryThe EDL class factory.
Returns
IDOMPathGeometryBuilderPtr A smart pointer to the geometry builder.

◆ createGeometry()

virtual IDOMPathGeometryPtr IDOMPathGeometryBuilder::createGeometry ( IEDLClassFactory * pFactory,
IDOMPathGeometry::eFillRule fillRule,
bool ignoreDegenerateSubpaths = false,
const FMatrix & renderTransform = FMatrix() ) const
pure virtual

Get the path as geometry, in user units according to the given CTM and fill rule. Throws an IEDLError exception on failure.

Parameters
fillRuleThe fill rule.
ignoreDegenerateSubpathsWhether to generate ignore degenerate subpaths. The default value is false.
renderTransformThe transform to apply to the geometry.
Returns
IDOMPathGeometryPtr The path geometry.

◆ curveTo()

virtual void IDOMPathGeometryBuilder::curveTo ( const FPoint & control0,
const FPoint & control1,
const FPoint & point,
bool absolute = true,
bool stroked = true )
pure virtual

Append a section of a cubic Bézier curve to the current path. Throws an IEDLError exception on failure.

Parameters
control0The first control point used to define the curve.
control1The second control point used to define the curve.
pointThe new end point.
absoluteWhether the points are specified in absolute coordinates. The default value is true.
strokedWhether the stroke for this segment of the path is drawn. The default value is true.

◆ lineTo()

virtual void IDOMPathGeometryBuilder::lineTo ( const FPoint & point,
bool absolute = true,
bool stroked = true )
pure virtual

Append a line segment to the current path. Throws an IEDLError exception on failure.

Parameters
pointThe new end point.
absoluteWhether the points are specified in absolute coordinates. The default value is true.
strokedWhether the stroke for this segment of the path is drawn. The default value is true.

◆ moveTo()

virtual void IDOMPathGeometryBuilder::moveTo ( const FPoint & point,
bool absolute = true )
pure virtual

Move to the given user point. Throws an IEDLError exception on failure.

Parameters
pointThe point to move to.
absoluteWhether the point is specified in absolute coordinates. The default value is true.

◆ quadCurveTo()

virtual void IDOMPathGeometryBuilder::quadCurveTo ( const FPoint & control,
const FPoint & point,
bool absolute = true,
bool stroked = true )
pure virtual

Append a section of a quadratic Bézier curve to the current path. Throws an IEDLError exception on failure.

Parameters
controlThe control point used to define the curve.
pointThe new end point.
absoluteWhether the points are specified in absolute coordinates. The default value is true.
strokedWhether the stroke for this segment of the path is drawn. The default value is true.

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