CopperSpice API
1.9.2
|
QGradient class is used in combination with QBrush to specify gradient fills. More...
Public Types | |
enum | CoordinateMode |
enum | InterpolationMode |
enum | Spread |
enum | Type |
Public Methods | |
CoordinateMode | coordinateMode () const |
InterpolationMode | interpolationMode () const |
bool | operator!= (const QGradient &other) const |
bool | operator== (const QGradient &other) const |
void | setColorAt (qreal position, const QColor &color) |
void | setCoordinateMode (CoordinateMode mode) |
void | setInterpolationMode (InterpolationMode mode) |
void | setSpread (Spread spreadType) |
void | setStops (const QVector< QPair< qreal, QColor >> &stops) |
Spread | spread () const |
QVector< QPair< qreal, QColor > > | stops () const |
Type | type () const |
Friends | |
class | QBrush |
class | QConicalGradient |
class | QLinearGradient |
class | QRadialGradient |
The QGradient class is used in combination with QBrush to specify gradient fills. CopperSpice currently supports three types of gradient fills.
The gradient type can be retrieved by calling type(). There is a child class for every QGradient type.
QLinearGradient | QRadialGradient | QConicalGradient |
---|---|---|
The colors in a gradient are defined using stop points of the QGradientStop type; i.e., a position and a color. Use the setColorAt() function to define a single stop point. Alternatively, use the setStops() function to define several stop points in one go. Note that the latter function replaces the current set of stop points.
It is the gradient's complete set of stop points (accessible through the stops() function) that describes how the gradient area should be filled. If no stop points have been specified, a gradient of black at 0 to white at 1 is used.
A diagonal linear gradient from black at (100, 100) to white at (200, 200) could be specified like this:
A gradient can have an arbitrary number of stop points. The following would create a radial gradient starting with red in the center, blue and then green on the edges:
It is possible to repeat or reflect the gradient outside its area by specifying the spread method using the setSpread() function. The default is to pad the outside area with the color at the closest stop point. The currently set spread method can be retrieved using the spread() function. The QGradient::Spread enum defines three different methods:
PadSpread | RepeatSpread | ReflectSpread |
The setSpread() function only has effect for linear and radial gradients. The reason is that the conical gradient is closed by definition, i.e. the conical gradient fills the entire circle from 0 - 360 degrees, while the boundary of a radial or a linear gradient can be specified through its radius or final stop points, respectively.
The gradient coordinates can be specified in logical coordinates, relative to device coordinates, or relative to object bounding box coordinates. The coordinate mode can be set using the setCoordinateMode() function. The default is LogicalMode, where the gradient coordinates are specified in the same way as the object coordinates. To retrieve the currently set coordinate mode use coordinateMode().
This enum specifies how gradient coordinates map to the paint device on which the gradient is used.
Constant | Value | Description |
---|---|---|
QGradient::LogicalMode | 0 | Gradient coordinates are specified logical space just like the object coordinates |
QGradient::StretchToDeviceMode | 1 | Gradient coordinates are relative to the bounding rectangle of the paint device with (0,0) in the top left corner and (1,1) in the bottom right corner |
QGradient::ObjectBoundingMode | 2 | Gradient coordinates are relative to the bounding rectangle of the object being drawn with (0,0) in the top left corner and (1,1) in the bottom right corner |
Constant | Value | Description |
---|---|---|
QGradient::ColorInterpolation | 0 | Red, green, and blue components are multiplied by the alpha component before computing the result |
QGradient::ComponentInterpolation | 1 | Red, green, blue, and alpha components are calculated independently |
enum QGradient::Spread |
Specifies how the area outside the gradient area should be filled.
Constant | Value | Description |
---|---|---|
QGradient::PadSpread | 0 | Gradient area is filled with the closest stop color |
QGradient::ReflectSpread | 1 | Gradient is reflected outside the gradient area |
QGradient::RepeatSpread | 2 | Gradient is repeated outside the gradient area |
enum QGradient::Type |
Specifies the type of gradient.
Constant | Value | Description |
---|---|---|
QGradient::LinearGradient | 0 | Colors are displayed between a start point and an end point |
QGradient::RadialGradient | 1 | Colors are displayed between a focal point and an end point in a circle |
QGradient::ConicalGradient | 2 | Colors are displayed around a center point |
QGradient::NoGradient | 3 | There is no gradient |
CoordinateMode QGradient::coordinateMode | ( | ) | const |
Returns the coordinate mode of this gradient. The default mode is LogicalMode.
InterpolationMode QGradient::interpolationMode | ( | ) | const |
Returns the value of the property.
|
inline |
Returns true if this QGradient is not equal to other, otherwise returns false.
bool QGradient::operator== | ( | const QGradient & | other | ) | const |
Returns true if this QGradient is equal to other, otherwise returns false.
Creates a stop point at the given position with the given color. The position must be in the range 0 to 1.
void QGradient::setCoordinateMode | ( | CoordinateMode | mode | ) |
Sets the coordinate mode of this gradient to mode. The default mode is LogicalMode.
void QGradient::setInterpolationMode | ( | InterpolationMode | mode | ) |
Sets the value of the property to mode.
|
inline |
Specifies the spreadType which should be used for this gradient. This spreadType only matters for linear and radial gradients.
Replaces the current set of stop points with the given stops. The positions of the points must be in the range 0 to 1, and must be sorted with the lowest point first.
|
inline |
Returns the spread method use by this gradient. The default is PadSpread.
Returns the stop points for this gradient.
If no stop points have been specified, a gradient of black at 0 to white at 1 is used.
|
inline |
Returns the type of gradient.