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