GridKit

class HPS.GridKit : public HPS.Kit 

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

Public Functions

void Consume (HPS.GridKit in_kit)

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

Param in_kit: The source GridKit to consume.

override void Dispose ()

override bool Empty ()

Indicates whether this GridKit has any values set on it.

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

bool Equals (HPS.GridKit in_kit)

Check if the source GridKit is equivalent to this GridKit.

Param in_kit: The source GridKit to compare to this GridKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

GridKit (): The default constructor creates an empty GridKit object.

GridKit (HPS.GridKit in_kit)

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

Param in_kit: The source GridKit to copy.

override HPS.Type ObjectType ()

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).

Return: The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.GridKit in_kit)

Copies the source GridKit into this GridKit.

Param in_kit: The source GridKit to copy.

HPS.GridKit SetFirstCount (int in_first_count)

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.

Param in_first_count: The count of the number of grid elements along the vector determined by the first reference point.
Return: A reference to this GridKit.

HPS.GridKit SetFirstPoint (HPS.Point in_first_point)

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.

Param in_first_point: The first reference point for this GridKit.
Return: A reference to this GridKit.

HPS.GridKit SetOrigin (HPS.Point in_origin)

Sets the origin for this GridKit.

Param in_origin: The origin for this GridKit.
Return: A reference to this GridKit.

HPS.GridKit SetPriority (int in_priority)

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.

See: SubwindowKit.SetPriority()
See: SubwindowKit.SetRenderingAlgorithm()

Param in_priority: The drawing priority, higher priority items are drawn on top of lower priority items.
Return: A reference to this object.

HPS.GridKit SetSecondCount (int in_second_count)

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.

Param in_second_count: The count of the number of grid elements along the vector determined by the second reference point.
Return: A reference to this GridKit.

HPS.GridKit SetSecondPoint (HPS.Point in_second_point)

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.

Param in_second_point: The second reference point for this GridKit.
Return: A reference to this GridKit.

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

Sets the type of this GridKit.

Param in_type: The type of this GridKit.
Return: A reference to this GridKit.

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

Sets user data on this kit.

Param in_index: The index of the user data to set.
Param in_data: The bytes of user data to set.
Return: A reference to this kit.

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

Sets user data on this kit.

Param in_index: The index of the user data to set.
Param in_bytes: The number of bytes of user data to set.
Param in_data: The bytes of user data to set.
Return: A reference to this kit.

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

Sets user data on this kit.

Param in_indices: An array of user data indices to set.
Param in_data: An array of bytes of user data to set.
Return: A reference to this kit.

void Show (out HPS.GridKit out_kit)

Copies this GridKit into the given GridKit.

Param out_kit: The GridKit to populate with the contents of this GridKit.

bool ShowFirstCount (out int out_first_count)

Shows the first reference count for this GridKit.

Param out_first_count: The first reference count for this GridKit.
Return: true if a first reference count was set, false otherwise.

bool ShowFirstPoint (out HPS.Point out_first_point)

Shows the first reference point for this GridKit.

Param out_first_point: The first reference point for this GridKit.
Return: true if a first reference point was set, false otherwise.

bool ShowOrigin (out HPS.Point out_origin)

Shows the origin for this GridKit.

Param out_origin: The origin for this GridKit.
Return: true if an origin was set, false otherwise.

bool ShowPriority (out int out_priority)

Shows the drawing priority.

Param out_priority: The drawing priority, higher priority items are drawn on top of lower priority items.
Return: true if the setting is valid, false otherwise.

bool ShowSecondCount (out int out_second_count)

Shows the second reference count for this GridKit.

Param out_second_count: The second reference count for this GridKit.
Return: true if a second reference count was set, false otherwise.

bool ShowSecondPoint (out HPS.Point out_second_point)

Shows the second reference point for this GridKit.

Param out_second_point: The second reference point for this GridKit.
Return: true if a second reference point was set, false otherwise.

bool ShowType (out HPS.Grid.Type out_type)

Shows the type for this GridKit.

Param out_type: The type for this GridKit.
Return: true if a type was set, false otherwise.

bool ShowUserData (IntPtr in_index, out byte[] out_data)

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

Param in_index: The index of the user data to show.
Param out_data: The user data at the given index.
Return: true if there is user data at the given index, false otherwise.

bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)

Shows all user data for this kit.

Param out_indices: An array of all user data indices set on this kit.
Param out_data: An array of all user data set on this kit.
Return: true if there is user data on this kit, false otherwise.

ulong ShowUserDataCount (): Get the number of user data indices set on this kit.

bool ShowUserDataIndices (out IntPtr[] out_indices)

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

Param out_indices: The user data indices set on this kit.
Return: The number of user data indices set on this kit.

HPS.GridKit UnsetAllUserData ()

Removes all user data from this kit.

Return: A reference to this kit.

HPS.GridKit UnsetEverything ()

Removes the all settings from this GridKit.

Return: A reference to this GridKit.

HPS.GridKit UnsetFirstCount ()

Removes the first reference count from this GridKit.

Return: A reference to this GridKit.

HPS.GridKit UnsetFirstPoint ()

Removes the first reference point from this GridKit.

Return: A reference to this GridKit.

HPS.GridKit UnsetOrigin ()

Removes the origin from this GridKit.

Return: A reference to this GridKit.

HPS.GridKit UnsetPriority ()

Removes a drawing priority setting.

Return: A reference to this GridKit.

HPS.GridKit UnsetSecondCount ()

Removes the second reference count from this GridKit.

Return: A reference to this GridKit.

HPS.GridKit UnsetSecondPoint ()

Removes the second reference point from this GridKit.

Return: A reference to this GridKit.

HPS.GridKit UnsetType ()

Removes the type from this GridKit.

Return: A reference to this GridKit.

HPS.GridKit UnsetUserData (IntPtr in_index)

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

Param in_index: The index of the user data to remove.
Return: A reference to this kit.

HPS.GridKit UnsetUserData (IntPtr[] in_indices)

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

Param in_indices: The indices of the user data to remove.
Return: A reference to this kit.

Public Static Functions

bool operator!= (HPS.GridKit a, HPS.GridKit b)

bool operator== (HPS.GridKit a, HPS.GridKit b)