class HPS.Key : public HPS.Object

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.

Subclassed by HPS.GeometryKey, HPS.IncludeKey, HPS.PortfolioKey, HPS.SegmentKey, HPS.ShaderKey, HPS.StyleKey

Public Functions

void Assign (HPS.Key in_that)

Share the underlying smart-pointer of the Key source.

Param in_that

The Key source of the assignment.

HPS.Key CopyTo (HPS.SegmentKey in_destination)

Performs a deep copy of the database object referred to by this key into a segment pointed to by in_destination. If the copied key includes other keys or has child nodes, they will be recursively copied. Include links will also be copied, however, link targets will not be copied.


The key of the new copy.

void Delete ()

Removes the database object referred to by this key.

override void Dispose ()
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.)

override bool Equals (Object obj)
ulong GetHash ()

Returns a hash code for the key.


The size_t hash code.

override int GetHashCode ()
bool HasOwner ()


Indicates whether this key has an owner or not.

Key ()

An uninitialized key refers to no database object and Type() will return Type.None.

Key (HPS.Control in_control)

Initializes a key associated to the Control in_control.

Key (HPS.Key in_that)

Shares a reference to a database object referred to by in_that.

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.

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


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

HPS.SegmentKey Owner ()


The segment containing this key.

HPS.SegmentKey Up ()


The segment containing this key.

Public Static Functions

bool operator!= (HPS.Key a, HPS.Key b)
bool operator== (HPS.Key a, HPS.Key b)