HPS.EllipticalArcShapeElement Class Reference

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

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

Public Member Functions

override void Dispose ()
 
 EllipticalArcShapeElement ()
 The default constructor creates an empty EllipticalArcShapeElement object. More...
 
 EllipticalArcShapeElement (HPS.ShapeElement in_that)
 This constructor creates a EllipticalArcShapeElement 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 an elliptical arc shape element. Otherwise the copy will fail and the resulting EllipticalArcShapeElement will be invalid. More...
 
 EllipticalArcShapeElement (HPS.EllipticalArcShapeElement in_that)
 The copy constructor creates a new EllipticalArcShapeElement object that contains the same settings as the source EllipticalArcShapeElement. More...
 
 EllipticalArcShapeElement (HPS.ShapePoint in_center, HPS.ShapePoint in_major_axis_point, HPS.ShapePoint in_minor_axis_point, float in_start, float in_end)
 This constructor creates a EllipticalArcShapeElement with the specified parameters. More...
 
 EllipticalArcShapeElement (HPS.ShapePoint in_center, HPS.ShapePoint in_major_axis_point, HPS.ShapePoint in_minor_axis_point, float in_start)
 This constructor creates a EllipticalArcShapeElement with the specified parameters. More...
 
 EllipticalArcShapeElement (HPS.ShapePoint in_center, HPS.ShapePoint in_major_axis_point, HPS.ShapePoint in_minor_axis_point)
 This constructor creates a EllipticalArcShapeElement with the specified parameters. More...
 
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.EllipticalArcShapeElement SetCenter (HPS.ShapePoint in_center)
 Sets the center point for this EllipticalArcShapeElement. More...
 
HPS.EllipticalArcShapeElement SetEnd (float in_end)
 Sets the end for this EllipticalArcShapeElement. More...
 
HPS.EllipticalArcShapeElement SetMajorAxisPoint (HPS.ShapePoint in_major_axis_point)
 Sets the major axis point for this EllipticalArcShapeElement. More...
 
HPS.EllipticalArcShapeElement SetMinorAxisPoint (HPS.ShapePoint in_minor_axis_point)
 Sets the minor axis point for this EllipticalArcShapeElement. More...
 
HPS.EllipticalArcShapeElement SetStart (float in_start)
 Sets the start for this EllipticalArcShapeElement. More...
 
bool ShowCenter (out HPS.ShapePoint out_center)
 Shows the center point for this EllipticalArcShapeElement. More...
 
bool ShowEnd (out float out_end)
 Shows the end point for this EllipticalArcShapeElement. More...
 
bool ShowMajorAxisPoint (out HPS.ShapePoint out_major_axis_point)
 Shows the major axis point for this EllipticalArcShapeElement. More...
 
bool ShowMinorAxisPoint (out HPS.ShapePoint out_minor_axis_point)
 Shows the minor axis point for this EllipticalArcShapeElement. More...
 
bool ShowStart (out float out_start)
 Shows the start point for this EllipticalArcShapeElement. 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 EllipticalArcShapeElement class is a user space object. It is used to define elliptical arc elements to make up shapes for text backgrounds.

Constructor & Destructor Documentation

HPS.EllipticalArcShapeElement.EllipticalArcShapeElement ( )
inline

The default constructor creates an empty EllipticalArcShapeElement object.

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

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

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

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

Parameters
in_thatThe source EllipticalArcShapeElement to copy.
HPS.EllipticalArcShapeElement.EllipticalArcShapeElement ( HPS.ShapePoint  in_center,
HPS.ShapePoint  in_major_axis_point,
HPS.ShapePoint  in_minor_axis_point,
float  in_start,
float  in_end 
)
inline

This constructor creates a EllipticalArcShapeElement with the specified parameters.

Parameters
in_centerThe center point of the arc.
in_major_axis_pointA point defining the major axis of the arc.
in_minor_axis_pointA point defining the minor axis of the arc.
in_startThe start of the arc, in degrees.
in_endThe end of the arc, in degrees.
HPS.EllipticalArcShapeElement.EllipticalArcShapeElement ( HPS.ShapePoint  in_center,
HPS.ShapePoint  in_major_axis_point,
HPS.ShapePoint  in_minor_axis_point,
float  in_start 
)
inline

This constructor creates a EllipticalArcShapeElement with the specified parameters.

Parameters
in_centerThe center point of the arc.
in_major_axis_pointA point defining the major axis of the arc.
in_minor_axis_pointA point defining the minor axis of the arc.
in_startThe start of the arc, in degrees.
HPS.EllipticalArcShapeElement.EllipticalArcShapeElement ( HPS.ShapePoint  in_center,
HPS.ShapePoint  in_major_axis_point,
HPS.ShapePoint  in_minor_axis_point 
)
inline

This constructor creates a EllipticalArcShapeElement with the specified parameters.

Parameters
in_centerThe center point of the arc.
in_major_axis_pointA point defining the major axis of the arc.
in_minor_axis_pointA point defining the minor axis of the arc.

Member Function Documentation

override HPS.Type HPS.EllipticalArcShapeElement.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.EllipticalArcShapeElement HPS.EllipticalArcShapeElement.SetCenter ( HPS.ShapePoint  in_center)
inline

Sets the center point for this EllipticalArcShapeElement.

Parameters
in_centerThe center point of the arc.
HPS.EllipticalArcShapeElement HPS.EllipticalArcShapeElement.SetEnd ( float  in_end)
inline

Sets the end for this EllipticalArcShapeElement.

Parameters
in_endThe ending point of this arc, expressed in degrees
HPS.EllipticalArcShapeElement HPS.EllipticalArcShapeElement.SetMajorAxisPoint ( HPS.ShapePoint  in_major_axis_point)
inline

Sets the major axis point for this EllipticalArcShapeElement.

Parameters
in_major_axis_pointA point defining the major axis of the arc.
HPS.EllipticalArcShapeElement HPS.EllipticalArcShapeElement.SetMinorAxisPoint ( HPS.ShapePoint  in_minor_axis_point)
inline

Sets the minor axis point for this EllipticalArcShapeElement.

Parameters
in_minor_axis_pointA point defining the minor axis of the arc.
HPS.EllipticalArcShapeElement HPS.EllipticalArcShapeElement.SetStart ( float  in_start)
inline

Sets the start for this EllipticalArcShapeElement.

Parameters
in_startThe starting point of this arc, expressed in degrees
bool HPS.EllipticalArcShapeElement.ShowCenter ( out HPS.ShapePoint  out_center)
inline

Shows the center point for this EllipticalArcShapeElement.

Parameters
out_centerThe center point for the arc.
Returns
true if a center point was set, false otherwise.
bool HPS.EllipticalArcShapeElement.ShowEnd ( out float  out_end)
inline

Shows the end point for this EllipticalArcShapeElement.

Parameters
out_endThe ending point of this arc, expressed in degrees
Returns
true if an end point was set, false otherwise.
bool HPS.EllipticalArcShapeElement.ShowMajorAxisPoint ( out HPS.ShapePoint  out_major_axis_point)
inline

Shows the major axis point for this EllipticalArcShapeElement.

Parameters
out_major_axis_pointA point defining the major axis of the arc.
Returns
true if a major axis point was set, false otherwise.
bool HPS.EllipticalArcShapeElement.ShowMinorAxisPoint ( out HPS.ShapePoint  out_minor_axis_point)
inline

Shows the minor axis point for this EllipticalArcShapeElement.

Parameters
out_minor_axis_pointA point defining the minor axis of the arc.
Returns
true if a minor axis point was set, false otherwise.
bool HPS.EllipticalArcShapeElement.ShowStart ( out float  out_start)
inline

Shows the start point for this EllipticalArcShapeElement.

Parameters
out_startThe starting point of this arc, expressed in degrees
Returns
true if a start point was set, false otherwise.

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