< Home

< Table of Contents

REFERENCE MANUAL

HPS.MarkerKit Class Reference

The MarkerKit class is a user space object. More...

Inheritance diagram for HPS.MarkerKit:
HPS.Object

Public Member Functions

void Consume (HPS.MarkerKit in_kit)
 Copies the source MarkerKit into this MarkerKit and resets the source kit. More...
 
override void Dispose ()
 
override bool Empty ()
 Indicates whether this MarkerKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.MarkerKit in_kit)
 Check if the source MarkerKit is equivalent to this MarkerKit. More...
 
override int GetHashCode ()
 
 MarkerKit ()
 The default constructor creates an empty MarkerKit object. More...
 
 MarkerKit (HPS.MarkerKit in_kit)
 The copy constructor creates a new MarkerKit object that contains the same settings as the source MarkerKit. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.MarkerKit in_kit)
 Copies the source MarkerKit into this MarkerKit. More...
 
HPS.MarkerKit SetPoint (HPS.Point in_point)
 Sets the point for this MarkerKit. More...
 
HPS.MarkerKit SetPriority (int in_priority)
 Assigns a specific drawing priority value to the MarkerKit. More...
 
HPS.MarkerKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 Sets user data on this kit. More...
 
HPS.MarkerKit SetUserData (IntPtr in_index, byte[] in_data)
 Sets user data on this kit. More...
 
HPS.MarkerKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 Sets user data on this kit. More...
 
void Show (out HPS.MarkerKit out_kit)
 Copies this MarkerKit into the given MarkerKit. More...
 
bool ShowPoint (out HPS.Point out_point)
 Shows the point for this MarkerKit. More...
 
bool ShowPriority (out int out_priority)
 Shows the drawing priority. More...
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 Shows the user data at a given index for this kit. More...
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 Shows all user data for this kit. More...
 
ulong ShowUserDataCount ()
 Get the number of user data indices set on this kit. More...
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 Shows the indices of all user data set on this kit. More...
 
HPS.MarkerKit UnsetAllUserData ()
 Removes all user data from this kit. More...
 
HPS.MarkerKit UnsetEverything ()
 Removes all settings from the MarkerKit. More...
 
HPS.MarkerKit UnsetPoint ()
 Removes the point for the MarkerKit. More...
 
HPS.MarkerKit UnsetPriority ()
 Removes a drawing priority setting. More...
 
HPS.MarkerKit UnsetUserData (IntPtr in_index)
 Removes the user data at the given index from this kit. More...
 
HPS.MarkerKit UnsetUserData (IntPtr[] in_indices)
 Removes the user data at the given indices from this kit. More...
 
- Public Member Functions inherited from HPS.Object
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...
 

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
 
HandleRef scptr
 

Detailed Description

The MarkerKit class is a user space object.

It is a kit analog to a MarkerKey.

Constructor & Destructor Documentation

HPS.MarkerKit.MarkerKit ( )

The default constructor creates an empty MarkerKit object.

HPS.MarkerKit.MarkerKit ( HPS.MarkerKit  in_kit)

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_marker_kit" kindref="compound">MarkerKit</ref> to copy.

Member Function Documentation

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

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_line_kit" kindref="compound">LineKit</ref> to consume.
override bool HPS.MarkerKit.Empty ( )
virtual

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.

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

Check if the source MarkerKit is equivalent to this MarkerKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_marker_kit" kindref="compound">MarkerKit</ref> to compare to this <ref refid="class_h_p_s_1_1_marker_kit" kindref="compound">MarkerKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
override HPS.Type HPS.MarkerKit.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

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

Copies the source MarkerKit into this MarkerKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_marker_kit" kindref="compound">MarkerKit</ref> to copy.
HPS.MarkerKit HPS.MarkerKit.SetPoint ( HPS.Point  in_point)

Sets the point for this MarkerKit.

Parameters
in_pointThe point for this <ref refid="class_h_p_s_1_1_marker_kit" kindref="compound">MarkerKit</ref>.
Returns
A reference to this MarkerKit.
HPS.MarkerKit HPS.MarkerKit.SetPriority ( int  in_priority)

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.

SubwindowKit::SetPriority()

SubwindowKit::SetRenderingAlgorithm()

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

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.
HPS.MarkerKit HPS.MarkerKit.SetUserData ( IntPtr  in_index,
byte[]  in_data 
)

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.
HPS.MarkerKit HPS.MarkerKit.SetUserData ( IntPtr[]  in_indices,
byte  in_data[][] 
)

Sets user data on this kit.

Parameters
in_dataAn array of bytes of user data to set.
Returns
A reference to this kit.
void HPS.MarkerKit.Show ( out HPS.MarkerKit  out_kit)

Copies this MarkerKit into the given MarkerKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_marker_kit" kindref="compound">MarkerKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_marker_kit" kindref="compound">MarkerKit</ref>.
bool HPS.MarkerKit.ShowPoint ( out HPS.Point  out_point)

Shows the point for this MarkerKit.

Parameters
out_pointThe point for this <ref refid="class_h_p_s_1_1_marker_kit" kindref="compound">MarkerKit</ref>.
Returns
true if a point was set, false otherwise.
bool HPS.MarkerKit.ShowPriority ( out int  out_priority)

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.
bool HPS.MarkerKit.ShowUserData ( IntPtr  in_index,
out byte[]  out_data 
)

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.
bool HPS.MarkerKit.ShowUserData ( out IntPtr[]  out_indices,
out byte  out_data[][] 
)

Shows all user data for this kit.

Parameters
out_indicesAn array of all user data indices set on this kit.
Returns
true if there is user data on this kit, false otherwise.
ulong HPS.MarkerKit.ShowUserDataCount ( )

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

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

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.
HPS.MarkerKit HPS.MarkerKit.UnsetAllUserData ( )

Removes all user data from this kit.

Returns
A reference to this kit.
HPS.MarkerKit HPS.MarkerKit.UnsetEverything ( )

Removes all settings from the MarkerKit.

Returns
A reference to this MarkerKit.
HPS.MarkerKit HPS.MarkerKit.UnsetPoint ( )

Removes the point for the MarkerKit.

Returns
A reference to this MarkerKit.
HPS.MarkerKit HPS.MarkerKit.UnsetPriority ( )

Removes a drawing priority setting.

Returns
A reference to this object.
HPS.MarkerKit HPS.MarkerKit.UnsetUserData ( IntPtr  in_index)

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.
HPS.MarkerKit HPS.MarkerKit.UnsetUserData ( IntPtr[]  in_indices)

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

Parameters
in_countThe size of the following array.
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: