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

Public Member Functions

 CircleShapeElement ()
 
 CircleShapeElement (HPS.ShapeElement in_that)
 
 CircleShapeElement (HPS.CircleShapeElement in_that)
 
 CircleShapeElement (HPS.ShapePoint in_center, HPS.ShapePoint in_radius)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.CircleShapeElement SetCenter (HPS.ShapePoint in_center)
 
HPS.CircleShapeElement SetRadius (HPS.ShapePoint in_radius)
 
bool ShowCenter (out HPS.ShapePoint out_center)
 
bool ShowRadius (out HPS.ShapePoint out_radius)
 
- 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 CircleShapeElement class is a user space object. It is used to define circle elements to make up shapes for text backgrounds.

Constructor & Destructor Documentation

◆ CircleShapeElement() [1/4]

HPS.CircleShapeElement.CircleShapeElement ( )
inline

The default constructor creates an empty CircleShapeElement object.

◆ CircleShapeElement() [2/4]

HPS.CircleShapeElement.CircleShapeElement ( HPS.ShapeElement  in_that)
inline

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

Parameters
in_thatThe source ShapeElement to copy.

◆ CircleShapeElement() [3/4]

HPS.CircleShapeElement.CircleShapeElement ( HPS.CircleShapeElement  in_that)
inline

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

Parameters
in_thatThe source CircleShapeElement to copy.

◆ CircleShapeElement() [4/4]

HPS.CircleShapeElement.CircleShapeElement ( HPS.ShapePoint  in_center,
HPS.ShapePoint  in_radius 
)
inline

This constructor creates a CircleShapeElement with the specified center and radius points.

Parameters
in_centerThe center point of the circle.
in_radiusThe radius of the circle.

Member Function Documentation

◆ ObjectType()

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

Sets the center point for this CircleShapeElement.

Parameters
in_centerThe center point of the circle.

◆ SetRadius()

HPS.CircleShapeElement HPS.CircleShapeElement.SetRadius ( HPS.ShapePoint  in_radius)
inline

Sets the radius point for this CircleShapeElement.

Parameters
in_radiusThe radius point of the circle.

◆ ShowCenter()

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

Shows the center point for this CircleShapeElement.

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

◆ ShowRadius()

bool HPS.CircleShapeElement.ShowRadius ( out HPS.ShapePoint  out_radius)
inline

Shows the radius point for this CircleShapeElement.

Parameters
out_radiusThe radius point for the circle.
Returns
true if a radius was set, false otherwise.

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