|
void | Consume (HPS.GridKit in_kit) |
| Completely replaces all settings on this GridKey with those set on the specified kit and resets the kit. More...
|
|
override void | Dispose () |
|
| GridKey () |
| The default constructor creates an uninitialized GridKey object. The Type() function will return Type.None. More...
|
|
| GridKey (HPS.Key in_that) |
| 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. More...
|
|
| GridKey (HPS.GridKey in_that) |
| The copy constructor creates a GridKey object that shares the underlying smart-pointer of the source GridKey. 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) |
| Replace those settings on this GridKey with those set on the specified kit. More...
|
|
HPS.GridKey | SetFirstCount (int in_first_count) |
| 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. More...
|
|
HPS.GridKey | SetFirstPoint (HPS.Point in_first_point) |
| 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. More...
|
|
HPS.GridKey | SetOrigin (HPS.Point in_origin) |
| Sets the origin for this GridKey. More...
|
|
HPS.GridKey | SetSecondCount (int in_second_count) |
| 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. More...
|
|
HPS.GridKey | SetSecondPoint (HPS.Point in_second_point) |
| 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. More...
|
|
HPS.GridKey | SetType (HPS.Grid.Type in_type) |
| Sets the type of this GridKey. More...
|
|
void | Show (out HPS.GridKit out_kit) |
| Copy the contents of this GridKey into the specified kit. More...
|
|
bool | ShowFirstCount (out int out_first_count) |
| Shows the first reference count for this GridKey. More...
|
|
bool | ShowFirstPoint (out HPS.Point out_first_point) |
| Shows the first reference point for this GridKey. More...
|
|
bool | ShowOrigin (out HPS.Point out_origin) |
| Shows the origin for this GridKey. More...
|
|
bool | ShowSecondCount (out int out_second_count) |
| Shows the second reference count for this GridKey. More...
|
|
bool | ShowSecondPoint (out HPS.Point out_second_point) |
| Shows the second reference point for this GridKey. More...
|
|
bool | ShowType (out HPS.Grid.Type out_type) |
| Shows the type for this GridKey. More...
|
|
| GeometryKey () |
| The default constructor creates an uninitialized GeometryKey object. The Type() function will return Type.None. More...
|
|
| GeometryKey (HPS.Key in_that) |
| This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really a type of geometry key. Otherwise the copy will fail and the resulting GeometryKey will be invalid. More...
|
|
| GeometryKey (HPS.GeometryKey in_that) |
| The copy constructor creates a GeometryKey object that shares the underlying smart-pointer of the source GeometryKey. More...
|
|
HPS.GeometryKey | SetPriority (int in_priority) |
| Assigns a drawing priority value to the geometry. It affects the order in which the geometry is visited if and only if the rendering algorithm is set to Priority. The geometry has a default drawing priority assigned, based on the order of insertion. More...
|
|
HPS.GeometryKey | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
| Sets user data on this key. More...
|
|
HPS.GeometryKey | SetUserData (IntPtr in_index, byte[] in_data) |
| Sets user data on this key. More...
|
|
HPS.GeometryKey | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
| Sets user data on this key. More...
|
|
bool | ShowBounding (out HPS.BoundingKit out_kit) |
| Shows the bounding of this geometry. More...
|
|
bool | ShowPriority (out int out_priority) |
| Shows the drawing priority. More...
|
|
ulong | ShowReferrers (out HPS.SegmentKey[] out_segments) |
| Shows the all the segments which contain references to this key. Note that while a segment may only appear once in the returned array, that segment could have multiple references to this key. More...
|
|
ulong | ShowReferrers (out HPS.ReferenceKey[] out_references) |
| Shows the all the references to this key. More...
|
|
bool | ShowUserData (IntPtr in_index, out byte[] out_data) |
| Shows the user data at a given index for this key. More...
|
|
bool | ShowUserData (out IntPtr[] out_indices, out byte[][] out_data) |
| Shows all user data for this key. More...
|
|
ulong | ShowUserDataCount () |
| Get the number of user data indices set on this key. More...
|
|
bool | ShowUserDataIndices (out IntPtr[] out_indices) |
| Shows the indices of all user data set on this key. More...
|
|
HPS.GeometryKey | UnsetAllUserData () |
| Removes all user data from this key. More...
|
|
HPS.GeometryKey | UnsetPriority () |
| Removes the drawing priority setting. More...
|
|
HPS.GeometryKey | UnsetUserData (IntPtr in_index) |
| Removes the user data at the given index from this key. More...
|
|
HPS.GeometryKey | UnsetUserData (IntPtr[] in_indices) |
| Removes the user data at the given indices from this key. More...
|
|
virtual void | Assign (HPS.Key in_that) |
| Share the underlying smart-pointer of the Key source. More...
|
|
HPS.Key | CopyTo (HPS.SegmentKey in_destination) |
| Copies the database object referred to by this key into a segment pointed to by in_destination. More...
|
|
void | Delete () |
| Removes the database object referred to by this key. More...
|
|
override void | Dispose () |
|
override bool | Equals (System.Object obj) |
|
bool | Equals (HPS.Key in_that) |
| Determines whether the database objects pointed to by this key and in_that are the same. Empty keys (when key.Empty() returns true) are never equal to any key, even when the key is compared against itself (they act analogously to NaN comparisons in this case.) More...
|
|
ulong | GetHash () |
| Returns a hash code for the key. More...
|
|
override int | GetHashCode () |
|
bool | HasOwner () |
| - Returns
- Indicates whether this key has an owner or not.
|
|
| Key () |
| An uninitialized key refers to no database object and Type() will return Type.None. More...
|
|
| Key (HPS.Key in_that) |
| Shares a reference to a database object referred to by in_that. More...
|
|
| Key (HPS.Control in_control) |
| Initializes a key tied to the Control in_control. More...
|
|
void | MoveTo (HPS.SegmentKey in_new_owner) |
| Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner. 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...
|
|
HPS.SegmentKey | Owner () |
| - Returns
- The segment containing this key.
|
|
HPS.SegmentKey | Up () |
| - Returns
- The segment containing this key.
|
|
virtual bool | Empty () |
| Indicates whether this object has any values set on it. 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...
|
|
virtual 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...
|
|
The GridKey class is a smart pointer to a database object. It is a handle to a grid created by SegmentKey.InsertGrid.