Inheritance diagram for HPS.MarkerKit:
HPS.Kit HPS.Object

Public Member Functions

void Consume (HPS.MarkerKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.MarkerKit in_kit)
 
override int GetHashCode ()
 
 MarkerKit ()
 
 MarkerKit (HPS.MarkerKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.MarkerKit in_kit)
 
HPS.MarkerKit SetPoint (HPS.Point in_point)
 
HPS.MarkerKit SetPriority (int in_priority)
 
HPS.MarkerKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.MarkerKit SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.MarkerKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
void Show (out HPS.MarkerKit out_kit)
 
bool ShowPoint (out HPS.Point out_point)
 
bool ShowPriority (out int out_priority)
 
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.MarkerKit UnsetAllUserData ()
 
HPS.MarkerKit UnsetEverything ()
 
HPS.MarkerKit UnsetPoint ()
 
HPS.MarkerKit UnsetPriority ()
 
HPS.MarkerKit UnsetUserData (IntPtr in_index)
 
HPS.MarkerKit UnsetUserData (IntPtr[] in_indices)
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static bool operator!= (HPS.MarkerKit a, HPS.MarkerKit b)
 
static bool operator== (HPS.MarkerKit a, HPS.MarkerKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The MarkerKit class is a user space object. It is a kit analog to a MarkerKey.

Constructor & Destructor Documentation

◆ MarkerKit() [1/2]

HPS.MarkerKit.MarkerKit ( )
inline

The default constructor creates an empty MarkerKit object.

◆ MarkerKit() [2/2]

HPS.MarkerKit.MarkerKit ( HPS.MarkerKit  in_kit)
inline

The copy constructor creates a new MarkerKit object that contains the same settings as the source MarkerKit.

Parameters
in_kitThe source MarkerKit to copy.

Member Function Documentation

◆ Consume()

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

Copies the source MarkerKit into this MarkerKit and resets the source kit.

Parameters
in_kitThe source LineKit to consume.

◆ Empty()

override bool HPS.MarkerKit.Empty ( )
inlinevirtual

Indicates whether this MarkerKit has any values set on it.

Returns
true if no values are set on this MarkerKit, false otherwise.

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.MarkerKit.Equals ( HPS.MarkerKit  in_kit)
inline

Check if the source MarkerKit is equivalent to this MarkerKit.

Parameters
in_kitThe source MarkerKit to compare to this MarkerKit.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

override HPS.Type HPS.MarkerKit.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.Kit.

◆ Set()

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

Copies the source MarkerKit into this MarkerKit.

Parameters
in_kitThe source MarkerKit to copy.

◆ SetPoint()

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

Sets the point for this MarkerKit.

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

◆ SetPriority()

HPS.MarkerKit HPS.MarkerKit.SetPriority ( int  in_priority)
inline

Assigns a specific drawing priority value to the MarkerKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority.

Parameters
in_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
A reference to this object.
See also
SubwindowKit.SetPriority()
SubwindowKit.SetRenderingAlgorithm()

◆ SetUserData() [1/3]

HPS.MarkerKit HPS.MarkerKit.SetUserData ( IntPtr  in_index,
ulong  in_bytes,
byte []  in_data 
)
inline

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_bytesThe number of bytes of user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [2/3]

HPS.MarkerKit HPS.MarkerKit.SetUserData ( IntPtr  in_index,
byte []  in_data 
)
inline

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [3/3]

HPS.MarkerKit HPS.MarkerKit.SetUserData ( IntPtr []  in_indices,
byte  in_data[][] 
)
inline

Sets user data on this kit.

Parameters
in_indicesAn array of user data indices to set.
in_dataAn array of bytes of user data to set.
Returns
A reference to this kit.

◆ Show()

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

Copies this MarkerKit into the given MarkerKit.

Parameters
out_kitThe MarkerKit to populate with the contents of this MarkerKit.

◆ ShowPoint()

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

Shows the point for this MarkerKit.

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

◆ ShowPriority()

bool HPS.MarkerKit.ShowPriority ( out int  out_priority)
inline

Shows the drawing priority.

Parameters
out_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
true if the setting is valid, false otherwise.

◆ ShowUserData() [1/2]

bool HPS.MarkerKit.ShowUserData ( IntPtr  in_index,
out byte []  out_data 
)
inline

Shows the user data at a given index for this kit.

Parameters
in_indexThe index of the user data to show.
out_dataThe user data at the given index.
Returns
true if there is user data at the given index, false otherwise.

◆ ShowUserData() [2/2]

bool HPS.MarkerKit.ShowUserData ( out IntPtr []  out_indices,
out byte  out_data[][] 
)
inline

Shows all user data for this kit.

Parameters
out_indicesAn array of all user data indices set on this kit.
out_dataAn array of all user data set on this kit.
Returns
true if there is user data on this kit, false otherwise.

◆ ShowUserDataCount()

ulong HPS.MarkerKit.ShowUserDataCount ( )
inline

Get the number of user data indices set on this kit.

◆ ShowUserDataIndices()

bool HPS.MarkerKit.ShowUserDataIndices ( out IntPtr []  out_indices)
inline

Shows the indices of all user data set on this kit.

Parameters
out_indicesThe user data indices set on this kit.
Returns
The number of user data indices set on this kit.

◆ UnsetAllUserData()

HPS.MarkerKit HPS.MarkerKit.UnsetAllUserData ( )
inline

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetEverything()

HPS.MarkerKit HPS.MarkerKit.UnsetEverything ( )
inline

Removes all settings from the MarkerKit.

Returns
A reference to this MarkerKit.

◆ UnsetPoint()

HPS.MarkerKit HPS.MarkerKit.UnsetPoint ( )
inline

Removes the point for the MarkerKit.

Returns
A reference to this MarkerKit.

◆ UnsetPriority()

HPS.MarkerKit HPS.MarkerKit.UnsetPriority ( )
inline

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetUserData() [1/2]

HPS.MarkerKit HPS.MarkerKit.UnsetUserData ( IntPtr  in_index)
inline

Removes the user data at the given index from this kit.

Parameters
in_indexThe index of the user data to remove.
Returns
A reference to this kit.

◆ UnsetUserData() [2/2]

HPS.MarkerKit HPS.MarkerKit.UnsetUserData ( IntPtr []  in_indices)
inline

Removes the user data at the given indices from this kit.

Parameters
in_indicesThe indices of the user data to remove.
Returns
A reference to this kit.

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