Inheritance diagram for HPS.GridKit:
HPS.Kit HPS.Object

Public Member Functions

void Consume (HPS.GridKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.GridKit in_kit)
 
override int GetHashCode ()
 
 GridKit ()
 
 GridKit (HPS.GridKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.GridKit in_kit)
 
HPS.GridKit SetFirstCount (int in_first_count)
 
HPS.GridKit SetFirstPoint (HPS.Point in_first_point)
 
HPS.GridKit SetOrigin (HPS.Point in_origin)
 
HPS.GridKit SetPriority (int in_priority)
 
HPS.GridKit SetSecondCount (int in_second_count)
 
HPS.GridKit SetSecondPoint (HPS.Point in_second_point)
 
HPS.GridKit SetType (HPS.Grid.Type in_type)
 
HPS.GridKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.GridKit SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.GridKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
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 ShowPriority (out int out_priority)
 
bool ShowSecondCount (out int out_second_count)
 
bool ShowSecondPoint (out HPS.Point out_second_point)
 
bool ShowType (out HPS.Grid.Type out_type)
 
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.GridKit UnsetAllUserData ()
 
HPS.GridKit UnsetEverything ()
 
HPS.GridKit UnsetFirstCount ()
 
HPS.GridKit UnsetFirstPoint ()
 
HPS.GridKit UnsetOrigin ()
 
HPS.GridKit UnsetPriority ()
 
HPS.GridKit UnsetSecondCount ()
 
HPS.GridKit UnsetSecondPoint ()
 
HPS.GridKit UnsetType ()
 
HPS.GridKit UnsetUserData (IntPtr in_index)
 
HPS.GridKit UnsetUserData (IntPtr[] in_indices)
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static bool operator!= (HPS.GridKit a, HPS.GridKit b)
 
static bool operator== (HPS.GridKit a, HPS.GridKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Kit
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The GridKit class is a user space object. It is a kit analog to a GridKey.

Constructor & Destructor Documentation

◆ GridKit() [1/2]

HPS.GridKit.GridKit ( )
inline

The default constructor creates an empty GridKit object.

◆ GridKit() [2/2]

HPS.GridKit.GridKit ( HPS.GridKit  in_kit)
inline

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

Parameters
in_kitThe source GridKit to copy.

Member Function Documentation

◆ Consume()

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

Copies the source GridKit into this GridKit and resets the source kit.

Parameters
in_kitThe source GridKit to consume.

◆ Empty()

override bool HPS.GridKit.Empty ( )
inlinevirtual

Indicates whether this GridKit has any values set on it.

Returns
true if no values are set on this GridKit, false otherwise.

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.GridKit.Equals ( HPS.GridKit  in_kit)
inline

Check if the source GridKit is equivalent to this GridKit.

Parameters
in_kitThe source GridKit to compare to this GridKit.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

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

◆ Set()

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

Copies the source GridKit into this GridKit.

Parameters
in_kitThe source GridKit to copy.

◆ SetFirstCount()

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

Sets the first reference count for this GridKit, 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 GridKit.

◆ SetFirstPoint()

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

Sets the first reference point for this GridKit. 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 GridKit.
Returns
A reference to this GridKit.

◆ SetOrigin()

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

Sets the origin for this GridKit.

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

◆ SetPriority()

HPS.GridKit HPS.GridKit.SetPriority ( int  in_priority)
inline

Assigns a specific drawing priority value to the GridKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority.

Parameters
in_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
A reference to this object.
See also
SubwindowKit.SetPriority()
SubwindowKit.SetRenderingAlgorithm()

◆ SetSecondCount()

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

Sets the second reference count for this GridKit, 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 GridKit.

◆ SetSecondPoint()

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

Sets the second reference point for this GridKit. 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 GridKit.
Returns
A reference to this GridKit.

◆ SetType()

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

Sets the type of this GridKit.

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

◆ SetUserData() [1/3]

HPS.GridKit HPS.GridKit.SetUserData ( IntPtr  in_index,
ulong  in_bytes,
byte []  in_data 
)
inline

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_bytesThe number of bytes of user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [2/3]

HPS.GridKit HPS.GridKit.SetUserData ( IntPtr  in_index,
byte []  in_data 
)
inline

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [3/3]

HPS.GridKit HPS.GridKit.SetUserData ( IntPtr []  in_indices,
byte  in_data[][] 
)
inline

Sets user data on this kit.

Parameters
in_indicesAn array of user data indices to set.
in_dataAn array of bytes of user data to set.
Returns
A reference to this kit.

◆ Show()

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

Copies this GridKit into the given GridKit.

Parameters
out_kitThe GridKit to populate with the contents of this GridKit.

◆ ShowFirstCount()

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

Shows the first reference count for this GridKit.

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

◆ ShowFirstPoint()

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

Shows the first reference point for this GridKit.

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

◆ ShowOrigin()

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

Shows the origin for this GridKit.

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

◆ ShowPriority()

bool HPS.GridKit.ShowPriority ( out int  out_priority)
inline

Shows the drawing priority.

Parameters
out_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
true if the setting is valid, false otherwise.

◆ ShowSecondCount()

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

Shows the second reference count for this GridKit.

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

◆ ShowSecondPoint()

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

Shows the second reference point for this GridKit.

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

◆ ShowType()

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

Shows the type for this GridKit.

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

◆ ShowUserData() [1/2]

bool HPS.GridKit.ShowUserData ( IntPtr  in_index,
out byte []  out_data 
)
inline

Shows the user data at a given index for this kit.

Parameters
in_indexThe index of the user data to show.
out_dataThe user data at the given index.
Returns
true if there is user data at the given index, false otherwise.

◆ ShowUserData() [2/2]

bool HPS.GridKit.ShowUserData ( out IntPtr []  out_indices,
out byte  out_data[][] 
)
inline

Shows all user data for this kit.

Parameters
out_indicesAn array of all user data indices set on this kit.
out_dataAn array of all user data set on this kit.
Returns
true if there is user data on this kit, false otherwise.

◆ ShowUserDataCount()

ulong HPS.GridKit.ShowUserDataCount ( )
inline

Get the number of user data indices set on this kit.

◆ ShowUserDataIndices()

bool HPS.GridKit.ShowUserDataIndices ( out IntPtr []  out_indices)
inline

Shows the indices of all user data set on this kit.

Parameters
out_indicesThe user data indices set on this kit.
Returns
The number of user data indices set on this kit.

◆ UnsetAllUserData()

HPS.GridKit HPS.GridKit.UnsetAllUserData ( )
inline

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetEverything()

HPS.GridKit HPS.GridKit.UnsetEverything ( )
inline

Removes the all settings from this GridKit.

Returns
A reference to this GridKit.

◆ UnsetFirstCount()

HPS.GridKit HPS.GridKit.UnsetFirstCount ( )
inline

Removes the first reference count from this GridKit.

Returns
A reference to this GridKit.

◆ UnsetFirstPoint()

HPS.GridKit HPS.GridKit.UnsetFirstPoint ( )
inline

Removes the first reference point from this GridKit.

Returns
A reference to this GridKit.

◆ UnsetOrigin()

HPS.GridKit HPS.GridKit.UnsetOrigin ( )
inline

Removes the origin from this GridKit.

Returns
A reference to this GridKit.

◆ UnsetPriority()

HPS.GridKit HPS.GridKit.UnsetPriority ( )
inline

Removes a drawing priority setting.

Returns
A reference to this GridKit.

◆ UnsetSecondCount()

HPS.GridKit HPS.GridKit.UnsetSecondCount ( )
inline

Removes the second reference count from this GridKit.

Returns
A reference to this GridKit.

◆ UnsetSecondPoint()

HPS.GridKit HPS.GridKit.UnsetSecondPoint ( )
inline

Removes the second reference point from this GridKit.

Returns
A reference to this GridKit.

◆ UnsetType()

HPS.GridKit HPS.GridKit.UnsetType ( )
inline

Removes the type from this GridKit.

Returns
A reference to this GridKit.

◆ UnsetUserData() [1/2]

HPS.GridKit HPS.GridKit.UnsetUserData ( IntPtr  in_index)
inline

Removes the user data at the given index from this kit.

Parameters
in_indexThe index of the user data to remove.
Returns
A reference to this kit.

◆ UnsetUserData() [2/2]

HPS.GridKit HPS.GridKit.UnsetUserData ( IntPtr []  in_indices)
inline

Removes the user data at the given indices from this kit.

Parameters
in_indicesThe indices of the user data to remove.
Returns
A reference to this kit.

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