REFERENCE MANUAL
The MarkerKey class is a smart pointer to a database object. More...
Public Member Functions | |
void | Consume (HPS.MarkerKit in_kit) |
Completely replaces all settings on this MarkerKey with those set on the specified kit and resets the kit. More... | |
override void | Dispose () |
MarkerKey () | |
The default constructor creates an uninitialized MarkerKey object. More... | |
MarkerKey (HPS.Key in_that) | |
This constructor creates a MarkerKey object that shares the underlying smart-pointer of the source Key. More... | |
MarkerKey (HPS.MarkerKey in_that) | |
This constructor creates a MarkerKey object that shares the underlying smart-pointer of the source Key. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.MarkerKit in_kit) |
Replace those settings on this MarkerKey with those set on the specified kit. More... | |
HPS.MarkerKey | SetPoint (HPS.Point in_point) |
Sets the point for this MarkerKey. More... | |
void | Show (out HPS.MarkerKit out_kit) |
Copy the contents of this MarkerKey into the specified kit. More... | |
bool | ShowPoint (out HPS.Point out_point) |
Shows the point for this MarkerKey. More... | |
![]() | |
GeometryKey () | |
The default constructor creates an uninitialized GeometryKey object. More... | |
GeometryKey (HPS.Key in_that) | |
This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. More... | |
GeometryKey (HPS.GeometryKey in_that) | |
This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. More... | |
HPS.GeometryKey | SetPriority (int in_priority) |
Assigns a drawing priority value to the geometry. 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 | ShowBoundings (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. 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 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 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... | |
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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.Key a, HPS.Key b) |
static bool | operator== (HPS.Key a, HPS.Key b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The MarkerKey class is a smart pointer to a database object.
It is a handle to a marker inserted via SegmentKey::InsertMarker.
HPS.MarkerKey.MarkerKey | ( | ) |
HPS.MarkerKey.MarkerKey | ( | HPS.Key | in_that | ) |
HPS.MarkerKey.MarkerKey | ( | HPS.MarkerKey | in_that | ) |
void HPS.MarkerKey.Consume | ( | HPS.MarkerKit | in_kit | ) |
|
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.GeometryKey.
void HPS.MarkerKey.Set | ( | HPS.MarkerKit | in_kit | ) |
HPS.MarkerKey HPS.MarkerKey.SetPoint | ( | HPS.Point | in_point | ) |
void HPS.MarkerKey.Show | ( | out HPS.MarkerKit | out_kit | ) |
bool HPS.MarkerKey.ShowPoint | ( | out HPS.Point | out_point | ) |