API Search || Global Search
HPS.CircleShapeElement Class Reference

More...

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

Public Member Functions

 CircleShapeElement ()
 The default constructor creates an empty CircleShapeElement object. More...
 
 CircleShapeElement (HPS.ShapeElement in_that)
 This constructor creates a CircleShapeElement 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 circle shape element. Otherwise the copy will fail and the resulting CircleShapeElement will be invalid. More...
 
 CircleShapeElement (HPS.CircleShapeElement in_that)
 The copy constructor creates a new CircleShapeElement object that contains the same settings as the source CircleShapeElement. More...
 
 CircleShapeElement (HPS.ShapePoint in_center, HPS.ShapePoint in_radius)
 This constructor creates a CircleShapeElement with the specified center and radius points. More...
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.CircleShapeElement SetCenter (HPS.ShapePoint in_center)
 Sets the center point for this CircleShapeElement. More...
 
HPS.CircleShapeElement SetRadius (HPS.ShapePoint in_radius)
 Sets the radius point for this CircleShapeElement. More...
 
bool ShowCenter (out HPS.ShapePoint out_center)
 Shows the center point for this CircleShapeElement. More...
 
bool ShowRadius (out HPS.ShapePoint out_radius)
 Shows the radius point for this CircleShapeElement. 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 ()
 
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 CircleShapeElement class is a user space object. It is used to define circle elements to make up shapes for text backgrounds.

Constructor & Destructor Documentation

HPS.CircleShapeElement.CircleShapeElement ( )
inline

The default constructor creates an empty CircleShapeElement object.

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

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

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

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

Parameters
in_thatThe source CircleShapeElement to copy.
HPS.CircleShapeElement.CircleShapeElement ( HPS.ShapePoint  in_center,
HPS.ShapePoint  in_radius 
)
inline

This constructor creates a CircleShapeElement with the specified center and radius points.

Parameters
in_centerThe center point of the circle.
in_radiusThe radius of the circle.

Member Function Documentation

HPS.CircleShapeElement HPS.CircleShapeElement.SetCenter ( HPS.ShapePoint  in_center)
inline

Sets the center point for this CircleShapeElement.

Parameters
in_centerThe center point of the circle.
HPS.CircleShapeElement HPS.CircleShapeElement.SetRadius ( HPS.ShapePoint  in_radius)
inline

Sets the radius point for this CircleShapeElement.

Parameters
in_radiusThe radius point of the circle.
bool HPS.CircleShapeElement.ShowCenter ( out HPS.ShapePoint  out_center)
inline

Shows the center point for this CircleShapeElement.

Parameters
out_centerThe center point for the circle.
Returns
true if a center point was set, false otherwise.
bool HPS.CircleShapeElement.ShowRadius ( out HPS.ShapePoint  out_radius)
inline

Shows the radius point for this CircleShapeElement.

Parameters
out_radiusThe radius point for the circle.
Returns
true if a radius was set, false otherwise.

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