HPS.EllipseGlyphElement Class Reference

More...

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

Public Member Functions

override void Dispose ()
 
 EllipseGlyphElement ()
 The default constructor creates an empty EllipseGlyphElement object. More...
 
 EllipseGlyphElement (HPS.GlyphElement in_that)
 This constructor creates a EllipseGlyphElement 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 an ellipse glyph element. Otherwise the copy will fail and the resulting EllipseGlyphElement will be invalid. More...
 
 EllipseGlyphElement (HPS.EllipseGlyphElement in_that)
 The copy constructor creates a new EllipseGlyphElement object that contains the same settings as the source EllipseGlyphElement. More...
 
 EllipseGlyphElement (HPS.GlyphPoint in_lower_left, HPS.GlyphPoint in_upper_right)
 This constructor creates a EllipseGlyphElement with the lower left and upper right points for the bounding box which circumscribes the ellipse. More...
 
override HPS.Type ObjectType ()
 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). More...
 
void SetLowerLeft (HPS.GlyphPoint in_point)
 Sets the lower left point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement. More...
 
void SetPoints (HPS.GlyphPoint in_lower_left, HPS.GlyphPoint in_upper_right)
 Sets the lower left and upper right points for the bounding box which circumscribes the ellipse for this EllipseGlyphElement. More...
 
void SetUpperRight (HPS.GlyphPoint in_point)
 Sets the upper right point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement. More...
 
bool ShowLowerLeft (out HPS.GlyphPoint out_point)
 Shows the lower left point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement. More...
 
bool ShowUpperRight (out HPS.GlyphPoint out_point)
 Shows the upper right point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement. 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 (if the object is derived, this does not give the true type of the derived 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 the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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.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
 

Detailed Description

The EllipseGlyphElement class is a user space object. It is used to add ellipse elements to glyphs.

Constructor & Destructor Documentation

◆ EllipseGlyphElement() [1/4]

HPS.EllipseGlyphElement.EllipseGlyphElement ( )
inline

The default constructor creates an empty EllipseGlyphElement object.

◆ EllipseGlyphElement() [2/4]

HPS.EllipseGlyphElement.EllipseGlyphElement ( HPS.GlyphElement  in_that)
inline

This constructor creates a EllipseGlyphElement 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 an ellipse glyph element. Otherwise the copy will fail and the resulting EllipseGlyphElement will be invalid.

Parameters
in_thatThe source GlyphElement to copy.

◆ EllipseGlyphElement() [3/4]

HPS.EllipseGlyphElement.EllipseGlyphElement ( HPS.EllipseGlyphElement  in_that)
inline

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

Parameters
in_thatThe source EllipseGlyphElement to copy.

◆ EllipseGlyphElement() [4/4]

HPS.EllipseGlyphElement.EllipseGlyphElement ( HPS.GlyphPoint  in_lower_left,
HPS.GlyphPoint  in_upper_right 
)
inline

This constructor creates a EllipseGlyphElement with the lower left and upper right points for the bounding box which circumscribes the ellipse.

Parameters
in_lower_leftThe lower left point for the bounding box which circumscribes the ellipse.
in_upper_rightThe upper right point for the bounding box which circumscribes the ellipse.

Member Function Documentation

◆ ObjectType()

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

◆ SetLowerLeft()

void HPS.EllipseGlyphElement.SetLowerLeft ( HPS.GlyphPoint  in_point)
inline

Sets the lower left point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters
in_pointThe lower left point for the bounding box which circumscribes the ellipse.

◆ SetPoints()

void HPS.EllipseGlyphElement.SetPoints ( HPS.GlyphPoint  in_lower_left,
HPS.GlyphPoint  in_upper_right 
)
inline

Sets the lower left and upper right points for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters
in_lower_leftThe lower left point for the bounding box which circumscribes the ellipse.
in_upper_rightThe upper right point for the bounding box which circumscribes the ellipse.

◆ SetUpperRight()

void HPS.EllipseGlyphElement.SetUpperRight ( HPS.GlyphPoint  in_point)
inline

Sets the upper right point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters
in_pointThe upper right point for the bounding box which circumscribes the ellipse.

◆ ShowLowerLeft()

bool HPS.EllipseGlyphElement.ShowLowerLeft ( out HPS.GlyphPoint  out_point)
inline

Shows the lower left point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters
out_pointThe lower left point for the bounding box which circumscribes the ellipse.
Returns
true if a lower left point was set, false otherwise.

◆ ShowUpperRight()

bool HPS.EllipseGlyphElement.ShowUpperRight ( out HPS.GlyphPoint  out_point)
inline

Shows the upper right point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters
out_pointThe upper right point for the bounding box which circumscribes the ellipse.
Returns
true if an upper right point was set, false otherwise.

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