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

Public Member Functions

override void Dispose ()
 
 InfiniteLineGlyphElement ()
 
 InfiniteLineGlyphElement (HPS.GlyphElement in_that)
 
 InfiniteLineGlyphElement (HPS.InfiniteLineGlyphElement in_that)
 
 InfiniteLineGlyphElement (HPS.GlyphPoint in_first, HPS.GlyphPoint in_second, HPS.InfiniteLine.Type in_type)
 
 InfiniteLineGlyphElement (HPS.GlyphPoint in_first, HPS.GlyphPoint in_second)
 
override HPS.Type ObjectType ()
 
void SetFirstPoint (HPS.GlyphPoint in_point)
 
void SetInfiniteType (HPS.InfiniteLine.Type in_type)
 
void SetPoints (HPS.GlyphPoint in_first, HPS.GlyphPoint in_second)
 
void SetSecondPoint (HPS.GlyphPoint in_point)
 
bool ShowFirstPoint (out HPS.GlyphPoint out_point)
 
bool ShowInfiniteType (out HPS.InfiniteLine.Type out_type)
 
bool ShowSecondPoint (out HPS.GlyphPoint out_point)
 
- Public Member Functions inherited from HPS.GlyphElement
override bool Equals (System.Object obj)
 
bool Equals (HPS.GlyphElement in_that)
 
override int GetHashCode ()
 
 GlyphElement ()
 
 GlyphElement (HPS.GlyphElement in_that)
 
void Set (HPS.GlyphElement in_that)
 
void SetExplicitColor (HPS.RGBAColor in_color)
 
void SetFill (HPS.Glyph.Fill in_fill)
 
void SetIndexedColor (byte in_index)
 
void SetNormalColor ()
 
bool ShowColor (out HPS.Glyph.ColorSource out_source, out byte out_index, out HPS.RGBAColor out_color)
 
bool ShowFill (out HPS.Glyph.Fill out_fill)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

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

◆ InfiniteLineGlyphElement() [1/5]

HPS.InfiniteLineGlyphElement.InfiniteLineGlyphElement ( )
inline

The default constructor creates an empty InfiniteLineGlyphElement object.

◆ InfiniteLineGlyphElement() [2/5]

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.

◆ InfiniteLineGlyphElement() [3/5]

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.

◆ InfiniteLineGlyphElement() [4/5]

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

◆ InfiniteLineGlyphElement() [5/5]

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

◆ ObjectType()

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

◆ SetFirstPoint()

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.

◆ SetInfiniteType()

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.

◆ SetPoints()

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.

◆ SetSecondPoint()

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.

◆ ShowFirstPoint()

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.

◆ ShowInfiniteType()

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.

◆ ShowSecondPoint()

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