AxialShadingPattern Class

class AxialShadingPattern : ShadingPattern

Namespace:Datalogics::PDFL

Inherits from:: ShadingPattern

Detailed Description

A color blend that varies along an axis.

An axial shading specifies a color blend that varies along a linear axis between two endpoints, and indefinitely perpendicular to that axis.

Uses types

Color ColorSpace Function PDFObject Point Rect

Constructor & Destructor Documentation

AxialShadingPattern(ColorSpace colorSpace, System.Collections.Generic.IList< Point > coords, System.Collections.Generic.IList< Function > function)

Parameters

colorSpace: ColorSpace: The color space for the pattern.
coords: System.Collections.Generic.IList< Point >: The coordinates of the two endpoints of the axial shading.
function: System.Collections.Generic.IList< Function >: One 1-in n-out function, or an array of n 1-in 1-out functions that determine the values of the color channels.

Create an AxialShadingPattern.

Property Documentation

bool AntiAlias[get, set]

Gets whether anti-aliasing is enabled for the shading.

When enabled, the shading function is filtered to prevent aliasing artifacts.

Color BackgroundColor[get, set]

Gets the background color of the shading pattern.

This color must be in the color space of the shading pattern. If present, it is used to fill the areas that are outside the bounds of the shading object. May be NULL.

Rect BoundingBox[get, set]

Gets the bounding box of the shading.

The coordinates are interpreted in the target coordinate space. If present, provides an additional, temporary clipping boundary to the shading.

ColorSpace ColorSpace[get, set]

Gets the color space of a shading pattern.

This space is restricted to be any space except a Pattern space.

System.Collections.Generic.IList< Point > Coords[get, set]

The coordinates of the two endpoints of the axial shading.

System.Collections.Generic.IList< System.Double > Domain[get, set]

The domain of the parametric variable t for the axial shading.

An array of two numbers that specify the limiting values of the parametric variable t. This variable t varies linearly between these two values as the gradient varies between the starting and ending points of the axis.

Defaults to [0, 1]. May be NULL.

System.Collections.Generic.IList< System.Boolean > Extend[get, set]

Whether the shading extends beyond the start and end points of the axis.

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

Default value: [false, false]. May be NULL.

System.Collections.Generic.IList< Function > Function[get, set]

The function(s) that determine the color channel values for the shading.

One 1-in n-out function, or an array of n 1-in 1-out functions that determine the values of the color channels, where n is the number of color components in the shading's color space. The functions are called with a parametric variable t which varies across the Domain.

PDFObject PDFObject[get]

Gets the underlying PDF object for this pattern.

Member Function Documentation

void Dispose()

Returns:

void

override string ToString()

Returns:

override string

A formatted string describing this AxialShadingPattern.

Return a string representation of the AxialShadingPattern.

The string includes the color space, background color, bounding box, anti-alias flag, coordinates, function, domain, and extend values.