Mako 7.3.0 API
IDOMPathSegment Class Referenceabstract

Interface to path segment element. The path segment is the smallest unit in a path geometry. More...

#include <idompathgeometry.h>

Inheritance diagram for IDOMPathSegment:

Public Member Functions

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...
 

Additional Inherited Members

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

Detailed Description

Interface to path segment element. The path segment is the smallest unit in a path geometry.

See also
IDOMPathNode
IDOMPathGeometry
IDOMPathFigure

Segments may be lines or curves. One or more segments are combined into a PathFigure definition. A PathFigure is a single shape comprised of continuous segments. One or more PathFigures collectively define an entire path geometry.

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

Member Function Documentation

◆ getBounds()

virtual FRect IDOMPathSegment::getBounds ( FPoint startPoint) const
pure virtual

Gets the conservative bounding box of the segment given the start point.

Parameters
startPointThe start point of the segment.
Returns
FRect The conservative bounding box of the segment.

◆ getEndPoint()

virtual const FPoint& IDOMPathSegment::getEndPoint ( ) const
pure virtual

Gets the end point of the segment.

Returns
FPoint The end point.

◆ getIsImmutable()

virtual bool IDOMPathSegment::getIsImmutable ( ) const
pure virtual

Determine if the segment is immutable (non-editable).

Returns
bool True if the segment may not be edited.

◆ getIsStroked()

virtual bool IDOMPathSegment::getIsStroked ( ) const
pure virtual

Retrieves the value for IsStroked. IsStroked specifies whether the stroke for this segment of the path is drawn. Can be true or false.

Returns
bool Returns true if this line segment is stroked, false if it is not.

◆ setIsStroked()

virtual void IDOMPathSegment::setIsStroked ( bool  isStroked)
pure virtual

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.

Parameters
isStrokedNew value of IsStroked.

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