Inheritance diagram for HPS.GridKey:
HPS.GeometryKey HPS.Key HPS.Object

Public Member Functions

void Consume (HPS.GridKit in_kit)
 
override void Dispose ()
 
 GridKey ()
 
 GridKey (HPS.Key in_that)
 
 GridKey (HPS.GridKey in_that)
 
override HPS.Type ObjectType ()
 
void Set (HPS.GridKit in_kit)
 
HPS.GridKey SetFirstCount (int in_first_count)
 
HPS.GridKey SetFirstPoint (HPS.Point in_first_point)
 
HPS.GridKey SetOrigin (HPS.Point in_origin)
 
HPS.GridKey SetSecondCount (int in_second_count)
 
HPS.GridKey SetSecondPoint (HPS.Point in_second_point)
 
HPS.GridKey SetType (HPS.Grid.Type in_type)
 
void Show (out HPS.GridKit out_kit)
 
bool ShowFirstCount (out int out_first_count)
 
bool ShowFirstPoint (out HPS.Point out_first_point)
 
bool ShowOrigin (out HPS.Point out_origin)
 
bool ShowSecondCount (out int out_second_count)
 
bool ShowSecondPoint (out HPS.Point out_second_point)
 
bool ShowType (out HPS.Grid.Type out_type)
 
- Public Member Functions inherited from HPS.GeometryKey
 GeometryKey ()
 
 GeometryKey (HPS.Key in_that)
 
 GeometryKey (HPS.GeometryKey in_that)
 
HPS.GeometryKey SetPriority (int in_priority)
 
HPS.GeometryKey SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.GeometryKey SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.GeometryKey SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
bool ShowBounding (out HPS.BoundingKit out_kit)
 
bool ShowPriority (out int out_priority)
 
ulong ShowReferrers (out HPS.SegmentKey[] out_segments)
 
ulong ShowReferrers (out HPS.ReferenceKey[] out_references)
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 
ulong ShowUserDataCount ()
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 
HPS.GeometryKey UnsetAllUserData ()
 
HPS.GeometryKey UnsetPriority ()
 
HPS.GeometryKey UnsetUserData (IntPtr in_index)
 
HPS.GeometryKey UnsetUserData (IntPtr[] in_indices)
 
- Public Member Functions inherited from HPS.Key
virtual void Assign (HPS.Key in_that)
 
HPS.Key CopyTo (HPS.SegmentKey in_destination)
 
void Delete ()
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Key in_that)
 
ulong GetHash ()
 
override int GetHashCode ()
 
bool HasOwner ()
 
 Key ()
 
 Key (HPS.Key in_that)
 
 Key (HPS.Control in_control)
 
void MoveTo (HPS.SegmentKey in_new_owner)
 
override HPS.Type ObjectType ()
 
HPS.SegmentKey Owner ()
 
HPS.SegmentKey Up ()
 
- 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.Key
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Key
static bool operator!= (HPS.Key a, HPS.Key b)
 
static bool operator== (HPS.Key a, HPS.Key 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 GridKey class is a smart pointer to a database object. It is a handle to a grid created by SegmentKey.InsertGrid.

Constructor & Destructor Documentation

◆ GridKey() [1/3]

HPS.GridKey.GridKey ( )
inline

The default constructor creates an uninitialized GridKey object. The Type() function will return Type.None.

◆ GridKey() [2/3]

HPS.GridKey.GridKey ( HPS.Key  in_that)
inline

This constructor creates an GridKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a grid key. Otherwise the copy will fail and the resulting GridKey will be invalid.

Parameters
in_thatThe source Key to copy.

◆ GridKey() [3/3]

HPS.GridKey.GridKey ( HPS.GridKey  in_that)
inline

The copy constructor creates a GridKey object that shares the underlying smart-pointer of the source GridKey.

Parameters
in_thatThe source GridKey to copy.

Member Function Documentation

◆ Consume()

void HPS.GridKey.Consume ( HPS.GridKit  in_kit)
inline

Completely replaces all settings on this GridKey with those set on the specified kit and resets the kit.

Parameters
in_kitThe kit from which to get the settings to replace on this GridKey.

◆ ObjectType()

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

◆ Set()

void HPS.GridKey.Set ( HPS.GridKit  in_kit)
inline

Replace those settings on this GridKey with those set on the specified kit.

Parameters
in_kitThe kit from which to get the settings to replace on this GridKey.

◆ SetFirstCount()

HPS.GridKey HPS.GridKey.SetFirstCount ( int  in_first_count)
inline

Sets the first reference count for this GridKey, i.e., the number of grid elements along the vector determined by the first reference point. If the type of the grid is Grid.Type.Quadrilateral, there are three type of behavior depending on if the count is greater than zero, less than zero, or equal to zero. If the count is greater than zero, the count determines the finite number of grid lines which will intersect with the vector determined by the first reference point. If the count is less than zero, the count determines the finite number of grid lines which will intersect with the vector determined by the first reference point and additionally that same number of intersections along the negation of that vector. Lastly, if the count is zero, the grid will extend infinitely along the vector determined by the first reference point and its negation. If the type of the grid is Grid.Type.Radial, there are two types of behavior depending on if the count is greater than zero or equal to zero. If the count is greater than zero, it determines the finite number of circular arcs which will intersect with the radial vectors. If the count is equal to zero, there will be an infinite number of intersections along the radial arcs. Negative counts are invalid in this case.

Parameters
in_first_countThe count of the number of grid elements along the vector determined by the first reference point.
Returns
A reference to this GridKey.

◆ SetFirstPoint()

HPS.GridKey HPS.GridKey.SetFirstPoint ( HPS.Point  in_first_point)
inline

Sets the first reference point for this GridKey. If the type of the grid is Grid.Type.Quadrilateral, this defines the first point along one of the vectors defining the grid (the other vector is determined by the second point). It also determines the spacing between the grid lines along the vector. If the type of the grid is Grid.Type.Radial, this defines the first point along the radius vector which will intersect with the circular grid arcs.

Parameters
in_first_pointThe first reference point for this GridKey.
Returns
A reference to this GridKey.

◆ SetOrigin()

HPS.GridKey HPS.GridKey.SetOrigin ( HPS.Point  in_origin)
inline

Sets the origin for this GridKey.

Parameters
in_originThe origin for this GridKey.
Returns
A reference to this GridKey.

◆ SetSecondCount()

HPS.GridKey HPS.GridKey.SetSecondCount ( int  in_second_count)
inline

Sets the second reference count for this GridKey, i.e., the number of grid elements along the vector determined by the second reference point. If the type of the grid is Grid.Type.Quadrilateral, there are three type of behavior depending on if the count is greater than zero, less than zero, or equal to zero. If the count is greater than zero, the count determines the finite number of grid lines which will intersect with the vector determined by the second reference point. If the count is less than zero, the count determines the finite number of grid lines which will intersect with the vector determined by the second reference point and additionally that same number of intersections along the negation of that vector. Lastly, if the count is zero, the grid will extend infinitely along the vector determined by the second reference point and its negation. If the type of the grid is Grid.Type.Radial, the count determines the number of radial vectors for the grid.

Parameters
in_second_countThe count of the number of grid elements along the vector determined by the second reference point.
Returns
A reference to this GridKey.

◆ SetSecondPoint()

HPS.GridKey HPS.GridKey.SetSecondPoint ( HPS.Point  in_second_point)
inline

Sets the second reference point for this GridKey. If the type of the grid Grid.Type.Quadrilateral, this defines the first point along the second vector defining the grid (the other vector is determined by the first point). It also determines the spacing between the grid lines along the vector. If the type of the grid is Grid.Type.Radial, this defines the first point on the first circular arc which intersects with the radial vectors, and determines the spacing of the arcs along the radial vectors.

Parameters
in_second_pointThe second reference point for this GridKey.
Returns
A reference to this GridKey.

◆ SetType()

HPS.GridKey HPS.GridKey.SetType ( HPS.Grid.Type  in_type)
inline

Sets the type of this GridKey.

Parameters
in_typeThe type of this GridKey.
Returns
A reference to this GridKey.

◆ Show()

void HPS.GridKey.Show ( out HPS.GridKit  out_kit)
inline

Copy the contents of this GridKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this GridKey.

◆ ShowFirstCount()

bool HPS.GridKey.ShowFirstCount ( out int  out_first_count)
inline

Shows the first reference count for this GridKey.

Parameters
out_first_countThe first reference count for this GridKey.
Returns
true if a first reference count was set, false otherwise.

◆ ShowFirstPoint()

bool HPS.GridKey.ShowFirstPoint ( out HPS.Point  out_first_point)
inline

Shows the first reference point for this GridKey.

Parameters
out_first_pointThe first reference point for this GridKey.
Returns
true if a first reference point was set, false otherwise.

◆ ShowOrigin()

bool HPS.GridKey.ShowOrigin ( out HPS.Point  out_origin)
inline

Shows the origin for this GridKey.

Parameters
out_originThe origin for this GridKey.
Returns
true if an origin was set, false otherwise.

◆ ShowSecondCount()

bool HPS.GridKey.ShowSecondCount ( out int  out_second_count)
inline

Shows the second reference count for this GridKey.

Parameters
out_second_countThe second reference count for this GridKey.
Returns
true if a second reference count was set, false otherwise.

◆ ShowSecondPoint()

bool HPS.GridKey.ShowSecondPoint ( out HPS.Point  out_second_point)
inline

Shows the second reference point for this GridKey.

Parameters
out_second_pointThe second reference point for this GridKey.
Returns
true if a second reference point was set, false otherwise.

◆ ShowType()

bool HPS.GridKey.ShowType ( out HPS.Grid.Type  out_type)
inline

Shows the type for this GridKey.

Parameters
out_typeThe type for this GridKey.
Returns
true if a type was set, false otherwise.

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