SweepSteps class

A 2D stepping sweep "gradient".

This class represents sweep steps, abstracting out the arguments to the new ui.Gradient.sweep constructor from dart:ui.

A SweepSteps has a center, a startAngle, and an endAngle. The startAngle corresponds to 0.0, and endAngle corresponds to 1.0. These angles are expressed in radians.

The colors are described by a List<Color>. The stops list, if specified, must have the same length as colors. It specifies fractions of the vector from start to end, between 0.0 and 1.0, for each color. If it is null, a uniform distribution is assumed.

The region of the canvas before startAngle and after endAngle is painted according to tileMode.

Typically this class is used with BoxDecoration, which does the painting. To use a SweepSteps to paint directly on a canvas, see createShader.

{@tool snippet}

The left-most example is this `SweepSteps`

the left-most example is this SweepSteps

final stepBowSweep = Container(
  decoration: BoxDecoration(
    gradient: SweepSteps(
      tileMode: TileMode.repeated,
      startAngle: 0.0,
      endAngle: math.pi * 0.5, // ¼ rotation + TileMode.repeated
      // endAngle: math.pi * 2, // full rotation
      colors: [
        Colors.red, Colors.orange, Colors.yellow, Colors.green,
        Colors.blue, Colors.indigo, Colors.purple, Colors.pink,
      ],
    ),
  )
);

{@end-tool}

Constructors

SweepSteps({AlignmentGeometry center = Alignment.center, double startAngle = 0.0, double endAngle = math.pi * 2, required List<Color> colors, List<double>? stops, TileMode tileMode = TileMode.clamp, GradientTransform? transform}): Construct a new SweepSteps type Gradient.
const

Properties

asNill → Gradient: Available on Gradient, provided by the NillGradients extension
Gradient get asNill => nillify( /* this. */ runtimeType);
no setter
begin → AlignmentGeometry: Available on Gradient, provided by the GradientUtils extension
If this is a linear-type Gradient, returns this.begin. Otherwise the fallback retrun value is Alignment.center.
no setter
center → AlignmentGeometry: The center of this SweepSteps, as an offset into the (-1.0, -1.0) x (1.0, 1.0) square describing the Gradient which will be mapped onto the paint box.
final
center → AlignmentGeometry: Available on Gradient, provided by the GradientUtils extension
If this is a radial- or sweep-type Gradient, returns this.center. Otherwise the fallback retrun value is Alignment.center.
no setter
colors → List<Color>: The colors the gradient should obtain at each of the stops.
finalinherited
distance → double: Available on Gradient, provided by the GradientUtils extension
If this is a ShadedSteps-type Gradient, returns this.distance. Otherwise the fallback retrun value is 0.0.
no setter
end → AlignmentGeometry: Available on Gradient, provided by the GradientUtils extension
If this is a linear-type Gradient, returns this.end. Otherwise the fallback retrun value is Alignment.center.
no setter
endAngle → double: The angle in radians at which stop 1.0 of this SweepSteps is placed.
final
endAngle → double: Available on Gradient, provided by the GradientUtils extension
If this is a sweep-type Gradient, returns this.endAngle. Otherwise the fallback retrun value is 0.0.
no setter
focal → AlignmentGeometry?: Available on Gradient, provided by the GradientUtils extension
If this is a radial-type Gradient, returns this.focal which may be null. Otherwise the fallback retrun value is null.
no setter
focalRadius → double: Available on Gradient, provided by the GradientUtils extension
If this is a radial-type Gradient, returns this.focalRadius. Otherwise the fallback retrun value is 0.0.
no setter
hashCode → int: The hash code for this object.
no setteroverride
radius → double: Available on Gradient, provided by the GradientUtils extension
If this is a radial-type Gradient, returns this.radius. Otherwise the fallback retrun value is 0.0.
no setter
reversed → Gradient: Available on Gradient, provided by the GradientUtils extension
Returns a copy of this Gradient with its List<Color> colors reversed as well as any potential stops.
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
shadeFactor → double: Available on Gradient, provided by the GradientUtils extension
If this is a ShadedSteps-type Gradient, returns this.shadeFactor. Otherwise the fallback retrun value is 0.
no setter
shadeFunction → ColorArithmetic: Available on Gradient, provided by the GradientUtils extension
If this is a ShadedSteps-type Gradient, returns this.shadeFunction. Otherwise the fallback retrun value is Shades.withWhite.
no setter
softness → double: Available on Gradient, provided by the GradientUtils extension
If this is a Steps-type Gradient, returns this.softness. Otherwise the fallback retrun value is 0.0.
no setter
startAngle → double: The angle in radians at which stop 0.0 of this SweepSteps is placed.
final
startAngle → double: Available on Gradient, provided by the GradientUtils extension
If this is a sweep-type Gradient, returns this.startAngle. Otherwise the fallback retrun value is 0.0.
no setter
steppedColors → List<Color>: Available on Gradient, provided by the GradientUtils extension
If this is a Steps-type Gradient, returns this.steppedColors. Otherwise the fallback retrun value is colors.
no setter
steppedStops → List<double>?: Available on Gradient, provided by the GradientUtils extension
If this is a Steps-type Gradient, returns this.steppedStops. Otherwise the fallback retrun value is stops.
no setter
stops → List<double>?: A list of values from 0.0 to 1.0 that denote fractions along the gradient.
finalinherited
tileMode → TileMode: How this SweepSteps should tile the plane beyond the region before startAngle and after endAngle.
final
tileMode → TileMode: Available on Gradient, provided by the GradientUtils extension
How this Gradient tiles in the plane beyond the region before its starting stop and after its ending stop.
no setter
transform → GradientTransform?: The transform, if any, to apply to the gradient.
finalinherited

Methods

animate({required Animation<double> controller, Map<GradientAnimation, dynamic> storyboard = const {}, GradientCopyWith overrideCopyWith = spectrumCopyWith}) → Gradient: Available on Gradient, provided by the GradientUtils extension
Returns the AnimatedGradient.observe animated Gradient output from a new AnimatedGradient constructed by this gradient and the provided parameters.
copyWith({List<Color>? colors, List<double>? stops, AlignmentGeometry? center, double? startAngle, double? endAngle, TileMode? tileMode, GradientTransform? transform}) → SweepSteps: 📋 Returns a new copy of this SweepSteps with any provided optional parameters overriding those of this.
copyWith({List<Color>? colors, List<double>? stops, GradientTransform? transform, TileMode? tileMode, AlignmentGeometry? begin, AlignmentGeometry? end, AlignmentGeometry? center, double? radius, AlignmentGeometry? focal, double? focalRadius, double? startAngle, double? endAngle}) → Gradient: Available on Gradient, provided by the GradientUtils extension
📋 Returns a new copy of this Gradient with any appropriate optional parameters overriding those of this.
copyWith({List<Color>? colors, List<double>? stops, GradientTransform? transform, TileMode? tileMode, AlignmentGeometry? begin, AlignmentGeometry? end, AlignmentGeometry? center, double? radius, AlignmentGeometry? focal, double? focalRadius, double? startAngle, double? endAngle, double? softness, ColorArithmetic? shadeFunction, double? shadeFactor, double? distance}) → Gradient: Available on Gradient, provided by the GradientUtils extension
📋 Returns a new copy of this Gradient with any appropriate optional parameters overriding those of this.
createShader(Rect rect, {TextDirection? textDirection}) → Shader: Creates a ui.Gradient.sweep with duplicated colors and stops.
override
lerpFrom(Gradient? a, double t) → Gradient?: Linearly interpolates from another Gradient to this.
override
lerpTo(Gradient? b, double t) → Gradient?: Linearly interpolates from this to another Gradient.
override
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
scale(double factor) → SweepSteps: Returns a new SweepSteps with its colors scaled by the given factor. Since the alpha channel is what receives the scale factor, 0.0 or less results in a gradient that is fully transparent.
override
toString() → String: A string representation of this object.
override
withOpacity(double opacity) → Gradient: Returns a new Gradient with each color set to the given opacity.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
override

Static Methods

lerp(SweepSteps? a, SweepSteps? b, double t) → SweepSteps?: Copied from SweepGradient.
Linearly interpolate between two SweepStepss.
override