The CircularWedgeKit class is a user space object. It is a kit analog to a CircularWedgeKey. More...
Public Member Functions | |
override void | Dispose () |
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... | |
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.CircularWedgeKit in_kit) |
Copies the source CircularWedgeKit into this CircularWedgeKit and resets the source kit. More... | |
void | Set (HPS.CircularWedgeKit in_kit) |
Copies the source CircularWedgeKit into this CircularWedgeKit. More... | |
void | Show (out HPS.CircularWedgeKit out_kit) |
Copies this CircularWedgeKit into the given CircularWedgeKit. More... | |
override bool | Empty () |
Indicates whether this CircularWedgeKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.CircularWedgeKit in_kit) |
Check if the source CircularWedgeKit is equivalent to this CircularWedgeKit. More... | |
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. More... | |
HPS.CircularWedgeKit | UnsetPriority () |
Removes a drawing priority setting. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
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. More... | |
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. More... | |
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. More... | |
HPS.CircularWedgeKit | UnsetStart () |
Removes the start point for this CircularWedgeKit. More... | |
HPS.CircularWedgeKit | UnsetMiddle () |
Removes the middle point for this CircularWedgeKit. More... | |
HPS.CircularWedgeKit | UnsetEnd () |
Removes the end point for this CircularWedgeKit. More... | |
HPS.CircularWedgeKit | UnsetEverything () |
Removes all settings from the CircularWedgeKit. More... | |
bool | ShowStart (out HPS.Point out_start) |
Shows the start point for this CircularWedgeKit. More... | |
bool | ShowMiddle (out HPS.Point out_middle) |
Shows the middle point for this CircularWedgeKit. More... | |
bool | ShowEnd (out HPS.Point out_end) |
Shows the end 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... | |
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... | |
HPS.CircularWedgeKit | 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.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 | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The CircularWedgeKit class is a user space object. It is a kit analog to a CircularWedgeKey.
|
inline |
The default constructor creates an empty CircularWedgeKit object.
|
inline |
The copy constructor creates a new CircularWedgeKit object that contains the same settings as the source CircularWedgeKit.
in_kit | The source CircularWedgeKit to copy. |
|
inline |
Copies the source CircularWedgeKit into this CircularWedgeKit and resets the source kit.
in_kit | The source CircularWedgeKit to consume. |
|
inlinevirtual |
Indicates whether this CircularWedgeKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source CircularWedgeKit is equivalent to this CircularWedgeKit.
in_kit | The source CircularWedgeKit to compare to this CircularWedgeKit. |
|
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 CircularWedgeKit into this CircularWedgeKit.
in_kit | The source CircularWedgeKit to copy. |
|
inline |
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 CircularWedgeKit. |
|
inline |
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 CircularWedgeKit. |
|
inline |
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()
|
inline |
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 CircularWedgeKit. |
|
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 CircularWedgeKit into the given CircularWedgeKit.
out_kit | The CircularWedgeKit to populate with the contents of this CircularWedgeKit. |
|
inline |
Shows the end point for this CircularWedgeKit.
out_end | The end point for this CircularWedgeKit. |
|
inline |
Shows the middle point for this CircularWedgeKit.
out_middle | The middle point for this CircularWedgeKit. |
|
inline |
Shows the drawing priority.
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
|
inline |
Shows the start point for this CircularWedgeKit.
out_start | The start point for this CircularWedgeKit. |
|
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 the end point for this CircularWedgeKit.
|
inline |
Removes all settings from the CircularWedgeKit.
|
inline |
Removes the middle point for this CircularWedgeKit.
|
inline |
Removes a drawing priority setting.
|
inline |
Removes the start point for this CircularWedgeKit.
|
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. |