Class RadialShading

Namespace

UglyToad.PdfPig.Graphics.Colors

Assembly

UglyToad.PdfPig.dll

Radial shadings (type 3) define a blend between two circles, optionally extended beyond the boundary circles by continuing the boundary colours. This type of shading is commonly used to represent three-dimensional spheres and cones.

public sealed class RadialShading : Shading

Inheritance

object

Shading

RadialShading

Inherited Members

Shading.Eval(params double[])

Shading.ShadingDictionary

Shading.ShadingType

Shading.ColorSpace

Shading.Background

Shading.BBox

Shading.AntiAlias

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

RadialShading(bool, DictionaryToken, ColorSpaceDetails, PdfRectangle?, double[], double[], double[], PdfFunction[], bool[])

Create a new RadialShading.

public RadialShading(bool antiAlias, DictionaryToken shadingDictionary, ColorSpaceDetails colorSpace, PdfRectangle? bbox, double[] background, double[] coords, double[] domain, PdfFunction[] functions, bool[] extend)

Parameters

antiAlias bool

shadingDictionary DictionaryToken

colorSpace ColorSpaceDetails

bbox PdfRectangle?

background double[]

coords double[]

domain double[]

functions PdfFunction[]

extend bool[]

Properties

Coords

(Required) An array of six numbers [x0 y0 r0 x1 y1 r1] specifying the centres and radii of the starting and ending circles, expressed in the shading's target coordinate space. The radii r0 and r1 shall both be greater than or equal to 0. If one radius is 0, the corresponding circle shall be treated as a point; if both are 0, nothing shall be painted.

public double[] Coords { get; }

Property Value

double[]

Domain

(Optional) An array of two numbers [t0 t1] specifying the limiting values of a parametric variable t. The variable is considered to vary linearly between these two values as the colour gradient varies between the starting and ending circles. The variable t becomes the input argument to the colour function(s).

Default value: [0.0 1.0].

public double[] Domain { get; }

Property Value

double[]

Extend

(Optional) An array of two boolean values specifying whether to extend the shading beyond the starting and ending points of the axis, respectively.

Default value: [false false].

public bool[] Extend { get; }

Property Value

bool[]

Functions

(Required) A 1-in, n-out function or an array of n 1-in, 1-out functions (where n is the number of colour components in the shading dictionary's colour space). The function(s) shall be called with values of the parametric variable t in the domain defined by the shading dictionary's Domain entry. Each function’s domain shall be a superset of that of the shading dictionary. If the value returned by the function for a given colour component is out of range, it shall be adjusted to the nearest valid value.

public override PdfFunction[] Functions { get; }

Property Value

PdfFunction[]