ShapeCoordinate

class HPS.ShapeCoordinate : IDisposable

The ShapeCoordinate class is a coordinate used in shape definitions. Two ShapeCoordinates can be used together to define a ShapePoint It is a 2d parametric coordinate.

Public Functions

void Dispose ()

bool Equals (HPS.ShapeCoordinate in_that)

This function is used to check an object for equivalence to this.

Param in_that:The object to compare to this. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

HPS.ShapeCoordinate SetMargins (float in_margin_one)

Sets the margins for this ShapeCoordinate.

Param in_margin_one:  The first margin value. Return:A reference to this ShapeCoordinate.

HPS.ShapeCoordinate SetMargins (float in_margin_one, float in_margin_two)

Sets the margins for this ShapeCoordinate.

Param in_margin_one:  The first margin value. Param in_margin_two:  The second margin value. Return:A reference to this ShapeCoordinate.

HPS.ShapeCoordinate SetMargins (float in_margin_one, float in_margin_two, float in_margin_three)

Sets the margins for this ShapeCoordinate.

Param in_margin_one:  The first margin value. Param in_margin_two:  The second margin value. Param in_margin_three:  The third margin value. Return:A reference to this ShapeCoordinate.

HPS.ShapeCoordinate SetMargins (float in_margin_one, float in_margin_two, float in_margin_three, float in_margin_four)

Sets the margins for this ShapeCoordinate.

Param in_margin_one:  The first margin value. Param in_margin_two:  The second margin value. Param in_margin_three:  The third margin value. Param in_margin_four:  The fourth margin value. Return:A reference to this ShapeCoordinate.

ShapeCoordinate ()

ShapeCoordinate (float in_x, float in_y)

Construct a new ShapeCoordinate from an (x, y) pair.

Param in_x:A normalized distance over the horizontal text bounds. Param in_y:A normalized distance over the vertical text bounds.

ShapeCoordinate (float in_x, float in_y, float in_radius)

Construct a new ShapeCoordinate from an (x, y, radius) tuple.

Param in_x:A normalized distance over the horizontal text bounds. Param in_y:A normalized distance over the vertical text bounds. Param in_radius:  A normalized distance over the radius of the circle circumscribing the text bounds.

ShapeCoordinate (float in_x, float in_y, float in_radius, float[] in_margins)

Construct a new ShapeCoordinate from an (x, y, radius) tuple and up to four margin values.

Param in_x:A normalized distance over the horizontal text bounds. Param in_y:A normalized distance over the vertical text bounds. Param in_radius:  A normalized distance over the radius of the circle circumscribing the text bounds. Param in_margins:  A series of up to four distances, normalized over the respective text margins.

ShapeCoordinate (float in_x, float in_y, float[] in_margins)

Construct a new ShapeCoordinate from an (x, y) pair and up to four margins values

Param in_x:A normalized distance over the horizontal text bounds. Param in_y:A normalized distance over the vertical text bounds. Param in_margins:  A series of up to four distances, normalized over the respective text margins.

ShapeCoordinate (HPS.ShapeCoordinate in_that)

bool ShowMargins (out float[] out_margins)

Shows the margins for this ShapeCoordinate.

Param out_margins:  The margins for this ShapeCoordinate. Return:true if margins were set, false otherwise.

HPS.ShapeCoordinate UnsetMargins ()

Removes the margins for this ShapeCoordinate.

Return:A reference to this ShapeCoordinate.

Properties

float[] margins { get; set; }

float radius { get; set; }

float x { get; set; }

float y { get; set; }

Public Static Functions

bool operator!= (HPS.ShapeCoordinate a, HPS.ShapeCoordinate b)

bool operator== (HPS.ShapeCoordinate a, HPS.ShapeCoordinate b)