RadialPattern Class

Represents the type 3 (radial) shadings

Inheritance Hierarchy

SystemObject
  Patagames.Pdf.Net.PatternsPdfPattern
    Patagames.Pdf.Net.PatternsPdfShadingPattern
      Patagames.Pdf.Net.PatternsRadialPattern

Namespace: Patagames.Pdf.Net.Patterns
Assembly: Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.89.2704

Syntax

C++

JavaScript

Copy

public class RadialPattern : PdfShadingPattern

Public Class RadialPattern
	Inherits PdfShadingPattern

public ref class RadialPattern : public PdfShadingPattern

type RadialPattern = 
    class
        inherit PdfShadingPattern
    end

public class RadialPattern extends PdfShadingPattern

Patagames.Pdf.Net.Patterns.RadialPattern = function();

Type.createClass(
	'Patagames.Pdf.Net.Patterns.RadialPattern',
	Patagames.Pdf.Net.Patterns.PdfShadingPattern);

The RadialPattern type exposes the following members.

Constructors

	Name	Description
	RadialPattern(PdfDocument, FS_CIRCLEF, FS_CIRCLEF, PdfFunction, PdfColorSpace, FS_MATRIX, FS_MATRIX)	Create new radial shading pattern
	RadialPattern(PdfDocument, FS_CIRCLEF, FS_CIRCLEF, PdfFunction, PdfColorSpace, FS_MATRIX, FS_MATRIX)	Create new radial shading pattern

Top

Properties

	Name	Description
	Dictionary	Gets the shading object. (Overrides PdfShadingPatternDictionary)
	ExtendEnd	Gets or sets a flag specifying whether to extend the shading beyond the ending (To) circle.
	ExtendStart	Gets or sets a flag specifying whether to extend the shading beyond the starting (From) circle.
	From	Gets or sets the starting circle, expressed in the shading’s target coordinate space.
	Functions	Gets or sets a 1-in, n-out function or an array of n 1-in, 1-out functions where n is the number of color components in the shading color space. The function(s) are called with values of the parametric variable t in the domain defined by the Lowest and Highest properties. (Overrides PdfShadingPatternFunctions)
	Highest	Gets or sets the highest limiting value of a parametric variable t passed to the Functions. The variable is considered to vary linearly between Lowest and Highest values as the color gradient varies between the starting (From) and ending (To) circles. The variable t becomes the input argument to the color Functions.
	Lowest	Gets or sets the lowest limiting value of a parametric variable t passed to the Functions. The variable is considered to vary linearly between Lowest and Highest values as the color gradient varies between the starting (From) and ending (To) circles. The variable t becomes the input argument to the color Functions.
	To	Gets or sets the ending circles, expressed in the shading’s target coordinate space.

Top

Remarks

Radial shadings define a color blend that varies between two circles. Shadings of this type are commonly used to depict three-dimensional spheres and cones.

The color blend is based on a family of blend circles interpolated between the starting and ending circles that are defined by the From and To properties, respectively. The blend circles are defined in terms of a subsidiary parametric variable which varies linearly between 0.0 and 1.0 as t varies across the domain from t0 to t1, as specified by the Lowest and Highest properties.

The radii From and To must both be greater than or equal to 0. If one radius is 0, the corresponding circle is treated as a point; if both are 0, nothing is painted.

The boolean properties ExtendStart and ExtendEnd determine whether and how the shading is extended. If the first of the two elements is true, the shading is extended beyond the defined starting circle; if the second element is true, the shading is extended beyond the defined ending circle.

Reference

Patagames.Pdf.Net.Patterns Namespace