< Home

< Table of Contents

REFERENCE MANUAL

HPS.DotGlyphElement Class Reference

The DotGlyphElement class is a user space object. More...

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

Public Member Functions

override void Dispose ()
 
 DotGlyphElement ()
 The default constructor creates an empty DotGlyphElement object. More...
 
 DotGlyphElement (HPS.GlyphElement in_that)
 This constructor creates a DotGlyphElement object that contains the same settings as the source GlyphElement. More...
 
 DotGlyphElement (HPS.DotGlyphElement in_that)
 This constructor creates a DotGlyphElement object that contains the same settings as the source GlyphElement. More...
 
 DotGlyphElement (HPS.GlyphPoint in_point)
 This constructor creates a DotGlyphElement with the specified point. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void SetPoint (HPS.GlyphPoint in_point)
 Sets the point for this DotGlyphElement. More...
 
bool ShowPoint (out HPS.GlyphPoint out_point)
 Shows the point for this DotGlyphElement. 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. 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. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
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. 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 DotGlyphElement class is a user space object.

It is used to dot elements to glyphs.

Constructor & Destructor Documentation

HPS.DotGlyphElement.DotGlyphElement ( )

The default constructor creates an empty DotGlyphElement object.

HPS.DotGlyphElement.DotGlyphElement ( HPS.GlyphElement  in_that)

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

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_glyph_element" kindref="compound">GlyphElement</ref> to copy.
HPS.DotGlyphElement.DotGlyphElement ( HPS.DotGlyphElement  in_that)

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

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_glyph_element" kindref="compound">GlyphElement</ref> to copy.
HPS.DotGlyphElement.DotGlyphElement ( HPS.GlyphPoint  in_point)

This constructor creates a DotGlyphElement with the specified point.

Parameters
in_pointThe point for the dot.

Member Function Documentation

override HPS.Type HPS.DotGlyphElement.ObjectType ( )
virtual

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.DotGlyphElement.SetPoint ( HPS.GlyphPoint  in_point)

Sets the point for this DotGlyphElement.

Parameters
in_pointThe point for the dot.
bool HPS.DotGlyphElement.ShowPoint ( out HPS.GlyphPoint  out_point)

Shows the point for this DotGlyphElement.

Parameters
out_pointThe point for the dot.
Returns
true if a point was set, false otherwise.

The documentation for this class was generated from the following file: