The Key class is the common base class of all Visualize keys. Keys are handles to database objects and are the primary way of interacting with them (you would never modify a database object directly). The underlying mechanism is a smart pointer (assignment operator works like regular pointers). Attempting to use a deleted or otherwise invalid key will result in an InvalidObjectException.
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...
|
|
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...
|
|
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The Key class is the common base class of all Visualize keys. Keys are handles to database objects and are the primary way of interacting with them (you would never modify a database object directly). The underlying mechanism is a smart pointer (assignment operator works like regular pointers). Attempting to use a deleted or otherwise invalid key will result in an InvalidObjectException.
An uninitialized key refers to no database object and Type() will return Type.None.
Shares a reference to a database object referred to by in_that.
Initializes a key tied to the Control in_control.
virtual void HPS.Key.Assign |
( |
HPS.Key |
in_that | ) |
|
|
inlinevirtual |
Share the underlying smart-pointer of the Key source.
- Parameters
-
in_that | The Key source of the assignment. |
Copies the database object referred to by this key into a segment pointed to by in_destination.
- Returns
- The key of the new copy.
Removes the database object referred to by this key.
bool HPS.Key.Equals |
( |
HPS.Key |
in_that | ) |
|
|
inline |
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.)
ulong HPS.Key.GetHash |
( |
| ) |
|
|
inline |
Returns a hash code for the key.
- Returns
- The size_t hash code.
Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner.
override HPS.Type HPS.Key.ObjectType |
( |
| ) |
|
|
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.
Reimplemented in HPS.MarkerKey, HPS.MeshKey, HPS.OffScreenWindowKey, HPS.StandAloneWindowKey, HPS.LineKey, HPS.NURBSCurveKey, HPS.NURBSSurfaceKey, HPS.PolygonKey, HPS.PortfolioKey, HPS.ReferenceKey, HPS.ShellKey, HPS.SphereKey, HPS.SpotlightKey, HPS.StyleKey, HPS.TextKey, HPS.SegmentKey, and HPS.WindowKey.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.Key.cs