HPS.PolygonShapeElement Class Reference

The PolygonShapeElement class is a user space object. It is used to define polygon elements to make up shapes for text backgrounds. More...

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

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
 PolygonShapeElement ()
 The default constructor creates an empty PolygonShapeElement object. More...
 
 PolygonShapeElement (HPS.ShapeElement in_that)
 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. More...
 
 PolygonShapeElement (HPS.PolygonShapeElement in_that)
 The copy constructor creates a new PolygonShapeElement object that contains the same settings as the source PolygonShapeElement. More...
 
 PolygonShapeElement (HPS.ShapePoint[] in_points)
 This constructor creates a PolygonShapeElement with the specified point array. More...
 
HPS.PolygonShapeElement SetPoints (HPS.ShapePoint[] in_points)
 Sets the points for this PolygonShapeElement. More...
 
bool ShowPoints (out HPS.ShapePoint[] out_points)
 Shows the points for this PolygonShapeElement. More...
 
- Public Member Functions inherited from HPS.ShapeElement
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.ShapeElement in_that)
 Check if the source ShapeElement is equivalent to this ShapeElement. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.ShapeElement in_that)
 Copies the source ShapeElement into this ShapeElement. More...
 
HPS.ShapeElement SetDisjointed (bool in_state)
 Sets the disjointed state for this ShapeElement. Two shape elements of the same type are automatically joined together if they appear consecutively in the shape element array. LineShapeElement objects are always disjointed. More...
 
HPS.ShapeElement SetFill (bool in_state)
 Sets the fill mode for this ShapeElement. All shape elements default to being filled, except for Lines which cannot be filled. More...
 
 ShapeElement ()
 The default constructor creates an empty ShapeElement object. More...
 
 ShapeElement (HPS.ShapeElement in_that)
 The copy constructor creates a new ShapeElement object that contains the same settings as the source ShapeElement. More...
 
bool ShowDisjointed (out bool out_state)
 Shows the disjointed state for this ShapeElement. Two shape elements of the same type are automatically joined together if they appear consecutively in the shape element array. LineShapeElement objects are always disjointed. More...
 
bool ShowFill (out bool out_state)
 Shows the fill mode for this ShapeElement. All shape elements default to being filled, except for Lines which cannot be filled. More...
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
virtual HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 

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

HPS.PolygonShapeElement.PolygonShapeElement ( )
inline

The default constructor creates an empty PolygonShapeElement object.

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.
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.
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

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

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

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

Sets the points for this PolygonShapeElement.

Parameters
in_pointsThe points for the polygon.
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