REFERENCE MANUAL
#include <hps.h>
Public Member Functions | |
virtual void | Assign (Key const &in_that) |
Key | CopyTo (SegmentKey const &in_destination) const |
void | Delete () |
bool | Equals (Key const &in_that) const |
size_t | GetHash () const |
bool | HasOwner () const |
Key () | |
Key (Key const &in_that) | |
Key (Control const &in_control) | |
Key (Key &&in_that) | |
void | MoveTo (SegmentKey const &in_new_owner) |
Type | ObjectType () const |
bool | operator!= (Key const &in_that) const |
Key & | operator= (Key &&in_that) |
Key & | operator= (Key const &in_that) |
bool | operator== (Key const &in_that) const |
SegmentKey | Owner () const |
SegmentKey | Up () const |
virtual | ~Key () |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
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.
Key::Key | ( | ) |
An uninitialized key refers to no database object and Type() will return Type::None.
Key::Key | ( | Key const & | in_that | ) |
Shares a reference to a database object referred to by in_that.
Key::Key | ( | Key && | in_that | ) |
|
virtual |
Releases a reference to this key, but it does not remove the key from the database.
|
virtual |
Share the smart-pointer.
Key Key::CopyTo | ( | SegmentKey const & | in_destination | ) | const |
Copies the database object referred to by this key into a segment pointed to by in_destination.
void Key::Delete | ( | ) |
Removes the database object referred to by this key.
bool Key::Equals | ( | Key const & | in_that | ) | const |
Determines whether the database objects pointed to by this key and in_that are the same.
size_t Key::GetHash | ( | ) | const |
Returns a hash code for the key.
bool Key::HasOwner | ( | ) | const |
void Key::MoveTo | ( | SegmentKey const & | in_new_owner | ) |
Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
Reimplemented in OffScreenWindowKey, PortfolioKey, ApplicationWindowKey, StandAloneWindowKey, ReferenceKey, StyleKey, IncludeKey, GridKey, PolygonKey, MeshKey, ShellKey, TextKey, EllipticalArcKey, EllipseKey, NURBSSurfaceKey, NURBSCurveKey, SpotlightKey, InfiniteLineKey, CuttingSectionKey, CircularWedgeKey, CircularArcKey, CircleKey, SphereKey, CylinderKey, DistantLightKey, MarkerKey, LineKey, GeometryKey, WindowKey, and SegmentKey.
bool Key::operator!= | ( | Key const & | in_that | ) | const |
Determines whether the database objects pointed to by this key and in_that are the same.
bool Key::operator== | ( | Key const & | in_that | ) | const |
Determines whether the database objects pointed to by this key and in_that are the same.
SegmentKey Key::Owner | ( | ) | const |
SegmentKey Key::Up | ( | ) | const |