PySide6.QtGui.QRadialGradient

class QRadialGradient

The QRadialGradient class is used in combination with QBrush to specify a radial gradient brush. More

Inheritance diagram of PySide6.QtGui.QRadialGradient

Synopsis

Methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Qt supports both simple and extended radial gradients.

Simple radial gradients interpolate colors between a focal point and end points on a circle surrounding it. Extended radial gradients interpolate colors between a focal circle and a center circle. Points outside the cone defined by the two circles will be transparent. For simple radial gradients the focal point is adjusted to lie inside the center circle, whereas the focal point can have any position in an extended radial gradient.

Outside the end points the gradient is either padded, reflected or repeated depending on the currently set spread method:

The colors in a gradient is defined using stop points of the QGradientStop type, i.e. a position and a color. Use the setColorAt() or the setStops() function to define the stop points. It is the gradient’s complete set of stop points 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.

In addition to the functions inherited from QGradient , the QRadialGradient class provides the center() , focalPoint() and radius() functions returning the gradient’s center, focal point and radius respectively.

See also

QLinearGradient QConicalGradient The Gradients Example

__init__()

Constructs a simple radial gradient with the center and focal point at (0, 0) with a radius of 1.

__init__(center, radius)
Parameters:
  • centerQPointF

  • radius – float

Constructs a simple radial gradient with the given center, radius and the focal point in the circle center.

__init__(center, radius, focalPoint)
Parameters:

Constructs a simple radial gradient with the given center, radius and focalPoint.

Note

If the given focal point is outside the circle defined by the center point and radius, it will be re-adjusted to lie at a point on the circle where it intersects with the line from center to focalPoint.

__init__(cx, cy, radius)
Parameters:
  • cx – float

  • cy – float

  • radius – float

Constructs a simple radial gradient with the center at (cx, cy) and the specified radius. The focal point lies at the center of the circle.

__init__(center, centerRadius, focalPoint, focalRadius)
Parameters:
  • centerQPointF

  • centerRadius – float

  • focalPointQPointF

  • focalRadius – float

Constructs an extended radial gradient with the given center, centerRadius, focalPoint, and focalRadius.

__init__(cx, cy, radius, fx, fy)
Parameters:
  • cx – float

  • cy – float

  • radius – float

  • fx – float

  • fy – float

Constructs a simple radial gradient with the given center (cx, cy), radius and focal point (fx, fy).

Note

If the given focal point is outside the circle defined by the center (cx, cy) and the radius it will be re-adjusted to the intersection between the line from the center to the focal point and the circle.

__init__(cx, cy, centerRadius, fx, fy, focalRadius)
Parameters:
  • cx – float

  • cy – float

  • centerRadius – float

  • fx – float

  • fy – float

  • focalRadius – float

Constructs an extended radial gradient with the given center (cx, cy), center radius, centerRadius, focal point, (fx, fy), and focal radius focalRadius.

center()
Return type:

QPointF

Returns the center of this radial gradient in logical coordinates.

See also

setCenter() stops()

centerRadius()
Return type:

float

Returns the center radius of this radial gradient in logical coordinates.

focalPoint()
Return type:

QPointF

Returns the focal point of this radial gradient in logical coordinates.

focalRadius()
Return type:

float

Returns the focal radius of this radial gradient in logical coordinates.

radius()
Return type:

float

Returns the radius of this radial gradient in logical coordinates.

Equivalent to centerRadius()

See also

setRadius() stops()

setCenter(center)
Parameters:

centerQPointF

Sets the center of this radial gradient in logical coordinates to center.

See also

center()

setCenter(x, y)
Parameters:
  • x – float

  • y – float

This is an overloaded function.

Sets the center of this radial gradient in logical coordinates to (x, y).

See also

center()

setCenterRadius(radius)
Parameters:

radius – float

Sets the center radius of this radial gradient in logical coordinates to radius

See also

centerRadius()

setFocalPoint(focalPoint)
Parameters:

focalPointQPointF

Sets the focal point of this radial gradient in logical coordinates to focalPoint.

See also

focalPoint()

setFocalPoint(x, y)
Parameters:
  • x – float

  • y – float

This is an overloaded function.

Sets the focal point of this radial gradient in logical coordinates to (x, y).

See also

focalPoint()

setFocalRadius(radius)
Parameters:

radius – float

Sets the focal radius of this radial gradient in logical coordinates to radius

See also

focalRadius()

setRadius(radius)
Parameters:

radius – float

Sets the radius of this radial gradient in logical coordinates to radius

Equivalent to setCenterRadius()

See also

radius()