PdfMeshVertex Struct

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

Represents an explicitly colored (corner) point of a PdfMeshTriangle or a PdfMeshPatch.

public struct PdfMeshVertex : IEquatable<PdfMeshVertex>, IFormattable
Public Structure PdfMeshVertex
    Implements IEquatable(Of PdfMeshVertex), IFormattable
Implements
System.IEquatable<PdfMeshVertex>
System.IFormattable

Constructors

PdfMeshVertex(PdfPoint, PdfColor)

Initializes a new instance of the PdfMeshVertex structure that contains the specified coordinates and color.

This constructor should be used only if the Function entry is not set. If the Function entry is set then use the PdfMeshVertex(PdfPoint, Double) constructor.

public PdfMeshVertex(PdfPoint point, PdfColor color)
Public Sub New(point As PdfPoint, color As PdfColor)
Parameters
point
PdfPoint

The coordinates of this PdfMeshVertex.

color
PdfColor

The color of this PdfMeshVertex.

PdfMeshVertex(PdfPoint, Double)

Initializes a new instance of the PdfMeshVertex structure that contains the specified coordinates and color parametric variable.

This constructor should be used only if the Function entry is set. If the Function entry is not set then use the PdfMeshVertex(PdfPoint, PdfColor) constructor.

public PdfMeshVertex(PdfPoint point, double colorParameter)
Public Sub New(point As PdfPoint, colorParameter As Double)
Parameters
point
PdfPoint

The coordinates of this PdfMeshVertex.

colorParameter
System.Double

The color parametric variable of this PdfMeshVertex.

Exceptions
System.ArgumentException

The GemBox.Pdf.Content.Patterns.PdfMeshVertex.colorParameter is either System.Double.NaN, System.Double.NegativeInfinity or System.Double.PositiveInfinity.

PdfMeshVertex(Double, Double, PdfColor)

Initializes a new instance of the PdfMeshVertex structure that contains the specified coordinates and color.

This constructor should be used only if the Function entry is not set. If the Function entry is set then use the PdfMeshVertex(Double, Double, Double) constructor.

public PdfMeshVertex(double x, double y, PdfColor color)
Public Sub New(x As Double, y As Double, color As PdfColor)
Parameters
x
System.Double

The X-coordinate value of this PdfMeshVertex.

y
System.Double

The Y-coordinate value of this PdfMeshVertex.

color
PdfColor

The color of this PdfMeshVertex.

Exceptions
System.ArgumentException

The x or y is either System.Double.NaN, System.Double.NegativeInfinity or System.Double.PositiveInfinity.

PdfMeshVertex(Double, Double, Double)

Initializes a new instance of the PdfMeshVertex structure that contains the specified coordinates and color parametric variable.

This constructor should be used only if the Function entry is set. If the Function entry is not set then use the PdfMeshVertex(Double, Double, PdfColor) constructor.

public PdfMeshVertex(double x, double y, double colorParameter)
Public Sub New(x As Double, y As Double, colorParameter As Double)
Parameters
x
System.Double

The X-coordinate value of this PdfMeshVertex.

y
System.Double

The Y-coordinate value of this PdfMeshVertex.

colorParameter
System.Double

The color parametric variable of this PdfMeshVertex.

Exceptions
System.ArgumentException

The x, y or GemBox.Pdf.Content.Patterns.PdfMeshVertex.colorParameter is either System.Double.NaN, System.Double.NegativeInfinity or System.Double.PositiveInfinity.

Properties

Color

Gets the color of this PdfMeshVertex.

public readonly PdfColor Color { get; }
Public ReadOnly Property Color As PdfColor
Property Value
PdfColor

The color of this PdfMeshVertex.

Exceptions
System.InvalidOperationException

The Color property is not applicable because the Function entry is set on a shading (the IsColorParametric property returns true). Use the ColorParameter property instead.

ColorParameter

Gets the color parametric variable of this PdfMeshVertex.

public readonly double ColorParameter { get; }
Public ReadOnly Property ColorParameter As Double
Property Value
System.Double

The color parametric variable of this PdfMeshVertex.

Exceptions
System.InvalidOperationException

The ColorParameter property is not applicable because the Function entry is not set on a shading (the IsColorParametric property returns false). Use the Color property instead.

System.ArgumentException

The value is either System.Double.NaN, System.Double.NegativeInfinity or System.Double.PositiveInfinity.

IsColorParametric

Gets a value indicating whether this PdfMeshVertex specifies a color parametric variable or a color.

public readonly bool IsColorParametric { get; }
Public ReadOnly Property IsColorParametric As Boolean
Property Value
System.Boolean

true if this PdfMeshVertex specifies a color parametric variable; otherwise, false if it specifies a color.

Point

Gets the coordinates of this PdfMeshVertex.

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

The coordinates of this PdfMeshVertex.

Methods

Equals(PdfMeshVertex)

Determines whether the other PdfMeshVertex is equal to this PdfMeshVertex instance.

public bool Equals(PdfMeshVertex other)
Public Function Equals(other As PdfMeshVertex) As Boolean
Parameters
other
PdfMeshVertex

The other mesh vertex to compare with this mesh vertex instance.

Returns
System.Boolean

true if the other PdfMeshVertex is equal to this PdfMeshVertex instance; otherwise, false.

Equals(Object)

Determines whether the specified System.Object is equal to this PdfMeshVertex instance.

public override bool Equals(object obj)
Public Overrides Function Equals(obj As Object) As Boolean
Parameters
obj
System.Object

The System.Object to compare with this mesh vertex instance.

Returns
System.Boolean

true if the specified System.Object is a PdfMeshVertex and is equal to this PdfMeshVertex instance; otherwise, false.

Overrides
System.ValueType.Equals(System.Object)

GetHashCode()

Returns a hash code for this PdfMeshVertex instance.

public override int GetHashCode()
Public Overrides Function GetHashCode As Integer
Returns
System.Int32

An integer value that specifies a hash value for this PdfMeshVertex instance.

Overrides
System.ValueType.GetHashCode()

ToString()

Returns a System.String that represents this PdfMeshVertex instance.

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

A System.String that represents this PdfMeshVertex 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).

ToString(String, IFormatProvider)

Returns a System.String that represents this PdfMeshVertex instance using the specified format and format provider.

public string ToString(string format, IFormatProvider formatProvider)
Public Function ToString(format As String, formatProvider As IFormatProvider) As String
Parameters
format
System.String

The format to use or null to use the default format.

formatProvider
System.IFormatProvider

The provider to use to format the value or null to obtain the numeric format information from the current locale setting of the operating system.

Returns
System.String

A System.String that represents this PdfMeshVertex instance using the specified format and format provider.

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).

Operators

Equality(PdfMeshVertex, PdfMeshVertex)

Determines whether first and second PdfMeshVertex instances are equal.

public static bool operator ==(PdfMeshVertex first, PdfMeshVertex second)
Public Shared Operator =(first As PdfMeshVertex, second As PdfMeshVertex) As Boolean
Parameters
first
PdfMeshVertex

The first mesh vertex.

second
PdfMeshVertex

The second mesh vertex.

Returns
System.Boolean

true if first and second mesh vertices are equal; otherwise, false.

Inequality(PdfMeshVertex, PdfMeshVertex)

Determines whether first and second PdfMeshVertex instances are not equal.

public static bool operator !=(PdfMeshVertex first, PdfMeshVertex second)
Public Shared Operator <>(first As PdfMeshVertex, second As PdfMeshVertex) As Boolean
Parameters
first
PdfMeshVertex

The first mesh vertex.

second
PdfMeshVertex

The second mesh vertex.

Returns
System.Boolean

true if first and second mesh vertices are not equal; otherwise, false.

Implements

System.IEquatable<T>
System.IFormattable