REFERENCE MANUAL
The CircularArcKit class is a user space object. More...
Public Member Functions | |
CircularArcKit () | |
The default constructor creates an empty CircularArcKit object. More... | |
CircularArcKit (HPS.CircularArcKit in_kit) | |
The copy constructor creates a new CircularArcKit object that contains the same settings as the source CircularArcKit. More... | |
void | Consume (HPS.CircularArcKit in_kit) |
Copies the source CircularArcKit into this CircularArcKit and resets the source kit. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this CircularArcKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.CircularArcKit in_kit) |
Check if the source CircularArcKit is equivalent to this CircularArcKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.CircularArcKit in_kit) |
Copies the source CircularArcKit into this CircularArcKit. More... | |
HPS.CircularArcKit | SetEnd (HPS.Point in_end) |
Sets the end point for this CircularArcKit. More... | |
HPS.CircularArcKit | SetMiddle (HPS.Point in_middle) |
Sets the middle point for this CircularArcKit. More... | |
HPS.CircularArcKit | SetPriority (int in_priority) |
Assigns a specific drawing priority value to the CircularArcKit. More... | |
HPS.CircularArcKit | SetStart (HPS.Point in_start) |
Sets the start point for this CircularArcKit. More... | |
HPS.CircularArcKit | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.CircularArcKit | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.CircularArcKit | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this kit. More... | |
void | Show (out HPS.CircularArcKit out_kit) |
Copies this CircularArcKit into the given CircularArcKit. More... | |
bool | ShowEnd (out HPS.Point out_end) |
Shows the end point for this CircularArcKit. More... | |
bool | ShowMiddle (out HPS.Point out_middle) |
Shows the middle point for this CircularArcKit. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
bool | ShowStart (out HPS.Point out_start) |
Shows the start point for this CircularArcKit. 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.CircularArcKit | UnsetAllUserData () |
Removes all user data from this kit. More... | |
HPS.CircularArcKit | UnsetEnd () |
Removes the end point for this CircularArcKit. More... | |
HPS.CircularArcKit | UnsetEverything () |
Removes all settings from the CircularArcKit. More... | |
HPS.CircularArcKit | UnsetMiddle () |
Removes the middle point for this CircularArcKit. More... | |
HPS.CircularArcKit | UnsetPriority () |
Removes a drawing priority setting. More... | |
HPS.CircularArcKit | UnsetStart () |
Removes the start point for this CircularArcKit. More... | |
HPS.CircularArcKit | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this kit. More... | |
HPS.CircularArcKit | 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.CircularArcKit a, HPS.CircularArcKit b) |
static bool | operator== (HPS.CircularArcKit a, HPS.CircularArcKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The CircularArcKit class is a user space object.
It is a kit analog to a CircularArcKey.
HPS.CircularArcKit.CircularArcKit | ( | ) |
The default constructor creates an empty CircularArcKit object.
HPS.CircularArcKit.CircularArcKit | ( | HPS.CircularArcKit | in_kit | ) |
The copy constructor creates a new CircularArcKit object that contains the same settings as the source CircularArcKit.
in_kit | The source <ref refid="class_h_p_s_1_1_circular_arc_kit" kindref="compound">CircularArcKit</ref> to copy. |
void HPS.CircularArcKit.Consume | ( | HPS.CircularArcKit | in_kit | ) |
Copies the source CircularArcKit into this CircularArcKit and resets the source kit.
in_kit | The source <ref refid="class_h_p_s_1_1_line_kit" kindref="compound">LineKit</ref> to consume. |
|
virtual |
Indicates whether this CircularArcKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.CircularArcKit.Equals | ( | HPS.CircularArcKit | in_kit | ) |
Check if the source CircularArcKit is equivalent to this CircularArcKit.
in_kit | The source <ref refid="class_h_p_s_1_1_circular_arc_kit" kindref="compound">CircularArcKit</ref> to compare to this <ref refid="class_h_p_s_1_1_circular_arc_kit" kindref="compound">CircularArcKit</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.CircularArcKit.Set | ( | HPS.CircularArcKit | in_kit | ) |
Copies the source CircularArcKit into this CircularArcKit.
in_kit | The source <ref refid="class_h_p_s_1_1_circular_arc_kit" kindref="compound">CircularArcKit</ref> to copy. |
HPS.CircularArcKit HPS.CircularArcKit.SetEnd | ( | HPS.Point | in_end | ) |
Sets the end point for this CircularArcKit.
This is the point on the circumference of the circle at which the circular arc ends.
in_end | The end point for this <ref refid="class_h_p_s_1_1_circular_arc_kit" kindref="compound">CircularArcKit</ref>. |
HPS.CircularArcKit HPS.CircularArcKit.SetMiddle | ( | HPS.Point | in_middle | ) |
Sets the middle point for this CircularArcKit.
This is a point on the circumference of the circle between the start and end points for the circular arc.
in_middle | The middle point for this <ref refid="class_h_p_s_1_1_circular_arc_kit" kindref="compound">CircularArcKit</ref>. |
HPS.CircularArcKit HPS.CircularArcKit.SetPriority | ( | int | in_priority | ) |
Assigns a specific drawing priority value to the CircularArcKit.
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.CircularArcKit HPS.CircularArcKit.SetStart | ( | HPS.Point | in_start | ) |
Sets the start point for this CircularArcKit.
This is the point on the circumference of the circle at which the circular arc starts.
in_start | The start point for this <ref refid="class_h_p_s_1_1_circular_arc_kit" kindref="compound">CircularArcKit</ref>. |
HPS.CircularArcKit HPS.CircularArcKit.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.CircularArcKit HPS.CircularArcKit.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.CircularArcKit HPS.CircularArcKit.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.CircularArcKit.Show | ( | out HPS.CircularArcKit | out_kit | ) |
Copies this CircularArcKit into the given CircularArcKit.
out_kit | The <ref refid="class_h_p_s_1_1_circular_arc_kit" kindref="compound">CircularArcKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_circular_arc_kit" kindref="compound">CircularArcKit</ref>. |
bool HPS.CircularArcKit.ShowEnd | ( | out HPS.Point | out_end | ) |
Shows the end point for this CircularArcKit.
out_end | The end point for this <ref refid="class_h_p_s_1_1_circular_arc_kit" kindref="compound">CircularArcKit</ref>. |
bool HPS.CircularArcKit.ShowMiddle | ( | out HPS.Point | out_middle | ) |
Shows the middle point for this CircularArcKit.
out_middle | The middle point for this <ref refid="class_h_p_s_1_1_circular_arc_kit" kindref="compound">CircularArcKit</ref>. |
bool HPS.CircularArcKit.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.CircularArcKit.ShowStart | ( | out HPS.Point | out_start | ) |
Shows the start point for this CircularArcKit.
out_start | The start point for this <ref refid="class_h_p_s_1_1_circular_arc_kit" kindref="compound">CircularArcKit</ref>. |
bool HPS.CircularArcKit.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.CircularArcKit.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.CircularArcKit.ShowUserDataCount | ( | ) |
Get the number of user data indices set on this kit.
bool HPS.CircularArcKit.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.CircularArcKit HPS.CircularArcKit.UnsetAllUserData | ( | ) |
Removes all user data from this kit.
HPS.CircularArcKit HPS.CircularArcKit.UnsetEnd | ( | ) |
Removes the end point for this CircularArcKit.
HPS.CircularArcKit HPS.CircularArcKit.UnsetEverything | ( | ) |
Removes all settings from the CircularArcKit.
HPS.CircularArcKit HPS.CircularArcKit.UnsetMiddle | ( | ) |
Removes the middle point for this CircularArcKit.
HPS.CircularArcKit HPS.CircularArcKit.UnsetPriority | ( | ) |
Removes a drawing priority setting.
HPS.CircularArcKit HPS.CircularArcKit.UnsetStart | ( | ) |
Removes the start point for this CircularArcKit.
HPS.CircularArcKit HPS.CircularArcKit.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.CircularArcKit HPS.CircularArcKit.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. |