HPS.InfiniteLineGlyphElement Class Reference

The InfiniteLineGlyphElement class is a user space object. It is used to add infinite line and ray elements to a glyph. More...

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

Public Member Functions

override void Dispose ()
 
 InfiniteLineGlyphElement ()
 The default constructor creates an empty InfiniteLineGlyphElement object. More...
 
 InfiniteLineGlyphElement (HPS.GlyphElement in_that)
 This constructor creates a InfiniteLineGlyphElement 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 infinite line glyph element. Otherwise the copy will fail and the resulting InfiniteLineGlyphElement will be invalid. More...
 
 InfiniteLineGlyphElement (HPS.InfiniteLineGlyphElement in_that)
 The copy constructor creates a new InfiniteLineGlyphElement object that contains the same settings as the source InfiniteLineGlyphElement. More...
 
 InfiniteLineGlyphElement (HPS.GlyphPoint in_first, HPS.GlyphPoint in_second, HPS.InfiniteLine.Type in_type)
 This constructor creates a InfiniteLineGlyphElement with the specified vector and type. More...
 
 InfiniteLineGlyphElement (HPS.GlyphPoint in_first, HPS.GlyphPoint in_second)
 This constructor creates a InfiniteLineGlyphElement with the specified vector and type. 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 SetFirstPoint (HPS.GlyphPoint in_point)
 Sets the first point for the vector defining the infinite line or ray for this InfiniteLineGlyphElement. More...
 
void SetInfiniteType (HPS.InfiniteLine.Type in_type)
 Sets the type of this InfiniteLineGlyphElement, i.e., whether it represents an infinite line or ray. More...
 
void SetPoints (HPS.GlyphPoint in_first, HPS.GlyphPoint in_second)
 Sets the points for the vector defining the infinite line or ray for this InfiniteLineGlyphElement. More...
 
void SetSecondPoint (HPS.GlyphPoint in_point)
 Sets the second point for the vector defining the infinite line or ray for this InfiniteLineGlyphElement. More...
 
bool ShowFirstPoint (out HPS.GlyphPoint out_point)
 Shows the first point for the vector defining the infinite line or ray for this InfiniteLineGlyphElement. More...
 
bool ShowInfiniteType (out HPS.InfiniteLine.Type out_type)
 Shows the type of this InfiniteLineGlyphElement. More...
 
bool ShowSecondPoint (out HPS.GlyphPoint out_point)
 Shows the second point for the vector defining the infinite line or ray for this InfiniteLineGlyphElement. More...
 
- Public Member Functions inherited from HPS.GlyphElement
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...
 
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...
 
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.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 InfiniteLineGlyphElement class is a user space object. It is used to add infinite line and ray elements to a glyph.

Constructor & Destructor Documentation

HPS.InfiniteLineGlyphElement.InfiniteLineGlyphElement ( )
inline

The default constructor creates an empty InfiniteLineGlyphElement object.

HPS.InfiniteLineGlyphElement.InfiniteLineGlyphElement ( HPS.GlyphElement  in_that)
inline

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

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

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

Parameters
in_thatThe source InfiniteLineGlyphElement to copy.
HPS.InfiniteLineGlyphElement.InfiniteLineGlyphElement ( HPS.GlyphPoint  in_first,
HPS.GlyphPoint  in_second,
HPS.InfiniteLine.Type  in_type 
)
inline

This constructor creates a InfiniteLineGlyphElement with the specified vector and type.

Parameters
in_firstThe first point along the InfiniteLineGlyphElement
in_secondThe second point along the InfiniteLineGlyphElement
in_typeThe type of infinite line - either Ray or Line
HPS.InfiniteLineGlyphElement.InfiniteLineGlyphElement ( HPS.GlyphPoint  in_first,
HPS.GlyphPoint  in_second 
)
inline

This constructor creates a InfiniteLineGlyphElement with the specified vector and type.

Parameters
in_firstThe first point along the InfiniteLineGlyphElement
in_secondThe second point along the InfiniteLineGlyphElement

Member Function Documentation

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

void HPS.InfiniteLineGlyphElement.SetFirstPoint ( HPS.GlyphPoint  in_point)
inline

Sets the first point for the vector defining the infinite line or ray for this InfiniteLineGlyphElement.

Parameters
in_pointThe first point for the vector defining the infinite line or ray.
void HPS.InfiniteLineGlyphElement.SetInfiniteType ( HPS.InfiniteLine.Type  in_type)
inline

Sets the type of this InfiniteLineGlyphElement, i.e., whether it represents an infinite line or ray.

Parameters
in_typeThe type of this InfiniteLineGlyphElement.
void HPS.InfiniteLineGlyphElement.SetPoints ( HPS.GlyphPoint  in_first,
HPS.GlyphPoint  in_second 
)
inline

Sets the points for the vector defining the infinite line or ray for this InfiniteLineGlyphElement.

Parameters
in_firstThe first point for the vector defining the infinite line or ray.
in_secondThe second point for the vector defining the infinite line or ray.
void HPS.InfiniteLineGlyphElement.SetSecondPoint ( HPS.GlyphPoint  in_point)
inline

Sets the second point for the vector defining the infinite line or ray for this InfiniteLineGlyphElement.

Parameters
in_pointThe second point for the vector defining the infinite line or ray.
bool HPS.InfiniteLineGlyphElement.ShowFirstPoint ( out HPS.GlyphPoint  out_point)
inline

Shows the first point for the vector defining the infinite line or ray for this InfiniteLineGlyphElement.

Parameters
out_pointThe first point for the vector defining the infinite line or ray.
Returns
true if a first point was set, false otherwise.
bool HPS.InfiniteLineGlyphElement.ShowInfiniteType ( out HPS.InfiniteLine.Type  out_type)
inline

Shows the type of this InfiniteLineGlyphElement.

Parameters
out_typeThe type of this InfiniteLineGlyphElement.
Returns
true if a type was set, false otherwise.
bool HPS.InfiniteLineGlyphElement.ShowSecondPoint ( out HPS.GlyphPoint  out_point)
inline

Shows the second point for the vector defining the infinite line or ray for this InfiniteLineGlyphElement.

Parameters
out_pointThe second point for the vector defining the infinite line or ray.
Returns
true if a second point was set, false otherwise.

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