API Search || Global Search
HPS.CircularArcShapeElement Class Reference

More...

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

Public Member Functions

 CircularArcShapeElement ()
 The default constructor creates an empty CircularArcShapeElement object. More...
 
 CircularArcShapeElement (HPS.ShapeElement in_that)
 This constructor creates a CircularArcShapeElement 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 circular arc shape element. Otherwise the copy will fail and the resulting CircularArcShapeElement will be invalid. More...
 
 CircularArcShapeElement (HPS.CircularArcShapeElement in_that)
 The copy constructor creates a new CircularArcShapeElement object that contains the same settings as the source CircularArcShapeElement. More...
 
 CircularArcShapeElement (HPS.ShapePoint in_start_point, HPS.ShapePoint in_middle_point, HPS.ShapePoint in_end_point)
 This constructor creates a CircularArcShapeElement with the specified parameters. More...
 
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...
 
HPS.CircularArcShapeElement SetEndPoint (HPS.ShapePoint in_end)
 Sets the end point for this CircularArcShapeElement. More...
 
HPS.CircularArcShapeElement SetMiddlePoint (HPS.ShapePoint in_middle)
 Sets the minor axis point for this CircularArcShapeElement. More...
 
HPS.CircularArcShapeElement SetStartPoint (HPS.ShapePoint in_start)
 Sets the center point for this CircularArcShapeElement. More...
 
bool ShowEndPoint (out HPS.ShapePoint out_end)
 Shows the end point for this CircularArcShapeElement. More...
 
bool ShowMiddlePoint (out HPS.ShapePoint out_middle)
 Shows the middle point for this CircularArcShapeElement. More...
 
bool ShowStartPoint (out HPS.ShapePoint out_start)
 Shows the center point for this CircularArcShapeElement. 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 CircularArcShapeElement class is a user space object. It is used to define circular arc elements to make up shapes for text backgrounds.

Constructor & Destructor Documentation

HPS.CircularArcShapeElement.CircularArcShapeElement ( )
inline

The default constructor creates an empty CircularArcShapeElement object.

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

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

Parameters
in_thatThe source ShapeElement to copy.
HPS.CircularArcShapeElement.CircularArcShapeElement ( HPS.CircularArcShapeElement  in_that)
inline

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

Parameters
in_thatThe source CircularArcShapeElement to copy.
HPS.CircularArcShapeElement.CircularArcShapeElement ( HPS.ShapePoint  in_start_point,
HPS.ShapePoint  in_middle_point,
HPS.ShapePoint  in_end_point 
)
inline

This constructor creates a CircularArcShapeElement with the specified parameters.

Parameters
in_start_pointThe start of the arc.
in_middle_pointA point between the start and the end point, where the arc passes through
in_end_pointThe end of the arc.

Member Function Documentation

override HPS.Type HPS.CircularArcShapeElement.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.CircularArcShapeElement HPS.CircularArcShapeElement.SetEndPoint ( HPS.ShapePoint  in_end)
inline

Sets the end point for this CircularArcShapeElement.

Parameters
in_endThe end point of the arc.
HPS.CircularArcShapeElement HPS.CircularArcShapeElement.SetMiddlePoint ( HPS.ShapePoint  in_middle)
inline

Sets the minor axis point for this CircularArcShapeElement.

Parameters
in_middleA point between the start and the end point. The arc passes through this point.
HPS.CircularArcShapeElement HPS.CircularArcShapeElement.SetStartPoint ( HPS.ShapePoint  in_start)
inline

Sets the center point for this CircularArcShapeElement.

Parameters
in_startThe start of the arc.
bool HPS.CircularArcShapeElement.ShowEndPoint ( out HPS.ShapePoint  out_end)
inline

Shows the end point for this CircularArcShapeElement.

Parameters
out_endThe end point of the arc
Returns
    true if an end point was set, false otherwise.
bool HPS.CircularArcShapeElement.ShowMiddlePoint ( out HPS.ShapePoint  out_middle)
inline

Shows the middle point for this CircularArcShapeElement.

Parameters
out_middleA point between the start and the end point. The arc passes through this point.
Returns
    true if a middle point was set, false otherwise.
bool HPS.CircularArcShapeElement.ShowStartPoint ( out HPS.ShapePoint  out_start)
inline

Shows the center point for this CircularArcShapeElement.

Parameters
out_startThe start for the arc.
Returns
    true if a star point was set, false otherwise.

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