Allows for cubic bezier calculations and manipulation (e.g. division, tangents, normals, etc.) More...

#include <hdicoreBezier.h>

Public Types
enum	AdjustmentResult { AdjustmentReflectedStartOut = 1 << 0 , AdjustmentReflectedEndIn = 1 << 1 , AdjustmentRotatedStartOut = 1 << 2 , AdjustmentRotatedEndIn = 1 << 3 }
	Indicates what happened when a bezier was adjusted to pass through a point.

Public Member Functions
	Bezier ()
	Constructs a new Bezier object with all points at (0,0)

	Bezier (const Bezier &bez_)
	Constructs a new Bezier object from an existing Bezier object (copy constructor)

	Bezier (const ArtboardSegPoint &segPt1_, const ArtboardSegPoint &segPt2_)
	Constructs a new Bezier object from two segment endpoints.

	Bezier (const ArtboardPoint &start_, const ArtboardPoint &startOut_, const ArtboardPoint &endIn_, const ArtboardPoint &end_)
	Constructs a new Bezier object from individual component points.

virtual	~Bezier ()
	Destructs a Bezier object.

virtual Bezier &	operator= (const Bezier &rhs_)
	Allows one Bezier object to be assigned from another.

virtual ArtboardPoint	startPoint () const
	Gets the first anchor point of the bezier.

virtual ArtboardPoint	startOutPoint () const
	Gets the first control point of the bezier.

virtual ArtboardPoint	endInPoint () const
	Gets the second control point of the bezier.

virtual ArtboardPoint	endPoint () const
	Gets the second anchor point of the bezier.

virtual AdjustmentResult	adjustThruPoint (const ArtboardPoint &pt_, const double t_)
	Adjusts the bezier such that the given t-value will pass through the provided point.

virtual void	divide (const double t_, Bezier &bez1__, Bezier &bez2__) const
	Splits the target bezier into two separate beziers at a given t-value.

virtual Bezier	section (const double startT_, const double endT_) const
	Gets a section of the target bezier, from a starting t-value to an ending t-value.

virtual ArtboardPoint	evaluate (const double t_) const
	Evaluates a given t-value along the target bezier as a point on the artboard.

virtual double	length () const
	Gets the length of the bezier.

virtual double	sublength (const double startT_, const double endT_) const
	Gives approximate length of a bezier from t-value startT_ to t-value endT_.

virtual double	tAtLength (const double length_) const
	Gives the t-value at a specific length along the target bezier.

virtual void	setPoints (const ArtboardPoint &start_, const ArtboardPoint &startOut_, const ArtboardPoint &endIn_, const ArtboardPoint &end_)
	Sets the anchor and control points of the bezier.

virtual Angle	tangentAngle (const double t_) const
	Gets the tangent angle at some t-value along the bezier.

virtual Angle	normalAngle (const double t_) const
	Gets the normal angle at some t-value along the bezier.

virtual bool	curved () const
	Determines whether the bezier has a curved path.

virtual bool	radius (const double t_, double &radius__) const
	Gets the radius of the curve at some t-value along the bezier.

virtual bool	center (const double t_, ArtboardPoint &center__) const
	Gets the center point of the curve at some t-value along the bezier.

virtual bool	radiusAndCenter (const double t_, double &radius__, ArtboardPoint &center__) const
	Gets both the radius and center point of the curve at some t-value along the bezier.

virtual bool	isCircularArc () const
	Gets whether the bezier describes an arc segment of a circle.

virtual ArtboardRect	bounds () const
	Gets the bounds rect for the target bezier; that is, the rect that completely encloses all the control points, NOT that rect that encloses the extent of the bezier curvature.

virtual bool	operator== (const Bezier &rhs_) const
	Tests whether a given Bezier object is the same as another.

virtual bool	operator!= (const Bezier &rhs_) const
	Tests whether a given Bezier object is not the same as another.

Friends
aip::Bezier *	__accessImpl (const Bezier &)

Bezier	__accessCtor (const aip::Bezier &)

Detailed Description

Allows for cubic bezier calculations and manipulation (e.g. division, tangents, normals, etc.)

Constructor & Destructor Documentation

◆ Bezier() [1/4]

hdi::core::Bezier::Bezier ( )

Constructs a new Bezier object with all points at (0,0)

Author: GW

Date: 08/2013

◆ Bezier() [2/4]

hdi::core::Bezier::Bezier ( const Bezier & bez_ )

Constructs a new Bezier object from an existing Bezier object (copy constructor)

Author: GW

Date: 08/2013

Parameters

bez_	Existing Bezier object

◆ Bezier() [3/4]

hdi::core::Bezier::Bezier	(	const ArtboardSegPoint &	segPt1_,
		const ArtboardSegPoint &	segPt2_
	)

Constructs a new Bezier object from two segment endpoints.

Author: GW

Date: 08/2013

Parameters

segPt1_	First segment point
segPt2_	Second segment point

Note: This will ultimately call setPoints() internally with args segPt1_.p, segPt1_.out, segPt2_.in, and segPt2_.p, respectively.

◆ Bezier() [4/4]

hdi::core::Bezier::Bezier	(	const ArtboardPoint &	start_,
		const ArtboardPoint &	startOut_,
		const ArtboardPoint &	endIn_,
		const ArtboardPoint &	end_
	)

Constructs a new Bezier object from individual component points.

Author: GW

Date: 08/2013

Parameters

start_	First anchor point
startOut_	First control point
endIn_	Second control point
end_	Second anchor point

◆ ~Bezier()

virtual hdi::core::Bezier::~Bezier ( )

virtual

Destructs a Bezier object.

Author: GW

Date: 08/2013

Member Function Documentation

◆ adjustThruPoint()

virtual AdjustmentResult hdi::core::Bezier::adjustThruPoint	(	const ArtboardPoint &	pt_,
		const double	t_
	)

virtual

Adjusts the bezier such that the given t-value will pass through the provided point.

Author: GW

Date: 08/2013

Parameters

pt_	Point the bezier should pass through at t_
t_	T-value along the bezier to force through pt_

Returns: An enum value describing how the bezier was adjusted

◆ bounds()

virtual ArtboardRect hdi::core::Bezier::bounds ( ) const

virtual

Gets the bounds rect for the target bezier; that is, the rect that completely encloses all the control points, NOT that rect that encloses the extent of the bezier curvature.

Author: GW

Date: 08/2013

Returns: The rectangle that completely contains the target bezier

◆ center()

virtual bool hdi::core::Bezier::center	(	const double	t_,
		ArtboardPoint &	center__
	)		const

virtual

Gets the center point of the curve at some t-value along the bezier.

Author: GW

Date: 08/2013

Parameters

t_	T-value on the bezier whose radius is needed
center__	Return-by-reference for the center point of the curve of the bezier at t_

Returns: true for success, false for failure (i.e. straight beziers do not have a center point)

◆ curved()

virtual bool hdi::core::Bezier::curved ( ) const

virtual

Determines whether the bezier has a curved path.

Author: GW

Date: 08/2013

Returns: true for curved beziers, false for straight

◆ divide()

virtual void hdi::core::Bezier::divide	(	const double	t_,
		Bezier &	bez1__,
		Bezier &	bez2__
	)		const

virtual

Splits the target bezier into two separate beziers at a given t-value.

Author: GW

Date: 08/2013

Parameters

t_	T-value along the target bezier to perform the split
bez1__	Return-by-reference for the first bezier resulting from the split
bez2__	Return-by-reference for the second bezier resulting from the split

◆ endInPoint()

virtual ArtboardPoint hdi::core::Bezier::endInPoint ( ) const

virtual

Gets the second control point of the bezier.

Author: GW

Date: 08/2013

Returns: The second control point, AKA the end-in point

◆ endPoint()

virtual ArtboardPoint hdi::core::Bezier::endPoint ( ) const

virtual

Gets the second anchor point of the bezier.

Author: GW

Date: 08/2013

Returns: The second anchor point, AKA the end point

◆ evaluate()

virtual ArtboardPoint hdi::core::Bezier::evaluate ( const double t_ ) const

virtual

Evaluates a given t-value along the target bezier as a point on the artboard.

Author: GW

Date: 08/2013

Parameters

t_	T-value along the bezier for the point in question

Returns: The point for the given t-value along the target bezier

◆ isCircularArc()

virtual bool hdi::core::Bezier::isCircularArc ( ) const

virtual

Gets whether the bezier describes an arc segment of a circle.

Author: GW

Date: 08/2013

Returns: true if the bezier represents a circular arc segment, false otherwise

◆ length()

virtual double hdi::core::Bezier::length ( ) const

virtual

Gets the length of the bezier.

Author: GW

Date: 08/2013

Returns: The length of the target bezier in points

◆ normalAngle()

virtual Angle hdi::core::Bezier::normalAngle ( const double t_ ) const

virtual

Gets the normal angle at some t-value along the bezier.

Author: GW

Date: 08/2013

Parameters

t_	T-value on the bezier whose normal angle is needed

Returns: The angle of the normal at the given t-value, or the normal angle at 0.0 for values less than 0.0, or the normal angle at 1.0 for values greater than 1.0

◆ operator!=()

virtual bool hdi::core::Bezier::operator!= ( const Bezier & rhs_ ) const

virtual

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

Author: GW

Date: 08/2013

Parameters

rhs_	Bezier to compare against (righthand side of inequality operator)

Returns: true for the target and rhs_ being different beziers (having unequal anchor and control points), false otherwise

◆ operator=()

virtual Bezier & hdi::core::Bezier::operator= ( const Bezier & rhs_ )

virtual

Allows one Bezier object to be assigned from another.

Author: GW

Date: 08/2013

Parameters

rhs_	Righthand side of the = operator; the object to copy values from

Returns: The target Bezier object, but with its value updated to match that of rhs_

◆ operator==()

virtual bool hdi::core::Bezier::operator== ( const Bezier & rhs_ ) const

virtual

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

Author: GW

Date: 08/2013

Parameters

rhs_	Bezier to compare against (righthand side of equality operator)

Returns: true for the target and rhs_ being the same bezier (having equal anchor and control points), false otherwise

◆ radius()

virtual bool hdi::core::Bezier::radius	(	const double	t_,
		double &	radius__
	)		const

virtual

Gets the radius of the curve at some t-value along the bezier.

Author: GW

Date: 08/2013

Parameters

t_	T-value on the bezier whose radius is needed
radius__	Return-by-reference for the radius of the curve of the bezier at t_

Returns: true for success, false for failure (i.e. straight beziers do not have a radius)

◆ radiusAndCenter()

virtual bool hdi::core::Bezier::radiusAndCenter	(	const double	t_,
		double &	radius__,
		ArtboardPoint &	center__
	)		const

virtual

Gets both the radius and center point of the curve at some t-value along the bezier.

Author: GW

Date: 08/2013

Parameters

t_	T-value on the bezier whose radius is needed
radius__	Return-by-reference for the radius of the curve of the bezier at t_
center__	Return-by-reference for the center point of the curve of the bezier at t_

Returns: true for success, false for failure (i.e. straight beziers do not have a radius)

Note: Calculations for the radius and center point at a t-value are related, so use this method for performance reasons if you need both values.

◆ section()

virtual Bezier hdi::core::Bezier::section	(	const double	startT_,
		const double	endT_
	)		const

virtual

Gets a section of the target bezier, from a starting t-value to an ending t-value.

Author: GW

Date: 08/2013

Parameters

startT_	Starting position (t-value) of the bezier subsection
endT_	Ending position (t-value) of the bezier subsection

Returns: A Bezier object describing the desired subsection of the original target bezier

◆ setPoints()

virtual void hdi::core::Bezier::setPoints	(	const ArtboardPoint &	start_,
		const ArtboardPoint &	startOut_,
		const ArtboardPoint &	endIn_,
		const ArtboardPoint &	end_
	)

virtual

Sets the anchor and control points of the bezier.

Author: GW

Date: 08/2013

Parameters

start_	First anchor point
startOut_	First control point
endIn_	Second control point
end_	Second anchor point

◆ startOutPoint()

virtual ArtboardPoint hdi::core::Bezier::startOutPoint ( ) const

virtual

Gets the first control point of the bezier.

Author: GW

Date: 08/2013

Returns: The first control point, AKA the start-out point

◆ startPoint()

virtual ArtboardPoint hdi::core::Bezier::startPoint ( ) const

virtual

Gets the first anchor point of the bezier.

Author: GW

Date: 08/2013

Returns: The first anchor point, AKA the start point

◆ sublength()

virtual double hdi::core::Bezier::sublength	(	const double	startT_,
		const double	endT_
	)		const

virtual

Gives approximate length of a bezier from t-value startT_ to t-value endT_.

Author: GW

Date: 08/2013

Parameters

startT_	Starting position (t-value) to begin the calculation
endT_	Ending position (t-value) to end the calculation

Returns: The length of the subsection of the target bezier between startT_ and endT_

◆ tangentAngle()

virtual Angle hdi::core::Bezier::tangentAngle ( const double t_ ) const

virtual

Gets the tangent angle at some t-value along the bezier.

Author: GW

Date: 08/2013

Parameters

t_	T-value on the bezier whose tangent angle is needed

Returns: The angle of the tangent at the given t-value, or the tangent angle at 0.0 for values less than 0.0, or the tangent angle at 1.0 for values greater than 1.0

◆ tAtLength()

virtual double hdi::core::Bezier::tAtLength ( const double length_ ) const

virtual

Gives the t-value at a specific length along the target bezier.

Author: GW

Date: 08/2013

Parameters

length_ The length along the target bezier, in points, for which a t-value is desired

Returns: The t-value for the provided length, or 0.0 for negative lengths, or 1.0 for lengths greater than the total length of the target bezier

Public Types

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Bezier() [1/4]

◆ Bezier() [2/4]

◆ Bezier() [3/4]

◆ Bezier() [4/4]

◆ ~Bezier()

Member Function Documentation

◆ adjustThruPoint()

◆ bounds()

◆ center()

◆ curved()

◆ divide()

◆ endInPoint()

◆ endPoint()

◆ evaluate()

◆ isCircularArc()

◆ length()

◆ normalAngle()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ radius()

◆ radiusAndCenter()

◆ section()

◆ setPoints()

◆ startOutPoint()

◆ startPoint()

◆ sublength()

◆ tangentAngle()

◆ tAtLength()