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

Public Member Functions

override void Dispose ()
 
 EllipticalArcShapeElement ()
 
 EllipticalArcShapeElement (HPS.ShapeElement in_that)
 
 EllipticalArcShapeElement (HPS.EllipticalArcShapeElement in_that)
 
 EllipticalArcShapeElement (HPS.ShapePoint in_center, HPS.ShapePoint in_major_axis_point, HPS.ShapePoint in_minor_axis_point, float in_start, float in_end)
 
 EllipticalArcShapeElement (HPS.ShapePoint in_center, HPS.ShapePoint in_major_axis_point, HPS.ShapePoint in_minor_axis_point, float in_start)
 
 EllipticalArcShapeElement (HPS.ShapePoint in_center, HPS.ShapePoint in_major_axis_point, HPS.ShapePoint in_minor_axis_point)
 
override HPS.Type ObjectType ()
 
HPS.EllipticalArcShapeElement SetCenter (HPS.ShapePoint in_center)
 
HPS.EllipticalArcShapeElement SetEnd (float in_end)
 
HPS.EllipticalArcShapeElement SetMajorAxisPoint (HPS.ShapePoint in_major_axis_point)
 
HPS.EllipticalArcShapeElement SetMinorAxisPoint (HPS.ShapePoint in_minor_axis_point)
 
HPS.EllipticalArcShapeElement SetStart (float in_start)
 
bool ShowCenter (out HPS.ShapePoint out_center)
 
bool ShowEnd (out float out_end)
 
bool ShowMajorAxisPoint (out HPS.ShapePoint out_major_axis_point)
 
bool ShowMinorAxisPoint (out HPS.ShapePoint out_minor_axis_point)
 
bool ShowStart (out float out_start)
 
- 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 EllipticalArcShapeElement class is a user space object. It is used to define elliptical arc elements to make up shapes for text backgrounds.

Constructor & Destructor Documentation

◆ EllipticalArcShapeElement() [1/6]

HPS.EllipticalArcShapeElement.EllipticalArcShapeElement ( )
inline

The default constructor creates an empty EllipticalArcShapeElement object.

◆ EllipticalArcShapeElement() [2/6]

HPS.EllipticalArcShapeElement.EllipticalArcShapeElement ( HPS.ShapeElement  in_that)
inline

This constructor creates a EllipticalArcShapeElement 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 elliptical arc shape element. Otherwise the copy will fail and the resulting EllipticalArcShapeElement will be invalid.

Parameters
in_thatThe source ShapeElement to copy.

◆ EllipticalArcShapeElement() [3/6]

HPS.EllipticalArcShapeElement.EllipticalArcShapeElement ( HPS.EllipticalArcShapeElement  in_that)
inline

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

Parameters
in_thatThe source EllipticalArcShapeElement to copy.

◆ EllipticalArcShapeElement() [4/6]

HPS.EllipticalArcShapeElement.EllipticalArcShapeElement ( HPS.ShapePoint  in_center,
HPS.ShapePoint  in_major_axis_point,
HPS.ShapePoint  in_minor_axis_point,
float  in_start,
float  in_end 
)
inline

This constructor creates a EllipticalArcShapeElement with the specified parameters.

Parameters
in_centerThe center point of the arc.
in_major_axis_pointA point defining the major axis of the arc.
in_minor_axis_pointA point defining the minor axis of the arc.
in_startThe start of the arc, in degrees.
in_endThe end of the arc, in degrees.

◆ EllipticalArcShapeElement() [5/6]

HPS.EllipticalArcShapeElement.EllipticalArcShapeElement ( HPS.ShapePoint  in_center,
HPS.ShapePoint  in_major_axis_point,
HPS.ShapePoint  in_minor_axis_point,
float  in_start 
)
inline

This constructor creates a EllipticalArcShapeElement with the specified parameters.

Parameters
in_centerThe center point of the arc.
in_major_axis_pointA point defining the major axis of the arc.
in_minor_axis_pointA point defining the minor axis of the arc.
in_startThe start of the arc, in degrees.

◆ EllipticalArcShapeElement() [6/6]

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

This constructor creates a EllipticalArcShapeElement with the specified parameters.

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

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.EllipticalArcShapeElement.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.EllipticalArcShapeElement HPS.EllipticalArcShapeElement.SetCenter ( HPS.ShapePoint  in_center)
inline

Sets the center point for this EllipticalArcShapeElement.

Parameters
in_centerThe center point of the arc.

◆ SetEnd()

HPS.EllipticalArcShapeElement HPS.EllipticalArcShapeElement.SetEnd ( float  in_end)
inline

Sets the end for this EllipticalArcShapeElement.

Parameters
in_endThe ending point of this arc, expressed in degrees

◆ SetMajorAxisPoint()

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

Sets the major axis point for this EllipticalArcShapeElement.

Parameters
in_major_axis_pointA point defining the major axis of the arc.

◆ SetMinorAxisPoint()

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

Sets the minor axis point for this EllipticalArcShapeElement.

Parameters
in_minor_axis_pointA point defining the minor axis of the arc.

◆ SetStart()

HPS.EllipticalArcShapeElement HPS.EllipticalArcShapeElement.SetStart ( float  in_start)
inline

Sets the start for this EllipticalArcShapeElement.

Parameters
in_startThe starting point of this arc, expressed in degrees

◆ ShowCenter()

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

Shows the center point for this EllipticalArcShapeElement.

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

◆ ShowEnd()

bool HPS.EllipticalArcShapeElement.ShowEnd ( out float  out_end)
inline

Shows the end point for this EllipticalArcShapeElement.

Parameters
out_endThe ending point of this arc, expressed in degrees
Returns
true if an end point was set, false otherwise.

◆ ShowMajorAxisPoint()

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

Shows the major axis point for this EllipticalArcShapeElement.

Parameters
out_major_axis_pointA point defining the major axis of the arc.
Returns
true if a major axis point was set, false otherwise.

◆ ShowMinorAxisPoint()

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

Shows the minor axis point for this EllipticalArcShapeElement.

Parameters
out_minor_axis_pointA point defining the minor axis of the arc.
Returns
true if a minor axis point was set, false otherwise.

◆ ShowStart()

bool HPS.EllipticalArcShapeElement.ShowStart ( out float  out_start)
inline

Shows the start point for this EllipticalArcShapeElement.

Parameters
out_startThe starting point of this arc, expressed in degrees
Returns
true if a start point was set, false otherwise.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.EllipticalArcShapeElement.cs