REFERENCE MANUAL
The Key class is the common base class of all Visualize keys. More...
Public Member Functions | |
virtual void | Assign (HPS.Key in_that) |
Share the smart-pointer. 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. More... | |
ulong | GetHash () |
Returns a hash code for the key. More... | |
override int | GetHashCode () |
bool | HasOwner () |
| |
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. More... | |
HPS.SegmentKey | Owner () |
| |
HPS.SegmentKey | Up () |
| |
![]() | |
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. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
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. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.Key a, HPS.Key b) |
static bool | operator== (HPS.Key a, HPS.Key b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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.
HPS.Key.Key | ( | ) |
An uninitialized key refers to no database object and Type() will return Type::None.
HPS.Key.Key | ( | HPS.Key | in_that | ) |
Shares a reference to a database object referred to by in_that.
HPS.Key.Key | ( | HPS.Control | in_control | ) |
Initializes a key tied to the Control in_control.
|
virtual |
Share the smart-pointer.
HPS.Key HPS.Key.CopyTo | ( | HPS.SegmentKey | in_destination | ) |
Copies the database object referred to by this key into a segment pointed to by in_destination.
void HPS.Key.Delete | ( | ) |
Removes the database object referred to by this key.
bool HPS.Key.Equals | ( | HPS.Key | in_that | ) |
Determines whether the database objects pointed to by this key and in_that are the same.
ulong HPS.Key.GetHash | ( | ) |
Returns a hash code for the key.
void HPS.Key.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.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
Reimplemented in HPS.OffScreenWindowKey, HPS.StandAloneWindowKey, HPS.LineKey, HPS.MarkerKey, HPS.MeshKey, HPS.NURBSCurveKey, HPS.NURBSSurfaceKey, HPS.PolygonKey, HPS.PortfolioKey, HPS.ReferenceKey, HPS.SegmentKey, HPS.ShellKey, HPS.SphereKey, HPS.SpotlightKey, HPS.StyleKey, HPS.TextKey, and HPS.WindowKey.