REFERENCE MANUAL
The InfiniteLineKit class is a user space object. More...
Public Member Functions | |
void | Consume (HPS.InfiniteLineKit in_kit) |
Copies the source InfiniteLineKit into this InfiniteLineKit and resets the source kit. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this InfiniteLineKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.InfiniteLineKit in_kit) |
Check if the source InfiniteLineKit is equivalent to this InfiniteLineKit. More... | |
override int | GetHashCode () |
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. More... | |
void | Set (HPS.InfiniteLineKit in_kit) |
Copies the source InfiniteLineKit into this InfiniteLineKit. More... | |
HPS.InfiniteLineKit | SetFirst (HPS.Point in_first) |
Sets the first point for this InfiniteLineKit. More... | |
HPS.InfiniteLineKit | SetPriority (int in_priority) |
Assigns a specific drawing priority value to the 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 | 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... | |
void | Show (out HPS.InfiniteLineKit out_kit) |
Copies this InfiniteLineKit into the given InfiniteLineKit. More... | |
bool | ShowFirst (out HPS.Point out_first) |
Shows the first point for this InfiniteLineKit. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. 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... | |
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.InfiniteLineKit | UnsetAllUserData () |
Removes all user data from this kit. More... | |
HPS.InfiniteLineKit | UnsetEverything () |
Removes all settings from the InfiniteLineKit. More... | |
HPS.InfiniteLineKit | UnsetFirst () |
Removes the first point for this InfiniteLineKit. More... | |
HPS.InfiniteLineKit | UnsetPriority () |
Removes a drawing priority setting. More... | |
HPS.InfiniteLineKit | UnsetSecond () |
Removes the second point for this InfiniteLineKit. More... | |
HPS.InfiniteLineKit | UnsetType () |
Removes the type of this InfiniteLineKit. 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... | |
![]() | |
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.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 | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The InfiniteLineKit class is a user space object.
It is a kit analog to an InfiniteLineKey.
HPS.InfiniteLineKit.InfiniteLineKit | ( | ) |
The default constructor creates an empty InfiniteLineKit object.
HPS.InfiniteLineKit.InfiniteLineKit | ( | HPS.InfiniteLineKit | in_kit | ) |
The copy constructor creates a new InfiniteLineKit object that contains the same settings as the source InfiniteLineKit.
in_kit | The source <ref refid="class_h_p_s_1_1_infinite_line_kit" kindref="compound">InfiniteLineKit</ref> to copy. |
void HPS.InfiniteLineKit.Consume | ( | HPS.InfiniteLineKit | in_kit | ) |
Copies the source InfiniteLineKit into this InfiniteLineKit and resets the source kit.
in_kit | The source <ref refid="class_h_p_s_1_1_infinite_line_kit" kindref="compound">InfiniteLineKit</ref> to consume. |
|
virtual |
Indicates whether this InfiniteLineKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.InfiniteLineKit.Equals | ( | HPS.InfiniteLineKit | in_kit | ) |
Check if the source InfiniteLineKit is equivalent to this InfiniteLineKit.
in_kit | The source <ref refid="class_h_p_s_1_1_infinite_line_kit" kindref="compound">InfiniteLineKit</ref> to compare to this <ref refid="class_h_p_s_1_1_infinite_line_kit" kindref="compound">InfiniteLineKit</ref>. |
|
virtual |
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.
void HPS.InfiniteLineKit.Set | ( | HPS.InfiniteLineKit | in_kit | ) |
Copies the source InfiniteLineKit into this InfiniteLineKit.
in_kit | The source <ref refid="class_h_p_s_1_1_infinite_line_kit" kindref="compound">InfiniteLineKit</ref> to copy. |
HPS.InfiniteLineKit HPS.InfiniteLineKit.SetFirst | ( | HPS.Point | in_first | ) |
Sets the first point for this InfiniteLineKit.
in_first | The first point for this <ref refid="class_h_p_s_1_1_infinite_line_kit" kindref="compound">InfiniteLineKit</ref>. If the type is <ref refid="class_h_p_s_1_1_infinite_line_1a31697425b57e23592898ea6f892ca3cca9406e3c325bfc9873426e5eda4ba6e18" kindref="member">InfiniteLine::Type::Ray</ref>, this will be the point at which the ray starts. |
HPS.InfiniteLineKit 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.
in_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
SubwindowKit::SetPriority()
HPS.InfiniteLineKit HPS.InfiniteLineKit.SetSecond | ( | HPS.Point | in_second | ) |
Sets the second point for this InfiniteLineKit.
in_second | The second point for this <ref refid="class_h_p_s_1_1_infinite_line_kit" kindref="compound">InfiniteLineKit</ref>. If the type is <ref refid="class_h_p_s_1_1_infinite_line_1a31697425b57e23592898ea6f892ca3cca9406e3c325bfc9873426e5eda4ba6e18" kindref="member">InfiniteLine::Type::Ray</ref>, this will be the point through which the ray passes. |
HPS.InfiniteLineKit HPS.InfiniteLineKit.SetType | ( | HPS.InfiniteLine.Type | in_type | ) |
Sets the type of this InfiniteLineKit.
in_type | The type of this <ref refid="class_h_p_s_1_1_infinite_line_kit" kindref="compound">InfiniteLineKit</ref>. |
HPS.InfiniteLineKit HPS.InfiniteLineKit.SetUserData | ( | IntPtr | in_index, |
ulong | in_bytes, | ||
byte[] | in_data | ||
) |
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. |
HPS.InfiniteLineKit HPS.InfiniteLineKit.SetUserData | ( | IntPtr | in_index, |
byte[] | in_data | ||
) |
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. |
HPS.InfiniteLineKit HPS.InfiniteLineKit.SetUserData | ( | IntPtr[] | in_indices, |
byte | in_data[][] | ||
) |
Sets user data on this kit.
in_data | An array of bytes of user data to set. |
void HPS.InfiniteLineKit.Show | ( | out HPS.InfiniteLineKit | out_kit | ) |
Copies this InfiniteLineKit into the given InfiniteLineKit.
out_kit | The <ref refid="class_h_p_s_1_1_infinite_line_kit" kindref="compound">InfiniteLineKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_infinite_line_kit" kindref="compound">InfiniteLineKit</ref>. |
bool HPS.InfiniteLineKit.ShowFirst | ( | out HPS.Point | out_first | ) |
Shows the first point for this InfiniteLineKit.
out_first | The first point for this <ref refid="class_h_p_s_1_1_infinite_line_kit" kindref="compound">InfiniteLineKit</ref>. |
bool HPS.InfiniteLineKit.ShowPriority | ( | out int | out_priority | ) |
Shows the drawing priority.
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
bool HPS.InfiniteLineKit.ShowSecond | ( | out HPS.Point | out_second | ) |
Shows the second point for this InfiniteLineKit.
out_second | The second point for this <ref refid="class_h_p_s_1_1_infinite_line_kit" kindref="compound">InfiniteLineKit</ref>. |
bool HPS.InfiniteLineKit.ShowType | ( | out HPS.InfiniteLine.Type | out_type | ) |
Shows the type of this InfiniteLineKit.
out_type | The type of this <ref refid="class_h_p_s_1_1_infinite_line_kit" kindref="compound">InfiniteLineKit</ref>. |
bool HPS.InfiniteLineKit.ShowUserData | ( | IntPtr | in_index, |
out byte[] | out_data | ||
) |
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. |
bool HPS.InfiniteLineKit.ShowUserData | ( | out IntPtr[] | out_indices, |
out byte | out_data[][] | ||
) |
Shows all user data for this kit.
out_indices | An array of all user data indices set on this kit. |
ulong HPS.InfiniteLineKit.ShowUserDataCount | ( | ) |
Get the number of user data indices set on this kit.
bool HPS.InfiniteLineKit.ShowUserDataIndices | ( | out IntPtr[] | out_indices | ) |
Shows the indices of all user data set on this kit.
out_indices | The user data indices set on this kit. |
HPS.InfiniteLineKit HPS.InfiniteLineKit.UnsetAllUserData | ( | ) |
Removes all user data from this kit.
HPS.InfiniteLineKit HPS.InfiniteLineKit.UnsetEverything | ( | ) |
Removes all settings from the InfiniteLineKit.
HPS.InfiniteLineKit HPS.InfiniteLineKit.UnsetFirst | ( | ) |
Removes the first point for this InfiniteLineKit.
HPS.InfiniteLineKit HPS.InfiniteLineKit.UnsetPriority | ( | ) |
Removes a drawing priority setting.
HPS.InfiniteLineKit HPS.InfiniteLineKit.UnsetSecond | ( | ) |
Removes the second point for this InfiniteLineKit.
HPS.InfiniteLineKit HPS.InfiniteLineKit.UnsetType | ( | ) |
Removes the type of this InfiniteLineKit.
HPS.InfiniteLineKit HPS.InfiniteLineKit.UnsetUserData | ( | IntPtr | in_index | ) |
Removes the user data at the given index from this kit.
in_index | The index of the user data to remove. |
HPS.InfiniteLineKit HPS.InfiniteLineKit.UnsetUserData | ( | IntPtr[] | in_indices | ) |
Removes the user data at the given indices from this kit.
in_count | The size of the following array. |
in_indices | The indices of the user data to remove. |