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

Public Member Functions

override void Dispose ()
 
 LineShapeElement ()
 
 LineShapeElement (HPS.ShapeElement in_that)
 
 LineShapeElement (HPS.LineShapeElement in_that)
 
 LineShapeElement (HPS.ShapePoint[] in_points)
 
 LineShapeElement (HPS.ShapePoint in_start, HPS.ShapePoint in_end)
 
override HPS.Type ObjectType ()
 
HPS.LineShapeElement 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 LineShapeElement class is a user space object. It is used to define line elements to make up shapes for text backgrounds.

Constructor & Destructor Documentation

◆ LineShapeElement() [1/5]

HPS.LineShapeElement.LineShapeElement ( )
inline

The default constructor creates an empty LineShapeElement object.

◆ LineShapeElement() [2/5]

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

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

Parameters
in_thatThe source ShapeElement to copy.

◆ LineShapeElement() [3/5]

HPS.LineShapeElement.LineShapeElement ( HPS.LineShapeElement  in_that)
inline

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

Parameters
in_thatThe source LineShapeElement to copy.

◆ LineShapeElement() [4/5]

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

This constructor creates a LineShapeElement with the specified points.

Parameters
in_pointsThe points making up the line.

◆ LineShapeElement() [5/5]

HPS.LineShapeElement.LineShapeElement ( HPS.ShapePoint  in_start,
HPS.ShapePoint  in_end 
)
inline

This constructor creates a two-point LineShapeElement with the specified points.

Parameters
in_startThe start of the line.
in_endThe end of the line.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.LineShapeElement.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.LineShapeElement HPS.LineShapeElement.SetPoints ( HPS.ShapePoint []  in_points)
inline

Sets the points for this LineShapeElement.

Parameters
in_pointsThe points making up the line.

◆ ShowPoints()

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

Shows the points for this LineShapeElement.

Parameters
out_pointsThe points for this line
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.LineShapeElement.cs