|
virtual void | Dispose () |
|
override bool | Equals (System.Object obj) |
|
bool | Equals (HPS.ShapeCoordinate in_that) |
|
override int | GetHashCode () |
|
HPS.ShapeCoordinate | SetMargins (float in_margin_one, float in_margin_two, float in_margin_three, float in_margin_four) |
|
HPS.ShapeCoordinate | SetMargins (float in_margin_one, float in_margin_two, float in_margin_three) |
|
HPS.ShapeCoordinate | SetMargins (float in_margin_one, float in_margin_two) |
|
HPS.ShapeCoordinate | SetMargins (float in_margin_one) |
|
| ShapeCoordinate (float in_x, float in_y) |
|
| ShapeCoordinate (float in_x, float in_y, float[] in_margins) |
|
| ShapeCoordinate (float in_x, float in_y, float in_radius) |
|
| ShapeCoordinate (float in_x, float in_y, float in_radius, float[] in_margins) |
|
| ShapeCoordinate (HPS.ShapeCoordinate in_that) |
|
bool | ShowMargins (out float[] out_margins) |
|
HPS.ShapeCoordinate | UnsetMargins () |
|
|
virtual void | deleteCptr () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
|
float [] | margins [get, set] |
|
float | radius [get, set] |
|
float | x [get, set] |
|
float | y [get, set] |
|
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.
◆ ShapeCoordinate() [1/4]
HPS.ShapeCoordinate.ShapeCoordinate |
( |
float |
in_x, |
|
|
float |
in_y |
|
) |
| |
|
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. |
◆ ShapeCoordinate() [2/4]
HPS.ShapeCoordinate.ShapeCoordinate |
( |
float |
in_x, |
|
|
float |
in_y, |
|
|
float [] |
in_margins |
|
) |
| |
|
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. |
◆ ShapeCoordinate() [3/4]
HPS.ShapeCoordinate.ShapeCoordinate |
( |
float |
in_x, |
|
|
float |
in_y, |
|
|
float |
in_radius |
|
) |
| |
|
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. |
◆ ShapeCoordinate() [4/4]
HPS.ShapeCoordinate.ShapeCoordinate |
( |
float |
in_x, |
|
|
float |
in_y, |
|
|
float |
in_radius, |
|
|
float [] |
in_margins |
|
) |
| |
|
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. |
◆ Equals()
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.
◆ SetMargins() [1/4]
HPS.ShapeCoordinate HPS.ShapeCoordinate.SetMargins |
( |
float |
in_margin_one, |
|
|
float |
in_margin_two, |
|
|
float |
in_margin_three, |
|
|
float |
in_margin_four |
|
) |
| |
|
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.
◆ SetMargins() [2/4]
HPS.ShapeCoordinate HPS.ShapeCoordinate.SetMargins |
( |
float |
in_margin_one, |
|
|
float |
in_margin_two, |
|
|
float |
in_margin_three |
|
) |
| |
|
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.
◆ SetMargins() [3/4]
HPS.ShapeCoordinate HPS.ShapeCoordinate.SetMargins |
( |
float |
in_margin_one, |
|
|
float |
in_margin_two |
|
) |
| |
|
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.
◆ SetMargins() [4/4]
◆ ShowMargins()
bool HPS.ShapeCoordinate.ShowMargins |
( |
out float [] |
out_margins | ) |
|
|
inline |
Shows the margins for this ShapeCoordinate.
- Parameters
-
- Returns
- true if margins were set, false otherwise.
◆ UnsetMargins()
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.ShapeCoordinate.cs