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

Describes a segment point of a bezier path on the Illustrator artboard. More...

#include <hdicoreArtboardSegPoint.h>

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

Public Member Functions

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

Public Attributes

ArtboardPoint p
 Anchor point.
 
ArtboardPoint in
 Segment "in" control point.
 
ArtboardPoint out
 Segment "out" control point.
 
bool corner
 

Friends

plugin::PathSegPoint * __accessImpl (const ArtboardSegPoint &)
 
ArtboardSegPoint __accessCtor (const plugin::PathSegPoint &)
 

Detailed Description

Describes a segment point of a bezier path on the Illustrator artboard.

Constructor & Destructor Documentation

hdi::core::ArtboardSegPoint::ArtboardSegPoint ( )

Constructs an ArtboardSegPoint object with the p, in, and out points at (0,0) and corner set to false.

Author
GW
Date
08/2013
hdi::core::ArtboardSegPoint::ArtboardSegPoint ( const ArtboardSegPoint segPt_)

ArtboardSegPoint copy constructor.

Author
GW
Date
08/2013
Parameters
segPt_Existing ArtboardSegPoint object to copy values from
hdi::core::ArtboardSegPoint::ArtboardSegPoint ( const ArtboardPoint pt_,
const bool  corner_ 
)

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

Author
GW
Date
08/2013
Parameters
pt_Anchor point, control points
corner_Whether the segment point is a corner
hdi::core::ArtboardSegPoint::ArtboardSegPoint ( const ArtboardPoint p_,
const ArtboardPoint in_,
const ArtboardPoint out_,
const bool  corner_ 
)

Constructs an ArtboardSegPoint from given points.

Author
GW
Date
08/2013
Parameters
p_Anchor point
in_"In" control point
out_"Out" control point
corner_Whether the segment point is a corner
virtual hdi::core::ArtboardSegPoint::~ArtboardSegPoint ( )
virtual

ArtboardSegPoint destructor.

Author
GW
Date
08/2013

Member Function Documentation

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

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

Author
GW
Date
08/2013
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::ArtboardSegPoint::operator!= ( const ArtboardSegPoint rhs_) const
virtual

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

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

Sets an ArtboardSegPoint object from another ArtboardSegPoint object.

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

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

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

Member Data Documentation

bool hdi::core::ArtboardSegPoint::corner

Whether the seg point is a corner