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:

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

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

Friends
aip::PathSegPoint *	__accessImpl (const ArtboardSegPoint &)
ArtboardSegPoint	__accessCtor (const aip::PathSegPoint &)

Detailed Description

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

Constructor & Destructor Documentation

ArtboardSegPoint() [1/4]

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

ArtboardSegPoint() [2/4]

hdi::core::ArtboardSegPoint::ArtboardSegPoint

(

const ArtboardSegPoint &

segPt_

)

ArtboardSegPoint copy constructor.

Author

GW

Date

08/2013

Parameters

segPt_

Existing ArtboardSegPoint object to copy values from

ArtboardSegPoint() [3/4]

hdi::core::ArtboardSegPoint::ArtboardSegPoint	(	const ArtboardPoint &	pt_,
		const bool	corner_ = true
	)

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

ArtboardSegPoint() [4/4]

hdi::core::ArtboardSegPoint::ArtboardSegPoint	(	const ArtboardPoint &	p_,
		const ArtboardPoint &	in_,
		const ArtboardPoint &	out_,
		const bool	corner_ = true
	)

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

~ArtboardSegPoint()

virtual hdi::core::ArtboardSegPoint::~ArtboardSegPoint ( )

virtual

ArtboardSegPoint destructor.

Author

GW

Date

08/2013

Member Function Documentation

curved()

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

operator!=()

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

operator=()

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

operator==()

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

corner

bool hdi::core::ArtboardSegPoint::corner

Whether the seg point is a corner