hdi::core::Gradient::Stop Class Reference

Describes the attributes of a gradient stop. More...

#include <hdicoreGradient.h>

Collaboration diagram for hdi::core::Gradient::Stop:

Public Member Functions
	Stop ()
	Constructs a new Stop object with default values.
	Stop (const Stop &s_)
	Constructs a new Stop object with values from an existing Stop.
	Stop (const double midPt_, const double rampPt_, const ArtColor &color_, const double opacity_)
	Constructs a new Stop object with the given values.
virtual	~Stop ()
	Destructs a Stop object.
Stop &	operator= (const Stop &rhs_)
	Overloaded assignment operator to copy values from one Stop object to another.

Public Attributes
double	midPoint
	The location between two ramp points where there is an equal mix of this color and the color of the next stop. This value is a percentage of the distance between the two ramp points, between 0.13 and 0.87. The midpoint for the previous color stop is not considered.
double	rampPoint
	The position on the blend ramp where this color begins, in the range [0,1]. The first point does not have to be at 0, but the first color begins at 0. Similarly, the last does not have to be at 1.
ArtColor	color
	The color for the target gradient stop.
double	opacity
	The opacity value for the gradient stop, in the range [0,1]. 0 is completely transparent and 1 is completely opaque.

Detailed Description

Describes the attributes of a gradient stop.

Constructor & Destructor Documentation

Stop() [1/3]

hdi::core::Gradient::Stop::Stop

(

)

Constructs a new Stop object with default values.

Author

GW

Date

12/2013

Stop() [2/3]

hdi::core::Gradient::Stop::Stop

(

const Stop &

s_

)

Constructs a new Stop object with values from an existing Stop.

Author

GW

Date

02/2015

Parameters

s_	Existing Stop to copy values from

Stop() [3/3]

hdi::core::Gradient::Stop::Stop	(	const double	midPt_,
		const double	rampPt_,
		const ArtColor &	color_,
		const double	opacity_
	)

Constructs a new Stop object with the given values.

Author

GW

Date

12/2013

Parameters

midPt_	(See midPoint member description)
rampPt_	(See rampPoint member description)
color_	(See color member description)
opacity_	(See opacity member description)

~Stop()

virtual hdi::core::Gradient::Stop::~Stop ( )

virtual

Destructs a Stop object.

Author

GW

Date

12/2013

Member Function Documentation

operator=()

Stop & hdi::core::Gradient::Stop::operator=

(

const Stop &

rhs_

)

Overloaded assignment operator to copy values from one Stop object to another.

Author

GW

Date

02/2015

Parameters

rhs_	Righthand side of the assignment

Returns

The lefthand side of the assignment, but with its values updated