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

Public Member Functions | |
void | Consume (HPS.GridKit in_kit) |
Copies the source GridKit into this GridKit and resets the source kit. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this GridKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.GridKit in_kit) |
Check if the source GridKit is equivalent to this GridKit. More... | |
override int | GetHashCode () |
GridKit () | |
The default constructor creates an empty GridKit object. More... | |
GridKit (HPS.GridKit in_kit) | |
The copy constructor creates a new GridKit object that contains the same settings as the source GridKit. 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 | Set (HPS.GridKit in_kit) |
Copies the source GridKit into this GridKit. More... | |
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. More... | |
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. More... | |
HPS.GridKit | SetOrigin (HPS.Point in_origin) |
Sets the origin for this GridKit. More... | |
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. More... | |
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. More... | |
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. More... | |
HPS.GridKit | SetType (HPS.Grid.Type in_type) |
Sets the type of this GridKit. More... | |
HPS.GridKit | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.GridKit | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.GridKit | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this kit. More... | |
void | Show (out HPS.GridKit out_kit) |
Copies this GridKit into the given GridKit. More... | |
bool | ShowFirstCount (out int out_first_count) |
Shows the first reference count for this GridKit. More... | |
bool | ShowFirstPoint (out HPS.Point out_first_point) |
Shows the first reference point for this GridKit. More... | |
bool | ShowOrigin (out HPS.Point out_origin) |
Shows the origin for this GridKit. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
bool | ShowSecondCount (out int out_second_count) |
Shows the second reference count for this GridKit. More... | |
bool | ShowSecondPoint (out HPS.Point out_second_point) |
Shows the second reference point for this GridKit. More... | |
bool | ShowType (out HPS.Grid.Type out_type) |
Shows the type for this GridKit. More... | |
bool | ShowUserData (IntPtr in_index, out byte[] out_data) |
Shows the user data at a given index for this kit. More... | |
bool | ShowUserData (out IntPtr[] out_indices, out byte[][] out_data) |
Shows all user data for this kit. More... | |
ulong | ShowUserDataCount () |
Get the number of user data indices set on this kit. More... | |
bool | ShowUserDataIndices (out IntPtr[] out_indices) |
Shows the indices of all user data set on this kit. More... | |
HPS.GridKit | UnsetAllUserData () |
Removes all user data from this kit. More... | |
HPS.GridKit | UnsetEverything () |
Removes the all settings from this GridKit. More... | |
HPS.GridKit | UnsetFirstCount () |
Removes the first reference count from this GridKit. More... | |
HPS.GridKit | UnsetFirstPoint () |
Removes the first reference point from this GridKit. More... | |
HPS.GridKit | UnsetOrigin () |
Removes the origin from this GridKit. More... | |
HPS.GridKit | UnsetPriority () |
Removes a drawing priority setting. More... | |
HPS.GridKit | UnsetSecondCount () |
Removes the second reference count from this GridKit. More... | |
HPS.GridKit | UnsetSecondPoint () |
Removes the second reference point from this GridKit. More... | |
HPS.GridKit | UnsetType () |
Removes the type from this GridKit. More... | |
HPS.GridKit | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this kit. More... | |
HPS.GridKit | UnsetUserData (IntPtr[] in_indices) |
Removes the user data at the given indices from this kit. 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... | |
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... | |
Static Public Member Functions | |
static bool | operator!= (HPS.GridKit a, HPS.GridKit b) |
static bool | operator== (HPS.GridKit a, HPS.GridKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
Detailed Description
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty GridKit object.
|
inline |
Member Function Documentation
|
inline |
|
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.
|
inline |
|
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.Object.
|
inline |
|
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_count The count of the number of grid elements along the vector determined by the first reference point.
- Returns
- A reference to this GridKit.
|
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_point The first reference point for this GridKit.
- Returns
- A reference to this GridKit.
|
inline |
|
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_priority The drawing priority, higher priority items are drawn on top of lower priority items.
- Returns
- A reference to this object.
SubwindowKit::SetPriority()
|
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_count The count of the number of grid elements along the vector determined by the second reference point.
- Returns
- A reference to this GridKit.
|
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_point The second reference point for this GridKit.
- Returns
- A reference to this GridKit.
|
inline |
|
inline |
Sets user data on this kit.
- Parameters
-
in_index The index of the user data to set. in_bytes The number of bytes of user data to set. in_data The bytes of user data to set.
- Returns
- A reference to this kit.
|
inline |
Sets user data on this kit.
- Parameters
-
in_index The index of the user data to set. in_data The bytes of user data to set.
- Returns
- A reference to this kit.
|
inline |
Sets user data on this kit.
- Parameters
-
in_indices An array of user data indices to set. in_data An array of bytes of user data to set.
- Returns
- A reference to this kit.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Shows the drawing priority.
- Parameters
-
out_priority The drawing priority, higher priority items are drawn on top of lower priority items.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
|
inline |
|
inline |
|
inline |
Shows the user data at a given index for this kit.
- Parameters
-
in_index The index of the user data to show. out_data The user data at the given index.
- Returns
- true if there is user data at the given index, false otherwise.
|
inline |
Shows all user data for this kit.
- Parameters
-
out_indices An array of all user data indices set on this kit. out_data An array of all user data set on this kit.
- Returns
- true if there is user data on this kit, false otherwise.
|
inline |
Get the number of user data indices set on this kit.
|
inline |
Shows the indices of all user data set on this kit.
- Parameters
-
out_indices The user data indices set on this kit.
- Returns
- The number of user data indices set on this kit.
|
inline |
Removes all user data from this kit.
- Returns
- A reference to this kit.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Removes a drawing priority setting.
- Returns
- A reference to this GridKit.
|
inline |
|
inline |
|
inline |
|
inline |
Removes the user data at the given index from this kit.
- Parameters
-
in_index The index of the user data to remove.
- Returns
- A reference to this kit.
|
inline |
Removes the user data at the given indices from this kit.
- Parameters
-
in_indices The 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