
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. This does not necessarily give the true type of the underlying object. 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. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority. 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... | |
![]() | |
Kit (HPS.Kit in_that) | |
override HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.MarkerKit a, HPS.MarkerKit b) |
static bool | operator== (HPS.MarkerKit a, HPS.MarkerKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty MarkerKit object.
|
inline |
Member Function Documentation
|
inline |
|
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.
|
inline |
|
inlinevirtual |
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.Kit.
|
inline |
|
inline |
|
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_priority The drawing priority, higher priority items are drawn on top of lower priority items.
- Returns
- A reference to this object.
SubwindowKit.SetPriority()
|
inline |
Sets user data on this kit.
- Parameters
-
in_index The index of the user data to set. in_bytes The number of bytes of user data to set. in_data The bytes of user data to set.
- Returns
- A reference to this kit.
|
inline |
Sets user data on this kit.
- Parameters
-
in_index The index of the user data to set. in_data The bytes of user data to set.
- Returns
- A reference to this kit.
|
inline |
Sets user data on this kit.
- Parameters
-
in_indices An array of user data indices to set. in_data An array of bytes of user data to set.
- Returns
- A reference to this kit.
|
inline |
|
inline |
|
inline |
Shows the drawing priority.
- Parameters
-
out_priority The drawing priority, higher priority items are drawn on top of lower priority items.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the user data at a given index for this kit.
- Parameters
-
in_index The index of the user data to show. out_data The user data at the given index.
- Returns
- true if there is user data at the given index, false otherwise.
|
inline |
Shows all user data for this kit.
- Parameters
-
out_indices An array of all user data indices set on this kit. out_data An array of all user data set on this kit.
- Returns
- true if there is user data on this kit, false otherwise.
|
inline |
Get the number of user data indices set on this kit.
|
inline |
Shows the indices of all user data set on this kit.
- Parameters
-
out_indices The user data indices set on this kit.
- Returns
- The number of user data indices set on this kit.
|
inline |
Removes all user data from this kit.
- Returns
- A reference to this kit.
|
inline |
Removes all settings from the MarkerKit.
- Returns
- A reference to this MarkerKit.
|
inline |
Removes the point for the MarkerKit.
- Returns
- A reference to this MarkerKit.
|
inline |
Removes a drawing priority setting.
- Returns
- A reference to this object.
|
inline |
Removes the user data at the given index from this kit.
- Parameters
-
in_index The index of the user data to remove.
- Returns
- A reference to this kit.
|
inline |
Removes the user data at the given indices from this kit.
- Parameters
-
in_indices The 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