Inheritance diagram for HPS.ShapeElement:
HPS.Object HPS.AnchorShapeElement HPS.CircleShapeElement HPS.CircularArcShapeElement HPS.EllipseShapeElement HPS.EllipticalArcShapeElement HPS.LeaderLineClippingElement HPS.LineShapeElement HPS.PolygonShapeElement

Public Member Functions

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 ()
 

Static Public Member Functions

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 Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The ShapeElement class is a user space object. It is the base class for all shape elements.

Constructor & Destructor Documentation

◆ ShapeElement() [1/2]

HPS.ShapeElement.ShapeElement ( )
inline

The default constructor creates an empty ShapeElement object.

◆ ShapeElement() [2/2]

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

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

Parameters
in_thatThe source ShapeElement to copy.

Member Function Documentation

◆ Equals()

bool HPS.ShapeElement.Equals ( HPS.ShapeElement  in_that)
inline

Check if the source ShapeElement is equivalent to this ShapeElement.

Parameters
in_thatThe source ShapeElement to compare to this ShapeElement.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

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

◆ Set()

void HPS.ShapeElement.Set ( HPS.ShapeElement  in_that)
inline

Copies the source ShapeElement into this ShapeElement.

Parameters
in_thatThe source ShapeElement to copy.

◆ SetDisjointed()

HPS.ShapeElement HPS.ShapeElement.SetDisjointed ( bool  in_state)
inline

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.

Parameters
in_stateThe disjointed state for this ShapeElement.

◆ SetFill()

HPS.ShapeElement HPS.ShapeElement.SetFill ( bool  in_state)
inline

Sets the fill mode for this ShapeElement. All shape elements default to being filled, except for Lines which cannot be filled.

Parameters
in_stateThe fill mode for this ShapeElement.

◆ ShowDisjointed()

bool HPS.ShapeElement.ShowDisjointed ( out bool  out_state)
inline

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.

Parameters
out_stateWhether this shape element will be disjointed from the previous one.
Returns
true if a disjointed state was set, false otherwise.

◆ ShowFill()

bool HPS.ShapeElement.ShowFill ( out bool  out_state)
inline

Shows the fill mode for this ShapeElement. All shape elements default to being filled, except for Lines which cannot be filled.

Parameters
out_stateWhether faces are drawn for this shape element.
Returns
true if a fill mode was set, false otherwise.

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