Struct JoeScan::Pinchot::Point2D¶

ClassList > JoeScan > Pinchot > Point2D

A data point consisting of X and Y spatial coordinates and a brightness value. Invalid points have an X and Y value of Globals.ProfileDataInvalidXY and a brightness of Globals.ProfileDataInvalidBrightness.

Inherits the following classes: IEquatable

Public Properties¶

Type	Name
int	Brightness Gets or sets the brightness value.
bool	IsValid Checks if the point holds valid data.
float	X Gets or sets the X coordinate value in ScanSystemUnits .
float	Y Gets or sets the Y coordinate value in ScanSystemUnits .

Public Functions¶

Type	Name
override bool	Equals (object point) Specifies whether this Point2D instance contains the same coordinates within 1/10,000th of an ScanSystemUnits and the same brightness as the specified object.
bool	Equals (Point2D point) Specifies whether this Point2D instance contains the same coordinates within 1/10,000th of an ScanSystemUnits and the same brightness as the specified Point2D .
override int	GetHashCode () Returns the hash code for this instance.
	Point2D (float x, float y) Initializes a new instance of the Point2D struct with Brightness being set to Globals.ProfileDataInvalidBrightness.
	Point2D (double x, double y) Initializes a new instance of the Point2D struct with Brightness being set to Globals.ProfileDataInvalidBrightness.
	Point2D (float x, float y, int brightness) Initializes a new instance of the Point2D struct.
	Point2D (double x, double y, int brightness) Initializes a new instance of the Point2D struct.

Public Static Functions¶

Type	Name
bool	operator!= (Point2D pointA, Point2D pointB) Compares two Point2D objects. The result specifies whether the two Point2D objects have coordinates that are not within 1/10,000th of an ScanSystemUnits or do not have the same brightness.
bool	operator== (Point2D pointA, Point2D pointB) Compares two Point2D objects. The result specifies whether the two Point2D objects have coordinates within 1/10,000th of an ScanSystemUnits and have the same brightness.

Public Properties Documentation¶

Brightness¶

Gets or sets the brightness value.

int Brightness;

The brightness value.

IsValid¶

Checks if the point holds valid data.

bool IsValid;

true if point is valid else false.

X¶

Gets or sets the X coordinate value in ScanSystemUnits .

float X;

The X coordinate value in ScanSystemUnits.

Y¶

Gets or sets the Y coordinate value in ScanSystemUnits .

float Y;

The Y coordinate value in ScanSystemUnits.

Public Functions Documentation¶

Equals [1/2]¶

Specifies whether this Point2D instance contains the same coordinates within 1/10,000th of an ScanSystemUnits and the same brightness as the specified object.

override bool Equals(
    object point
)

Parameters:

point The object to test for equality.

Returns:

true if point is a Point2D and has the same coordinates within 1/10,000th of an ScanSystemUnits and the same brightness as this Point2D instance.

Equals [2/2]¶

Specifies whether this Point2D instance contains the same coordinates within 1/10,000th of an ScanSystemUnits and the same brightness as the specified Point2D .

bool Equals(
    Point2D point
)

Parameters:

point The Point2D to test for equality.

Returns:

true if point has the same coordinates within 1/10,000th of an ScanSystemUnits and the same brightness as this Point2D instance..

GetHashCode¶

Returns the hash code for this instance.

override int GetHashCode()

Returns:

A 32-bit signed integer hash code.

Point2D [1/4]¶

Initializes a new instance of the Point2D struct with Brightness being set to Globals.ProfileDataInvalidBrightness.

Point2D(
    float x,
    float y
)

Parameters:

x The X value in ScanSystemUnits.
y The Y value in ScanSystemUnits.

Point2D [2/4]¶

Initializes a new instance of the Point2D struct with Brightness being set to Globals.ProfileDataInvalidBrightness.

Point2D(
    double x,
    double y
)

Parameters:

x The X value in ScanSystemUnits.
y The Y value in ScanSystemUnits.

Point2D [3/4]¶

Initializes a new instance of the Point2D struct.

Point2D(
    float x,
    float y,
    int brightness
)

Parameters:

x The X value in ScanSystemUnits.
y The Y value in ScanSystemUnits.
brightness The brightness value.

Point2D [4/4]¶

Initializes a new instance of the Point2D struct.

Point2D(
    double x,
    double y,
    int brightness
)

Parameters:

x The X value in ScanSystemUnits.
y The Y value in ScanSystemUnits.
brightness The brightness value.

Public Static Functions Documentation¶

operator!=¶

Compares two Point2D objects. The result specifies whether the two Point2D objects have coordinates that are not within 1/10,000th of an ScanSystemUnits or do not have the same brightness.

static bool operator!=(
    Point2D pointA,
    Point2D pointB
)

Parameters:

pointA A Point2D to compare.
pointB A Point2D to compare.

Returns:

true if the two Point2D objects have coordinates that are not within 1/10,000th of an ScanSystemUnits or do not have the same brightness.

operator==¶

Compares two Point2D objects. The result specifies whether the two Point2D objects have coordinates within 1/10,000th of an ScanSystemUnits and have the same brightness.

static bool operator==(
    Point2D pointA,
    Point2D pointB
)

Parameters:

pointA A Point2D to compare.
pointB A Point2D to compare.

Returns:

true if the two Point2D objects have coordinates within 1/10,000th of an ScanSystemUnits and have the same brightness.