Inheritance diagram for HPS.MarkerKey:
HPS.GeometryKey HPS.Key HPS.Object

Public Member Functions

void Consume (HPS.MarkerKit in_kit)
 
override void Dispose ()
 
 MarkerKey ()
 
 MarkerKey (HPS.Key in_that)
 
 MarkerKey (HPS.MarkerKey in_that)
 
override HPS.Type ObjectType ()
 
void Set (HPS.MarkerKit in_kit)
 
HPS.MarkerKey SetPoint (HPS.Point in_point)
 
void Show (out HPS.MarkerKit out_kit)
 
bool ShowPoint (out HPS.Point out_point)
 
- Public Member Functions inherited from HPS.GeometryKey
 GeometryKey ()
 
 GeometryKey (HPS.Key in_that)
 
 GeometryKey (HPS.GeometryKey in_that)
 
HPS.GeometryKey SetPriority (int in_priority)
 
HPS.GeometryKey SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.GeometryKey SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.GeometryKey SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
bool ShowBounding (out HPS.BoundingKit out_kit)
 
bool ShowPriority (out int out_priority)
 
ulong ShowReferrers (out HPS.SegmentKey[] out_segments)
 
ulong ShowReferrers (out HPS.ReferenceKey[] out_references)
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 
ulong ShowUserDataCount ()
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 
HPS.GeometryKey UnsetAllUserData ()
 
HPS.GeometryKey UnsetPriority ()
 
HPS.GeometryKey UnsetUserData (IntPtr in_index)
 
HPS.GeometryKey UnsetUserData (IntPtr[] in_indices)
 
- Public Member Functions inherited from HPS.Key
virtual void Assign (HPS.Key in_that)
 
HPS.Key CopyTo (HPS.SegmentKey in_destination)
 
void Delete ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Key in_that)
 
ulong GetHash ()
 
override int GetHashCode ()
 
bool HasOwner ()
 
 Key ()
 
 Key (HPS.Key in_that)
 
 Key (HPS.Control in_control)
 
void MoveTo (HPS.SegmentKey in_new_owner)
 
HPS.SegmentKey Owner ()
 
HPS.SegmentKey Up ()
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Key
static bool operator!= (HPS.Key a, HPS.Key b)
 
static bool operator== (HPS.Key a, HPS.Key b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The MarkerKey class is a smart pointer to a database object. It is a handle to a marker inserted via SegmentKey.InsertMarker.

Constructor & Destructor Documentation

◆ MarkerKey() [1/3]

HPS.MarkerKey.MarkerKey ( )
inline

The default constructor creates an uninitialized MarkerKey object. The Type() function will return Type.None.

◆ MarkerKey() [2/3]

HPS.MarkerKey.MarkerKey ( HPS.Key  in_that)
inline

This constructor creates a MarkerKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a Marker key. Otherwise the copy will fail and the resulting MarkerKey will be invalid.

Parameters
in_thatThe source Key to copy.

◆ MarkerKey() [3/3]

HPS.MarkerKey.MarkerKey ( HPS.MarkerKey  in_that)
inline

The copy constructor creates a MarkerKey object that shares the underlying smart-pointer of the source MarkerKey.

Parameters
in_thatThe source MarkerKey to copy.

Member Function Documentation

◆ Consume()

void HPS.MarkerKey.Consume ( HPS.MarkerKit  in_kit)
inline

Completely replaces all settings on this MarkerKey with those set on the specified kit and resets the kit.

Parameters
in_kitThe kit from which to get the settings to replace on this MarkerKey.

◆ ObjectType()

override HPS.Type HPS.MarkerKey.ObjectType ( )
inlinevirtual

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

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

Reimplemented from HPS.GeometryKey.

◆ Set()

void HPS.MarkerKey.Set ( HPS.MarkerKit  in_kit)
inline

Replace those settings on this MarkerKey with those set on the specified kit.

Parameters
in_kitThe kit from which to get the settings to replace on this MarkerKey.

◆ SetPoint()

HPS.MarkerKey HPS.MarkerKey.SetPoint ( HPS.Point  in_point)
inline

Sets the point for this MarkerKey.

Parameters
in_pointThe point for this MarkerKey.
Returns
A reference to this MarkerKey.

◆ Show()

void HPS.MarkerKey.Show ( out HPS.MarkerKit  out_kit)
inline

Copy the contents of this MarkerKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this MarkerKey.

◆ ShowPoint()

bool HPS.MarkerKey.ShowPoint ( out HPS.Point  out_point)
inline

Shows the point for this MarkerKey.

Parameters
out_pointThe point for this MarkerKey.
Returns
true if a point was set, false otherwise.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.MarkerKey.cs