Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
Public Member Functions | Public Attributes | List of all members
hdi::core::SegPoint Class Reference

Describes a segment point of a bezier path, typically in an Illustrator document view. More...

#include <hdicoreSegPoint.h>

Collaboration diagram for hdi::core::SegPoint:
Collaboration graph
[legend]

Public Member Functions

 SegPoint ()
 Constructs a SegPoint object with the p, in, and out points at (0,0) More...
 
 SegPoint (const SegPoint &segPt_)
 SegPoint copy constructor. More...
 
 SegPoint (const Point &pt_)
 Constructs a SegPoint from a given point for the anchor and both control points. More...
 
 SegPoint (const Point &p_, const Point &in_, const Point &out_)
 Constructs a SegPoint from given points. More...
 
virtual ~SegPoint ()
 SegPoint destructor. More...
 
virtual SegPointoperator= (const SegPoint &rhs_)
 Sets a SegPoint object from another SegPoint object. More...
 
virtual bool operator== (const SegPoint &rhs_) const
 Tests whether a given SegPoint object is the same as another. More...
 
virtual bool operator!= (const SegPoint &rhs_) const
 Tests whether a given SegPoint object is not the same as another. More...
 
virtual bool curved (const SegPoint &segPt2_) const
 Gets whether the path formed by two segment points is curved. More...
 

Public Attributes

Point p
 Anchor point.
 
Point in
 Segment "in" control point.
 
Point out
 Segment "out" control point.
 

Detailed Description

Describes a segment point of a bezier path, typically in an Illustrator document view.

Constructor & Destructor Documentation

hdi::core::SegPoint::SegPoint ( )

Constructs a SegPoint object with the p, in, and out points at (0,0)

Author
GW
Date
07/2014
hdi::core::SegPoint::SegPoint ( const SegPoint segPt_)

SegPoint copy constructor.

Author
GW
Date
07/2014
Parameters
segPt_Existing SegPoint object to copy values from
hdi::core::SegPoint::SegPoint ( const Point pt_)

Constructs a SegPoint from a given point for the anchor and both control points.

Author
GW
Date
07/2014
Parameters
pt_Anchor point, control points
hdi::core::SegPoint::SegPoint ( const Point p_,
const Point in_,
const Point out_ 
)

Constructs a SegPoint from given points.

Author
GW
Date
07/2014
Parameters
p_Anchor point
in_"In" control point
out_"Out" control point
virtual hdi::core::SegPoint::~SegPoint ( )
virtual

SegPoint destructor.

Author
GW
Date
07/2014

Member Function Documentation

virtual bool hdi::core::SegPoint::curved ( const SegPoint segPt2_) const
virtual

Gets whether the path formed by two segment points is curved.

Author
GW
Date
07/2014
Parameters
segPt2_Second segment point in the path
Returns
true if the path formed by the two points is curved, false otherwise
virtual bool hdi::core::SegPoint::operator!= ( const SegPoint rhs_) const
virtual

Tests whether a given SegPoint object is not the same as another.

Author
GW
Date
07/2014
Parameters
rhs_SegPoint to compare against (righthand side of inequality operator)
Returns
true for the target and rhs_ being different segment points, false otherwise
virtual SegPoint& hdi::core::SegPoint::operator= ( const SegPoint rhs_)
virtual

Sets a SegPoint object from another SegPoint object.

Author
GW
Date
07/2014
Parameters
rhs_Righthand side of the = operator; the SegPoint to pull values from
Returns
The target SegPoint object, with its values updated
virtual bool hdi::core::SegPoint::operator== ( const SegPoint rhs_) const
virtual

Tests whether a given SegPoint object is the same as another.

Author
GW
Date
07/2014
Parameters
rhs_SegPoint to compare against (righthand side of equality operator)
Returns
true for the target and rhs_ being the same segment point, false otherwise