HPS.CircularArcGlyphElement Class Reference

The CircularArcGlyphElement class is a user space object. It is used to add circular arc elements to a glyph. More...

Inheritance diagram for HPS.CircularArcGlyphElement:
HPS.GlyphElement HPS.Object

Public Member Functions

 CircularArcGlyphElement ()
 The default constructor creates an empty CircularArcGlyphElement object. More...
 
 CircularArcGlyphElement (HPS.GlyphElement in_that)
 This constructor creates a CircularArcGlyphElement object that contains the same settings as the source GlyphElement. The copy will only be successful if the source glyph element is really an upcast of a circular arc glyph element. Otherwise the copy will fail and the resulting CircularArcGlyphElement will be invalid. More...
 
 CircularArcGlyphElement (HPS.CircularArcGlyphElement in_that)
 The copy constructor creates a new CircularArcGlyphElement object that contains the same settings as the source CircularArcGlyphElement. More...
 
 CircularArcGlyphElement (HPS.GlyphPoint in_start, HPS.GlyphPoint in_intermediate, HPS.GlyphPoint in_end)
 This constructor creates a CircularArcGlyphElement with the specified start, intermediate, and end points. 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...
 
void SetEndPoint (HPS.GlyphPoint in_point)
 Sets the end point for the circular arc for this CircularArcGlyphElement. More...
 
void SetIntermediatePoint (HPS.GlyphPoint in_point)
 Sets the intermediate point for the circular arc for this CircularArcGlyphElement. More...
 
void SetPoints (HPS.GlyphPoint in_start, HPS.GlyphPoint in_intermediate, HPS.GlyphPoint in_end)
 Sets the start, intermediate, and end points for the circular arc for this CircularArcGlyphElement. More...
 
void SetStartPoint (HPS.GlyphPoint in_point)
 Sets the start point for the circular arc for this CircularArcGlyphElement. More...
 
bool ShowEndPoint (out HPS.GlyphPoint out_point)
 Shows the end point for the circular arc for this CircularArcGlyphElement. More...
 
bool ShowIntermediatePoint (out HPS.GlyphPoint out_point)
 Shows the intermediate point for the circular arc for this CircularArcGlyphElement. More...
 
bool ShowStartPoint (out HPS.GlyphPoint out_point)
 Shows the start point for the circular arc for this CircularArcGlyphElement. More...
 
- Public Member Functions inherited from HPS.GlyphElement
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.GlyphElement in_that)
 Check if the source GlyphElement is equivalent to this GlyphElement. More...
 
override int GetHashCode ()
 
 GlyphElement ()
 The default constructor creates an empty GlyphElement object. More...
 
 GlyphElement (HPS.GlyphElement in_that)
 The copy constructor creates a new GlyphElement object that contains the same settings as the source GlyphElement. 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...
 
void Set (HPS.GlyphElement in_that)
 Copies the source GlyphElement into this GlyphElement. More...
 
void SetExplicitColor (HPS.RGBAColor in_color)
 Sets the RGBA color for this GlyphElement. More...
 
void SetFill (HPS.Glyph.Fill in_fill)
 Sets the fill mode for this GlyphElement. More...
 
void SetIndexedColor (byte in_index)
 Sets the color index for this GlyphElement. More...
 
void SetNormalColor ()
 Sets that this GlyphElement should inherit the color of the owning geometry which uses the glyph. More...
 
bool ShowColor (out HPS.Glyph.ColorSource out_source, out byte out_index, out HPS.RGBAColor out_color)
 Shows the color for this GlyphElement. More...
 
bool ShowFill (out HPS.Glyph.Fill out_fill)
 Shows the fill mode for this GlyphElement. 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...
 
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.GlyphElement
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.GlyphElement
static bool operator!= (HPS.GlyphElement a, HPS.GlyphElement b)
 
static bool operator== (HPS.GlyphElement a, HPS.GlyphElement b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The CircularArcGlyphElement class is a user space object. It is used to add circular arc elements to a glyph.

Constructor & Destructor Documentation

HPS.CircularArcGlyphElement.CircularArcGlyphElement ( )
inline

The default constructor creates an empty CircularArcGlyphElement object.

HPS.CircularArcGlyphElement.CircularArcGlyphElement ( HPS.GlyphElement  in_that)
inline

This constructor creates a CircularArcGlyphElement object that contains the same settings as the source GlyphElement. The copy will only be successful if the source glyph element is really an upcast of a circular arc glyph element. Otherwise the copy will fail and the resulting CircularArcGlyphElement will be invalid.

Parameters
in_thatThe source GlyphElement to copy.
HPS.CircularArcGlyphElement.CircularArcGlyphElement ( HPS.CircularArcGlyphElement  in_that)
inline

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

Parameters
in_thatThe source CircularArcGlyphElement to copy.
HPS.CircularArcGlyphElement.CircularArcGlyphElement ( HPS.GlyphPoint  in_start,
HPS.GlyphPoint  in_intermediate,
HPS.GlyphPoint  in_end 
)
inline

This constructor creates a CircularArcGlyphElement with the specified start, intermediate, and end points.

Parameters
in_startThe start point for the circular arc.
in_intermediateThe intermediate point for the circular arc.
in_endThe end point for the circular arc.

Member Function Documentation

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

void HPS.CircularArcGlyphElement.SetEndPoint ( HPS.GlyphPoint  in_point)
inline

Sets the end point for the circular arc for this CircularArcGlyphElement.

Parameters
in_pointThe end point for the circular arc.
void HPS.CircularArcGlyphElement.SetIntermediatePoint ( HPS.GlyphPoint  in_point)
inline

Sets the intermediate point for the circular arc for this CircularArcGlyphElement.

Parameters
in_pointThe intermediate point for the circular arc.
void HPS.CircularArcGlyphElement.SetPoints ( HPS.GlyphPoint  in_start,
HPS.GlyphPoint  in_intermediate,
HPS.GlyphPoint  in_end 
)
inline

Sets the start, intermediate, and end points for the circular arc for this CircularArcGlyphElement.

void HPS.CircularArcGlyphElement.SetStartPoint ( HPS.GlyphPoint  in_point)
inline

Sets the start point for the circular arc for this CircularArcGlyphElement.

Parameters
in_pointThe start point for the circular arc.
bool HPS.CircularArcGlyphElement.ShowEndPoint ( out HPS.GlyphPoint  out_point)
inline

Shows the end point for the circular arc for this CircularArcGlyphElement.

Parameters
out_pointThe end point for the circular arc.
Returns
true if an end point was set, false otherwise.
bool HPS.CircularArcGlyphElement.ShowIntermediatePoint ( out HPS.GlyphPoint  out_point)
inline

Shows the intermediate point for the circular arc for this CircularArcGlyphElement.

Parameters
out_pointThe intermediate point for the circular arc.
Returns
true if an intermediate point was set, false otherwise.
bool HPS.CircularArcGlyphElement.ShowStartPoint ( out HPS.GlyphPoint  out_point)
inline

Shows the start point for the circular arc for this CircularArcGlyphElement.

Parameters
out_pointThe start point for the circular arc.
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.CircularArcGlyphElement.cs