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

Describes a gradient that has been applied to some art. More...

#include <hdicoreArtColor.h>

Collaboration diagram for hdi::core::ArtColor::GradientStyle:
Collaboration graph
[legend]

Public Member Functions

 GradientStyle ()
 Constructs a new GradientStyle object with default values. More...
 
 GradientStyle (const GradientStyle &grad_)
 Constructs a new GradientStyle object from an existing GradientStyle. More...
 
 GradientStyle (const core::Gradient &gradient_, const core::ArtboardPoint &origin_, const core::Angle &angle_, const double length_, const core::TransformMatrix &matrix_, const core::Angle &hiliteAngle_, const double hiliteLength_)
 Constructs a new GradientStyle object with the given values. More...
 
virtual ~GradientStyle ()
 Destructs a GradientStyle object. More...
 
GradientStyleoperator= (const GradientStyle &rhs_)
 GradientStyle assignment operator. More...
 

Public Attributes

core::Gradientgradient
 Gradient to which the style applies. The lifetime of the object is only as long as the GradientStyle which contains it (so make sure to use the copy constructor if you need to store the Gradient any longer).
 
core::ArtboardPoint origin
 For a linear gradient, the origin of the gradient in page coordinates, which is 0 on the gradient ramp. For a radial gradient, the center of the containing circle.
 
core::Angle angle
 For a linear gradient, the angle of the gradient in degrees from the X axis. The ramp extends from the origin at this angle. Positive values are counterclockwise. Not used for radial gradients, but the value is preserved in case the gradient is changed back to linear.
 
double length
 For a linear gradient, the distance in points over which the gradient ramp is applied. The ramp is scaled so that 100% of its value is this length. For a radial gradient, the radius of the containing circle.
 
core::TransformMatrix matrix
 The accumulated transformations of the gradient. It is not necessarily the same as the transformation matrix of the object containing the gradient. When a gradient is first applied to an object, the value is set to the identity matrix. When the user transforms the object, the user transformation matrix is concatenated to the gradient instance's matrix.
 
core::Angle highlightAngle
 For a radial gradient, the angle to the blend highlight point. Not used for linear gradients.
 
double highlightLength
 For a radial gradient, the distance of the hilight from the origin expressed as a fraction of the radius (a value between 0 and 1). Not used for linear gradients.
 

Detailed Description

Describes a gradient that has been applied to some art.

Constructor & Destructor Documentation

hdi::core::ArtColor::GradientStyle::GradientStyle ( )

Constructs a new GradientStyle object with default values.

Author
GW
Date
12/2013
hdi::core::ArtColor::GradientStyle::GradientStyle ( const GradientStyle grad_)

Constructs a new GradientStyle object from an existing GradientStyle.

Author
GW
Date
12/2013
Parameters
grad_Existing GradientStyle object to copy values from
hdi::core::ArtColor::GradientStyle::GradientStyle ( const core::Gradient gradient_,
const core::ArtboardPoint origin_,
const core::Angle angle_,
const double  length_,
const core::TransformMatrix matrix_,
const core::Angle hiliteAngle_,
const double  hiliteLength_ 
)

Constructs a new GradientStyle object with the given values.

Author
GW
Date
12/2013
Parameters
gradient_(See gradient member description)
origin_(See origin member description)
angle_(See angle member description)
length_(See length member description)
matrix_(See matrix member description)
hiliteAngle_(See highlightAngle member description)
hiliteLength_(See highlightLength member description)
virtual hdi::core::ArtColor::GradientStyle::~GradientStyle ( )
virtual

Destructs a GradientStyle object.

Author
GW
Date
12/2013

Member Function Documentation

GradientStyle& hdi::core::ArtColor::GradientStyle::operator= ( const GradientStyle rhs_)

GradientStyle assignment operator.

Author
GW
Date
12/2013
Parameters
rhs_Existing GradientStyle object to copy values from (righthand side of the assignment operator)
Returns
The target GradientStyle object, but with its values updated