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

Public Member Functions

 CircularArcShapeElement ()
 
 CircularArcShapeElement (HPS.ShapeElement in_that)
 
 CircularArcShapeElement (HPS.CircularArcShapeElement in_that)
 
 CircularArcShapeElement (HPS.ShapePoint in_start_point, HPS.ShapePoint in_middle_point, HPS.ShapePoint in_end_point)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.CircularArcShapeElement SetEndPoint (HPS.ShapePoint in_end)
 
HPS.CircularArcShapeElement SetMiddlePoint (HPS.ShapePoint in_middle)
 
HPS.CircularArcShapeElement SetStartPoint (HPS.ShapePoint in_start)
 
bool ShowEndPoint (out HPS.ShapePoint out_end)
 
bool ShowMiddlePoint (out HPS.ShapePoint out_middle)
 
bool ShowStartPoint (out HPS.ShapePoint 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 CircularArcShapeElement class is a user space object. It is used to define circular arc elements to make up shapes for text backgrounds.

Constructor & Destructor Documentation

◆ CircularArcShapeElement() [1/4]

HPS.CircularArcShapeElement.CircularArcShapeElement ( )
inline

The default constructor creates an empty CircularArcShapeElement object.

◆ CircularArcShapeElement() [2/4]

HPS.CircularArcShapeElement.CircularArcShapeElement ( HPS.ShapeElement  in_that)
inline

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

Parameters
in_thatThe source ShapeElement to copy.

◆ CircularArcShapeElement() [3/4]

HPS.CircularArcShapeElement.CircularArcShapeElement ( HPS.CircularArcShapeElement  in_that)
inline

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

Parameters
in_thatThe source CircularArcShapeElement to copy.

◆ CircularArcShapeElement() [4/4]

HPS.CircularArcShapeElement.CircularArcShapeElement ( HPS.ShapePoint  in_start_point,
HPS.ShapePoint  in_middle_point,
HPS.ShapePoint  in_end_point 
)
inline

This constructor creates a CircularArcShapeElement with the specified parameters.

Parameters
in_start_pointThe start of the arc.
in_middle_pointA point between the start and the end point, where the arc passes through
in_end_pointThe end of the arc.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.CircularArcShapeElement.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.

◆ SetEndPoint()

HPS.CircularArcShapeElement HPS.CircularArcShapeElement.SetEndPoint ( HPS.ShapePoint  in_end)
inline

Sets the end point for this CircularArcShapeElement.

Parameters
in_endThe end point of the arc.

◆ SetMiddlePoint()

HPS.CircularArcShapeElement HPS.CircularArcShapeElement.SetMiddlePoint ( HPS.ShapePoint  in_middle)
inline

Sets the minor axis point for this CircularArcShapeElement.

Parameters
in_middleA point between the start and the end point. The arc passes through this point.

◆ SetStartPoint()

HPS.CircularArcShapeElement HPS.CircularArcShapeElement.SetStartPoint ( HPS.ShapePoint  in_start)
inline

Sets the center point for this CircularArcShapeElement.

Parameters
in_startThe start of the arc.

◆ ShowEndPoint()

bool HPS.CircularArcShapeElement.ShowEndPoint ( out HPS.ShapePoint  out_end)
inline

Shows the end point for this CircularArcShapeElement.

Parameters
out_endThe end point of the arc
Returns
true if an end point was set, false otherwise.

◆ ShowMiddlePoint()

bool HPS.CircularArcShapeElement.ShowMiddlePoint ( out HPS.ShapePoint  out_middle)
inline

Shows the middle point for this CircularArcShapeElement.

Parameters
out_middleA point between the start and the end point. The arc passes through this point.
Returns
true if a middle point was set, false otherwise.

◆ ShowStartPoint()

bool HPS.CircularArcShapeElement.ShowStartPoint ( out HPS.ShapePoint  out_start)
inline

Shows the center point for this CircularArcShapeElement.

Parameters
out_startThe start for the arc.
Returns
true if a star point was set, false otherwise.

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