Click or drag to resize

FunctionBasedPattern Class

Represents the type 1 (Function-Based) shadings.
Inheritance Hierarchy
SystemObject
  Patagames.Pdf.Net.PatternsPdfPattern
    Patagames.Pdf.Net.PatternsPdfShadingPattern
      Patagames.Pdf.Net.PatternsFunctionBasedPattern

Namespace: Patagames.Pdf.Net.Patterns
Assembly: Patagames.Pdf (in Patagames.Pdf.dll) Version: 5.1.3
Syntax
public class FunctionBasedPattern : PdfShadingPattern

The FunctionBasedPattern type exposes the following members.

Constructors
Properties
 NameDescription
Public propertyDictionary Gets the shading object.
(Overrides PdfShadingPatternDictionary)
Public propertyDomain Gets or sets the rectangular domain of coordinates over which the color function(s) are defined.
Public propertyDomainMatrix Gets or sets a transformation matrix mapping the coordinate space specified by the Domain property into the shading’s target coordinate space.
Public propertyFunctions Gets or sets a 2-in, n-out function or an array of n 2-in, 1-out functions where n is the number of color components in the shading color space.
(Overrides PdfShadingPatternFunctions)
Top
Remarks

In function-based shadings, the color at every point in the domain is defined by a specified mathematical function. The function need not be smooth or continuous. This type is the most general of the available shading types and is useful for shadings that cannot be adequately described with any of the other types.

The domain rectangle (Domain) establishes an internal coordinate space for the shading that is independent of the target coordinate space in which it is to be painted. The color function(s) (Functions) specify the color of the shading at each point within this domain rectangle. The transformation matrix (DomainMatrix) then maps the domain rectangle into a corresponding rectangle or parallelogram in the target coordinate space. Points within the shading’s bounding box (BoundingBox) that fall outside this transformed domain rectangle are painted with the shading’s background color (Background); if the shading has no Background, such points are left unpainted. If the function is undefined at any point within the declared domain rectangle, an error may occur, even if the corresponding transformed point falls outside the shading’s bounding box.

See Also