
Public Member Functions | |
override void | Dispose () |
EllipseShapeElement () | |
The default constructor creates an empty EllipseShapeElement object. More... | |
EllipseShapeElement (HPS.ShapeElement in_that) | |
This constructor creates a EllipseShapeElement object that contains the same settings as the source ShapeElement. The copy will only be successful if the source shape element is really an upcast of an ellipse shape element. Otherwise the copy will fail and the resulting EllipseShapeElement will be invalid. More... | |
EllipseShapeElement (HPS.EllipseShapeElement in_that) | |
The copy constructor creates a new EllipseShapeElement object that contains the same settings as the source EllipseShapeElement. More... | |
EllipseShapeElement (HPS.ShapePoint in_center, HPS.ShapePoint in_major_axis_point, HPS.ShapePoint in_minor_axis_point) | |
This constructor creates a EllipseShapeElement with the specified point array. More... | |
override HPS.Type | ObjectType () |
HPS.EllipseShapeElement | SetCenter (HPS.ShapePoint in_center) |
Sets the points for this EllipseShapeElement. More... | |
HPS.EllipseShapeElement | SetMajorAxisPoint (HPS.ShapePoint in_major_axis_point) |
Sets a point on the major axis for this EllipseShapeElement. More... | |
HPS.EllipseShapeElement | SetMinorAxisPoint (HPS.ShapePoint in_minor_axis_point) |
Sets a point on the minor axis for this EllipseShapeElement. More... | |
bool | ShowCenter (out HPS.ShapePoint out_center) |
Shows the center point for this EllipseShapeElement. More... | |
bool | ShowMajorAxisPoint (out HPS.ShapePoint out_major_axis_point) |
Shows the major axis point for this EllipseShapeElement. More... | |
bool | ShowMinorAxisPoint (out HPS.ShapePoint out_minor_axis_point) |
Shows the minor axis point for this EllipseShapeElement. More... | |
![]() | |
override void | Dispose () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.ShapeElement in_that) |
Check if the source ShapeElement is equivalent to this ShapeElement. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
void | Set (HPS.ShapeElement in_that) |
Copies the source ShapeElement into this ShapeElement. More... | |
HPS.ShapeElement | SetDisjointed (bool in_state) |
Sets the disjointed state for this ShapeElement. Two shape elements of the same type are automatically joined together if they appear consecutively in the shape element array. LineShapeElement objects are always disjointed. More... | |
HPS.ShapeElement | SetFill (bool in_state) |
Sets the fill mode for this ShapeElement. All shape elements default to being filled, except for Lines which cannot be filled. More... | |
ShapeElement () | |
The default constructor creates an empty ShapeElement object. More... | |
ShapeElement (HPS.ShapeElement in_that) | |
The copy constructor creates a new ShapeElement object that contains the same settings as the source ShapeElement. More... | |
bool | ShowDisjointed (out bool out_state) |
Shows the disjointed state for this ShapeElement. Two shape elements of the same type are automatically joined together if they appear consecutively in the shape element array. LineShapeElement objects are always disjointed. More... | |
bool | ShowFill (out bool out_state) |
Shows the fill mode for this ShapeElement. All shape elements default to being filled, except for Lines which cannot be filled. More... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.ShapeElement a, HPS.ShapeElement b) |
static bool | operator== (HPS.ShapeElement a, HPS.ShapeElement b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The EllipseShapeElement class is a user space object. It is used to define ellipse elements to make up shapes for text backgrounds.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty EllipseShapeElement object.
|
inline |
This constructor creates a EllipseShapeElement object that contains the same settings as the source ShapeElement. The copy will only be successful if the source shape element is really an upcast of an ellipse shape element. Otherwise the copy will fail and the resulting EllipseShapeElement will be invalid.
- Parameters
-
in_that The source ShapeElement to copy.
|
inline |
The copy constructor creates a new EllipseShapeElement object that contains the same settings as the source EllipseShapeElement.
- Parameters
-
in_that The source EllipseShapeElement to copy.
|
inline |
This constructor creates a EllipseShapeElement with the specified point array.
- Parameters
-
in_center The center of the ellipse. in_major_axis_point A point defining the major axis of the ellipse in_minor_axis_point A point defining the minor axis of the ellipse.
Member Function Documentation
|
inline |
Sets the points for this EllipseShapeElement.
- Parameters
-
in_center The center point of the ellipse.
|
inline |
Sets a point on the major axis for this EllipseShapeElement.
- Parameters
-
in_major_axis_point The point on the major axis of the ellipse.
|
inline |
Sets a point on the minor axis for this EllipseShapeElement.
- Parameters
-
in_minor_axis_point The point on the minor axis of the ellipse.
|
inline |
Shows the center point for this EllipseShapeElement.
- Parameters
-
out_center The center point for the ellipse.
- Returns
- true if a center point was set, false otherwise.
|
inline |
Shows the major axis point for this EllipseShapeElement.
- Parameters
-
out_major_axis_point The major axis point for the ellipse.
- Returns
- true if a major axis point was set, false otherwise.
|
inline |
Shows the minor axis point for this EllipseShapeElement.
- Parameters
-
out_minor_axis_point The minor axis point for the ellipse.
- Returns
- true if a minor axis point was set, false otherwise.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.EllipseShapeElement.cs