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

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 
 PolygonShapeElement ()
 
 PolygonShapeElement (HPS.ShapeElement in_that)
 
 PolygonShapeElement (HPS.PolygonShapeElement in_that)
 
 PolygonShapeElement (HPS.ShapePoint[] in_points)
 
HPS.PolygonShapeElement SetPoints (HPS.ShapePoint[] in_points)
 
bool ShowPoints (out HPS.ShapePoint[] out_points)
 
- 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 PolygonShapeElement class is a user space object. It is used to define polygon elements to make up shapes for text backgrounds.

Constructor & Destructor Documentation

◆ PolygonShapeElement() [1/4]

HPS.PolygonShapeElement.PolygonShapeElement ( )
inline

The default constructor creates an empty PolygonShapeElement object.

◆ PolygonShapeElement() [2/4]

HPS.PolygonShapeElement.PolygonShapeElement ( HPS.ShapeElement  in_that)
inline

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

Parameters
in_thatThe source ShapeElement to copy.

◆ PolygonShapeElement() [3/4]

HPS.PolygonShapeElement.PolygonShapeElement ( HPS.PolygonShapeElement  in_that)
inline

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

Parameters
in_thatThe source PolygonShapeElement to copy.

◆ PolygonShapeElement() [4/4]

HPS.PolygonShapeElement.PolygonShapeElement ( HPS.ShapePoint []  in_points)
inline

This constructor creates a PolygonShapeElement with the specified point array.

Parameters
in_pointsThe points for the polygon.

Member Function Documentation

◆ ObjectType()

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

◆ SetPoints()

HPS.PolygonShapeElement HPS.PolygonShapeElement.SetPoints ( HPS.ShapePoint []  in_points)
inline

Sets the points for this PolygonShapeElement.

Parameters
in_pointsThe points for the polygon.

◆ ShowPoints()

bool HPS.PolygonShapeElement.ShowPoints ( out HPS.ShapePoint []  out_points)
inline

Shows the points for this PolygonShapeElement.

Parameters
out_pointsThe points for the polygon.
Returns
true if points were set, false otherwise.

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