PdfMeshPatch Struct

Namespace:
GemBox.Pdf.Content.Patterns
Assembly:
GemBox.Pdf.dll

Represents a color patch contained in a PdfCoonsPatchMeshShading or PdfTensorPatchMeshShading bounded by four cubic Bézier curves and with four implicit (in PdfCoonsPatchMeshShading) or explicit (in PdfTensorPatchMeshShading) "internal" control points.

note

PdfMeshPatch does not contain a public constructor. The only way to access PdfMeshPatch instances is by enumerating PdfCoonsPatchMeshShading or PdfTensorPatchMeshShading.

public struct PdfMeshPatch
Public Structure PdfMeshPatch

Properties

Point01

Gets the first control point of a cubic Bézier curve that connects Vertex00 and Vertex03 of this PdfMeshPatch.

public readonly PdfPoint Point01 { get; }
Public ReadOnly Property Point01 As PdfPoint
Property Value
PdfPoint

The first control point of a cubic Bézier curve that connects Vertex00 and Vertex03 of this PdfMeshPatch.

Point02

Gets the second control point of a cubic Bézier curve that connects Vertex00 and Vertex03 of this PdfMeshPatch.

public readonly PdfPoint Point02 { get; }
Public ReadOnly Property Point02 As PdfPoint
Property Value
PdfPoint

The second control point of a cubic Bézier curve that connects Vertex00 and Vertex03 of this PdfMeshPatch.

Point10

Gets the first control point of a cubic Bézier curve that connects Vertex00 and Vertex30 of this PdfMeshPatch.

public readonly PdfPoint Point10 { get; }
Public ReadOnly Property Point10 As PdfPoint
Property Value
PdfPoint

The first control point of a cubic Bézier curve that connects Vertex00 and Vertex30 of this PdfMeshPatch.

Point11

Gets (for PdfTensorPatchMeshShading) or calculates (for PdfCoonsPatchMeshShading) the first interior control point of this PdfMeshPatch.

public readonly PdfPoint Point11 { get; }
Public ReadOnly Property Point11 As PdfPoint
Property Value
PdfPoint

The first interior control point of this PdfMeshPatch.

Exceptions
System.InvalidOperationException

The interior control point can be set only if a patch is contained in PdfTensorPatchMeshShading.

Point12

Gets (for PdfTensorPatchMeshShading) or calculates (for PdfCoonsPatchMeshShading) the second interior control point of this PdfMeshPatch.

public readonly PdfPoint Point12 { get; }
Public ReadOnly Property Point12 As PdfPoint
Property Value
PdfPoint

The second interior control point of this PdfMeshPatch.

Exceptions
System.InvalidOperationException

The interior control point can be set only if a patch is contained in PdfTensorPatchMeshShading.

Point13

Gets the first control point of a cubic Bézier curve that connects Vertex03 and Vertex33 of this PdfMeshPatch.

public readonly PdfPoint Point13 { get; }
Public ReadOnly Property Point13 As PdfPoint
Property Value
PdfPoint

The first control point of a cubic Bézier curve that connects Vertex03 and Vertex33 of this PdfMeshPatch.

Point20

Gets the second control point of a cubic Bézier curve that connects Vertex00 and Vertex30 of this PdfMeshPatch.

public readonly PdfPoint Point20 { get; }
Public ReadOnly Property Point20 As PdfPoint
Property Value
PdfPoint

The second control point of a cubic Bézier curve that connects Vertex00 and Vertex30 of this PdfMeshPatch.

Point21

Gets (for PdfTensorPatchMeshShading) or calculates (for PdfCoonsPatchMeshShading) the fourth interior control point of this PdfMeshPatch.

public readonly PdfPoint Point21 { get; }
Public ReadOnly Property Point21 As PdfPoint
Property Value
PdfPoint

The fourth interior control point of this PdfMeshPatch.

Exceptions
System.InvalidOperationException

The interior control point can be set only if a patch is contained in PdfTensorPatchMeshShading.

Point22

Gets (for PdfTensorPatchMeshShading) or calculates (for PdfCoonsPatchMeshShading) the third interior control point of this PdfMeshPatch.

public readonly PdfPoint Point22 { get; }
Public ReadOnly Property Point22 As PdfPoint
Property Value
PdfPoint

The third interior control point of this PdfMeshPatch.

Exceptions
System.InvalidOperationException

The interior control point can be set only if a patch is contained in PdfTensorPatchMeshShading.

Point23

Gets the second control point of a cubic Bézier curve that connects Vertex03 and Vertex33 of this PdfMeshPatch.

public readonly PdfPoint Point23 { get; }
Public ReadOnly Property Point23 As PdfPoint
Property Value
PdfPoint

The second control point of a cubic Bézier curve that connects Vertex03 and Vertex33 of this PdfMeshPatch.

Point31

Gets the first control point of a cubic Bézier curve that connects Vertex30 and Vertex33 of this PdfMeshPatch.

public readonly PdfPoint Point31 { get; }
Public ReadOnly Property Point31 As PdfPoint
Property Value
PdfPoint

The first control point of a cubic Bézier curve that connects Vertex30 and Vertex33 of this PdfMeshPatch.

Point32

Gets the second control point of a cubic Bézier curve that connects Vertex30 and Vertex33 of this PdfMeshPatch.

public readonly PdfPoint Point32 { get; }
Public ReadOnly Property Point32 As PdfPoint
Property Value
PdfPoint

The second control point of a cubic Bézier curve that connects Vertex30 and Vertex33 of this PdfMeshPatch.

SharedEdge

Gets the edge of the previous patch that is shared with this PdfMeshPatch.

public readonly PdfMeshSharedEdge SharedEdge { get; }
Public ReadOnly Property SharedEdge As PdfMeshSharedEdge
Property Value
PdfMeshSharedEdge

The edge of the previous patch that is shared with this PdfMeshPatch.

Vertex00

Gets the first (corner) vertex of this PdfMeshPatch.

public readonly PdfMeshVertex Vertex00 { get; }
Public ReadOnly Property Vertex00 As PdfMeshVertex
Property Value
PdfMeshVertex

The first (corner) vertex of this PdfMeshPatch.

Exceptions
System.ArgumentException

The Function entry is set and the IsColorParametric property of the value is false or the Function entry is not set and the IsColorParametric property of the value is true.

System.ArgumentException

The Space of the Color of the value is not equal to the shading's ColorSpace.

Vertex03

Gets the second (corner) vertex of this PdfMeshPatch.

public readonly PdfMeshVertex Vertex03 { get; }
Public ReadOnly Property Vertex03 As PdfMeshVertex
Property Value
PdfMeshVertex

The second (corner) vertex of this PdfMeshPatch.

Exceptions
System.ArgumentException

The Function entry is set and the IsColorParametric property of the value is false or the Function entry is not set and the IsColorParametric property of the value is true.

System.ArgumentException

The Space of the Color of the value is not equal to the shading's ColorSpace.

Vertex30

Gets the fourth (corner) vertex of this PdfMeshPatch.

public readonly PdfMeshVertex Vertex30 { get; }
Public ReadOnly Property Vertex30 As PdfMeshVertex
Property Value
PdfMeshVertex

The fourth (corner) vertex of this PdfMeshPatch.

Exceptions
System.ArgumentException

The Function entry is set and the IsColorParametric property of the value is false or the Function entry is not set and the IsColorParametric property of the value is true.

System.ArgumentException

The Space of the Color of the value is not equal to the shading's ColorSpace.

Vertex33

Gets the third (corner) vertex of this PdfMeshPatch.

public readonly PdfMeshVertex Vertex33 { get; }
Public ReadOnly Property Vertex33 As PdfMeshVertex
Property Value
PdfMeshVertex

The third (corner) vertex of this PdfMeshPatch.

Exceptions
System.ArgumentException

The Function entry is set and the IsColorParametric property of the value is false or the Function entry is not set and the IsColorParametric property of the value is true.

System.ArgumentException

The Space of the Color of the value is not equal to the shading's ColorSpace.

Methods

ToString()

Returns a System.String that represents this PdfMeshPatch instance.

public override string ToString()
Public Overrides Function ToString As String
Returns
System.String

A System.String that represents this PdfMeshPatch instance.

Overrides
System.ValueType.ToString()
Remarks

This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

See Also