The InfiniteLineKit class is a user space object. It is a kit analog to an InfiniteLineKey. More...
Public Member Functions | |
override void | Dispose () |
InfiniteLineKit () | |
The default constructor creates an empty InfiniteLineKit object. More... | |
InfiniteLineKit (HPS.InfiniteLineKit in_kit) | |
The copy constructor creates a new InfiniteLineKit object that contains the same settings as the source InfiniteLineKit. 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 | Consume (HPS.InfiniteLineKit in_kit) |
Copies the source InfiniteLineKit into this InfiniteLineKit and resets the source kit. More... | |
void | Set (HPS.InfiniteLineKit in_kit) |
Copies the source InfiniteLineKit into this InfiniteLineKit. More... | |
void | Show (out HPS.InfiniteLineKit out_kit) |
Copies this InfiniteLineKit into the given InfiniteLineKit. More... | |
override bool | Empty () |
Indicates whether this InfiniteLineKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.InfiniteLineKit in_kit) |
Check if the source InfiniteLineKit is equivalent to this InfiniteLineKit. More... | |
HPS.InfiniteLineKit | SetPriority (int in_priority) |
Assigns a specific drawing priority value to the InfiniteLineKit. 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.InfiniteLineKit | UnsetPriority () |
Removes a drawing priority setting. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
HPS.InfiniteLineKit | SetFirst (HPS.Point in_first) |
Sets the first point for this InfiniteLineKit. More... | |
HPS.InfiniteLineKit | SetSecond (HPS.Point in_second) |
Sets the second point for this InfiniteLineKit. More... | |
HPS.InfiniteLineKit | SetType (HPS.InfiniteLine.Type in_type) |
Sets the type of this InfiniteLineKit. More... | |
HPS.InfiniteLineKit | UnsetFirst () |
Removes the first point for this InfiniteLineKit. More... | |
HPS.InfiniteLineKit | UnsetSecond () |
Removes the second point for this InfiniteLineKit. More... | |
HPS.InfiniteLineKit | UnsetType () |
Removes the type of this InfiniteLineKit. More... | |
HPS.InfiniteLineKit | UnsetEverything () |
Removes all settings from the InfiniteLineKit. More... | |
bool | ShowFirst (out HPS.Point out_first) |
Shows the first point for this InfiniteLineKit. More... | |
bool | ShowSecond (out HPS.Point out_second) |
Shows the second point for this InfiniteLineKit. More... | |
bool | ShowType (out HPS.InfiniteLine.Type out_type) |
Shows the type of this InfiniteLineKit. More... | |
HPS.InfiniteLineKit | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.InfiniteLineKit | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.InfiniteLineKit | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this kit. More... | |
HPS.InfiniteLineKit | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this kit. More... | |
HPS.InfiniteLineKit | UnsetUserData (IntPtr[] in_indices) |
Removes the user data at the given indices from this kit. More... | |
HPS.InfiniteLineKit | UnsetAllUserData () |
Removes all user data from 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... | |
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... | |
![]() | |
IntPtr | GetClassID () |
Object (HPS.Object that) | |
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... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
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... | |
Static Public Member Functions | |
static bool | operator== (HPS.InfiniteLineKit a, HPS.InfiniteLineKit b) |
static bool | operator!= (HPS.InfiniteLineKit a, HPS.InfiniteLineKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The InfiniteLineKit class is a user space object. It is a kit analog to an InfiniteLineKey.
|
inline |
The default constructor creates an empty InfiniteLineKit object.
|
inline |
The copy constructor creates a new InfiniteLineKit object that contains the same settings as the source InfiniteLineKit.
in_kit | The source InfiniteLineKit to copy. |
|
inline |
Copies the source InfiniteLineKit into this InfiniteLineKit and resets the source kit.
in_kit | The source InfiniteLineKit to consume. |
|
inlinevirtual |
Indicates whether this InfiniteLineKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source InfiniteLineKit is equivalent to this InfiniteLineKit.
in_kit | The source InfiniteLineKit to compare to this InfiniteLineKit. |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
inline |
Copies the source InfiniteLineKit into this InfiniteLineKit.
in_kit | The source InfiniteLineKit to copy. |
|
inline |
Sets the first point for this InfiniteLineKit.
in_first | The first point for this InfiniteLineKit. If the type is InfiniteLine::Type::Ray, this will be the point at which the ray starts. |
|
inline |
Assigns a specific drawing priority value to the InfiniteLineKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority.
in_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
SubwindowKit::SetPriority()
|
inline |
Sets the second point for this InfiniteLineKit.
in_second | The second point for this InfiniteLineKit. If the type is InfiniteLine::Type::Ray, this will be the point through which the ray passes. |
|
inline |
Sets the type of this InfiniteLineKit.
in_type | The type of this InfiniteLineKit. |
|
inline |
Sets user data on this kit.
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. |
|
inline |
Sets user data on this kit.
in_index | The index of the user data to set. |
in_data | The bytes of user data to set. |
|
inline |
Sets user data on this kit.
in_indices | An array of user data indices to set. |
in_data | An array of bytes of user data to set. |
|
inline |
Copies this InfiniteLineKit into the given InfiniteLineKit.
out_kit | The InfiniteLineKit to populate with the contents of this InfiniteLineKit. |
|
inline |
Shows the first point for this InfiniteLineKit.
out_first | The first point for this InfiniteLineKit. |
|
inline |
Shows the drawing priority.
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
|
inline |
Shows the second point for this InfiniteLineKit.
out_second | The second point for this InfiniteLineKit. |
|
inline |
Shows the type of this InfiniteLineKit.
out_type | The type of this InfiniteLineKit. |
|
inline |
Shows the user data at a given index for this kit.
in_index | The index of the user data to show. |
out_data | The user data at the given index. |
|
inline |
Shows all user data for this kit.
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. |
|
inline |
Get the number of user data indices set on this kit.
|
inline |
Shows the indices of all user data set on this kit.
out_indices | The user data indices set on this kit. |
|
inline |
Removes all user data from this kit.
|
inline |
Removes all settings from the InfiniteLineKit.
|
inline |
Removes the first point for this InfiniteLineKit.
|
inline |
Removes a drawing priority setting.
|
inline |
Removes the second point for this InfiniteLineKit.
|
inline |
Removes the type of this InfiniteLineKit.
|
inline |
Removes the user data at the given index from this kit.
in_index | The index of the user data to remove. |
|
inline |
Removes the user data at the given indices from this kit.
in_indices | The indices of the user data to remove. |