HPS.EllipseShapeElement Class Reference
Inheritance diagram for HPS.EllipseShapeElement:
HPS.ShapeElement HPS.Object

Public Member Functions

override void Dispose ()
 
 EllipseShapeElement ()
 
 EllipseShapeElement (HPS.ShapeElement in_that)
 
 EllipseShapeElement (HPS.EllipseShapeElement in_that)
 
 EllipseShapeElement (HPS.ShapePoint in_center, HPS.ShapePoint in_major_axis_point, HPS.ShapePoint in_minor_axis_point)
 
override HPS.Type ObjectType ()
 
HPS.EllipseShapeElement SetCenter (HPS.ShapePoint in_center)
 
HPS.EllipseShapeElement SetMajorAxisPoint (HPS.ShapePoint in_major_axis_point)
 
HPS.EllipseShapeElement SetMinorAxisPoint (HPS.ShapePoint in_minor_axis_point)
 
bool ShowCenter (out HPS.ShapePoint out_center)
 
bool ShowMajorAxisPoint (out HPS.ShapePoint out_major_axis_point)
 
bool ShowMinorAxisPoint (out HPS.ShapePoint out_minor_axis_point)
 
- Public Member Functions inherited from HPS.ShapeElement
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.ShapeElement in_that)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.ShapeElement in_that)
 
HPS.ShapeElement SetDisjointed (bool in_state)
 
HPS.ShapeElement SetFill (bool in_state)
 
 ShapeElement ()
 
 ShapeElement (HPS.ShapeElement in_that)
 
bool ShowDisjointed (out bool out_state)
 
bool ShowFill (out bool out_state)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.ShapeElement
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.ShapeElement
static bool operator!= (HPS.ShapeElement a, HPS.ShapeElement b)
 
static bool operator== (HPS.ShapeElement a, HPS.ShapeElement b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
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

◆ EllipseShapeElement() [1/4]

HPS.EllipseShapeElement.EllipseShapeElement ( )
inline

The default constructor creates an empty EllipseShapeElement object.

◆ EllipseShapeElement() [2/4]

HPS.EllipseShapeElement.EllipseShapeElement ( HPS.ShapeElement  in_that)
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_thatThe source ShapeElement to copy.

◆ EllipseShapeElement() [3/4]

HPS.EllipseShapeElement.EllipseShapeElement ( HPS.EllipseShapeElement  in_that)
inline

The copy constructor creates a new EllipseShapeElement object that contains the same settings as the source EllipseShapeElement.

Parameters
in_thatThe source EllipseShapeElement to copy.

◆ EllipseShapeElement() [4/4]

HPS.EllipseShapeElement.EllipseShapeElement ( HPS.ShapePoint  in_center,
HPS.ShapePoint  in_major_axis_point,
HPS.ShapePoint  in_minor_axis_point 
)
inline

This constructor creates a EllipseShapeElement with the specified point array.

Parameters
in_centerThe center of the ellipse.
in_major_axis_pointA point defining the major axis of the ellipse
in_minor_axis_pointA point defining the minor axis of the ellipse.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.EllipseShapeElement.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

◆ SetCenter()

HPS.EllipseShapeElement HPS.EllipseShapeElement.SetCenter ( HPS.ShapePoint  in_center)
inline

Sets the points for this EllipseShapeElement.

Parameters
in_centerThe center point of the ellipse.

◆ SetMajorAxisPoint()

HPS.EllipseShapeElement HPS.EllipseShapeElement.SetMajorAxisPoint ( HPS.ShapePoint  in_major_axis_point)
inline

Sets a point on the major axis for this EllipseShapeElement.

Parameters
in_major_axis_pointThe point on the major axis of the ellipse.

◆ SetMinorAxisPoint()

HPS.EllipseShapeElement HPS.EllipseShapeElement.SetMinorAxisPoint ( HPS.ShapePoint  in_minor_axis_point)
inline

Sets a point on the minor axis for this EllipseShapeElement.

Parameters
in_minor_axis_pointThe point on the minor axis of the ellipse.

◆ ShowCenter()

bool HPS.EllipseShapeElement.ShowCenter ( out HPS.ShapePoint  out_center)
inline

Shows the center point for this EllipseShapeElement.

Parameters
out_centerThe center point for the ellipse.
Returns
true if a center point was set, false otherwise.

◆ ShowMajorAxisPoint()

bool HPS.EllipseShapeElement.ShowMajorAxisPoint ( out HPS.ShapePoint  out_major_axis_point)
inline

Shows the major axis point for this EllipseShapeElement.

Parameters
out_major_axis_pointThe major axis point for the ellipse.
Returns
true if a major axis point was set, false otherwise.

◆ ShowMinorAxisPoint()

bool HPS.EllipseShapeElement.ShowMinorAxisPoint ( out HPS.ShapePoint  out_minor_axis_point)
inline

Shows the minor axis point for this EllipseShapeElement.

Parameters
out_minor_axis_pointThe 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