
Public Member Functions | |
virtual void | Dispose () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.ShapeCoordinate in_that) |
This function is used to check an object for equivalence to this. More... | |
override int | GetHashCode () |
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. More... | |
HPS.ShapeCoordinate | SetMargins (float in_margin_one, float in_margin_two, float in_margin_three) |
Sets the margins for this ShapeCoordinate. More... | |
HPS.ShapeCoordinate | SetMargins (float in_margin_one, float in_margin_two) |
Sets the margins for this ShapeCoordinate. More... | |
HPS.ShapeCoordinate | SetMargins (float in_margin_one) |
Sets the margins for this ShapeCoordinate. More... | |
ShapeCoordinate (float in_x, float in_y) | |
Construct a new ShapeCoordinate from an (x, y) pair. More... | |
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 More... | |
ShapeCoordinate (float in_x, float in_y, float in_radius) | |
Construct a new ShapeCoordinate from an (x, y, radius) tuple. More... | |
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. More... | |
ShapeCoordinate (HPS.ShapeCoordinate in_that) | |
bool | ShowMargins (out float[] out_margins) |
Shows the margins for this ShapeCoordinate. More... | |
HPS.ShapeCoordinate | UnsetMargins () |
Removes the margins for this ShapeCoordinate. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.ShapeCoordinate a, HPS.ShapeCoordinate b) |
static bool | operator== (HPS.ShapeCoordinate a, HPS.ShapeCoordinate b) |
Protected Member Functions | |
virtual void | deleteCptr () |
Protected Attributes | |
bool | cMemOwn |
HandleRef | cptr |
Properties | |
float[] | margins [get, set] |
float | radius [get, set] |
float | x [get, set] |
float | y [get, set] |
Detailed Description
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.
Constructor & Destructor Documentation
|
inline |
Construct a new ShapeCoordinate from an (x, y) pair.
- Parameters
-
in_x A normalized distance over the horizontal text bounds. in_y A normalized distance over the vertical text bounds.
|
inline |
Construct a new ShapeCoordinate from an (x, y) pair and up to four margins values
- Parameters
-
in_x A normalized distance over the horizontal text bounds. in_y A normalized distance over the vertical text bounds. in_margins A series of up to four distances, normalized over the respective text margins.
|
inline |
Construct a new ShapeCoordinate from an (x, y, radius) tuple.
- Parameters
-
in_x A normalized distance over the horizontal text bounds. in_y A normalized distance over the vertical text bounds. in_radius A normalized distance over the radius of the circle circumscribing the text bounds.
|
inline |
Construct a new ShapeCoordinate from an (x, y, radius) tuple and up to four margin values.
- Parameters
-
in_x A normalized distance over the horizontal text bounds. in_y A normalized distance over the vertical text bounds. in_radius A normalized distance over the radius of the circle circumscribing the text bounds. in_margins A series of up to four distances, normalized over the respective text margins.
Member Function Documentation
|
inline |
This function is used to check an object for equivalence to this.
- Parameters
-
in_that The object to compare to this.
- Returns
- true if the objects are equivalent, false otherwise.
|
inline |
Sets the margins for this ShapeCoordinate.
- Parameters
-
in_margin_one The first margin value. in_margin_two The second margin value. in_margin_three The third margin value. in_margin_four The fourth margin value.
- Returns
- A reference to this ShapeCoordinate.
|
inline |
Sets the margins for this ShapeCoordinate.
- Parameters
-
in_margin_one The first margin value. in_margin_two The second margin value. in_margin_three The third margin value.
- Returns
- A reference to this ShapeCoordinate.
|
inline |
Sets the margins for this ShapeCoordinate.
- Parameters
-
in_margin_one The first margin value. in_margin_two The second margin value.
- Returns
- A reference to this ShapeCoordinate.
|
inline |
Sets the margins for this ShapeCoordinate.
- Parameters
-
in_margin_one The first margin value.
- Returns
- A reference to this ShapeCoordinate.
|
inline |
Shows the margins for this ShapeCoordinate.
- Parameters
-
out_margins The margins for this ShapeCoordinate.
- Returns
- true if margins were set, false otherwise.
|
inline |
Removes the margins for this ShapeCoordinate.
- Returns
- A reference to this ShapeCoordinate.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.ShapeCoordinate.cs