REFERENCE MANUAL
The CircleKit class is a user space object. More...
Public Member Functions | |
CircleKit () | |
The default constructor creates an empty CircleKit object. More... | |
CircleKit (HPS.CircleKit in_kit) | |
The copy constructor creates a new CircleKit object that contains the same settings as the source CircleKit. More... | |
void | Consume (HPS.CircleKit in_kit) |
Copies the source CircleKit into this CircleKit and resets the source kit. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this CircleKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.CircleKit in_kit) |
Check if the source CircleKit is equivalent to this CircleKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.CircleKit in_kit) |
Copies the source CircleKit into this CircleKit. More... | |
HPS.CircleKit | SetCenter (HPS.Point in_center) |
Sets the center point for this CircleKit. More... | |
HPS.CircleKit | SetNormal (HPS.Vector in_normal) |
Sets the normal for this CircleKit. More... | |
HPS.CircleKit | SetPriority (int in_priority) |
Assigns a specific drawing priority value to the CircleKit. More... | |
HPS.CircleKit | SetRadius (float in_radius) |
Sets the radius for this CircleKit. More... | |
HPS.CircleKit | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.CircleKit | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.CircleKit | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this kit. More... | |
void | Show (out HPS.CircleKit out_kit) |
Copies this CircleKit into the given CircleKit. More... | |
bool | ShowCenter (out HPS.Point out_center) |
Shows the center point for this CircleKit. More... | |
bool | ShowNormal (out HPS.Vector out_normal) |
Shows the normal for this CircleKit. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
bool | ShowRadius (out float out_radius) |
Shows the radius for this CircleKit. 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.CircleKit | UnsetAllUserData () |
Removes all user data from this kit. More... | |
HPS.CircleKit | UnsetCenter () |
Removes the center point for this CircleKit. More... | |
HPS.CircleKit | UnsetEverything () |
Removes all settings from the CircleKit. More... | |
HPS.CircleKit | UnsetNormal () |
Removes the normal for this CircleKit. More... | |
HPS.CircleKit | UnsetPriority () |
Removes a drawing priority setting. More... | |
HPS.CircleKit | UnsetRadius () |
Removes the radius for this CircleKit. More... | |
HPS.CircleKit | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this kit. More... | |
HPS.CircleKit | 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.CircleKit a, HPS.CircleKit b) |
static bool | operator== (HPS.CircleKit a, HPS.CircleKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
HPS.CircleKit.CircleKit | ( | ) |
The default constructor creates an empty CircleKit object.
HPS.CircleKit.CircleKit | ( | HPS.CircleKit | in_kit | ) |
void HPS.CircleKit.Consume | ( | HPS.CircleKit | in_kit | ) |
|
virtual |
Indicates whether this CircleKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.CircleKit.Equals | ( | HPS.CircleKit | in_kit | ) |
Check if the source CircleKit is equivalent to this CircleKit.
in_kit | The source <ref refid="class_h_p_s_1_1_circle_kit" kindref="compound">CircleKit</ref> to compare to this <ref refid="class_h_p_s_1_1_circle_kit" kindref="compound">CircleKit</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.CircleKit.Set | ( | HPS.CircleKit | in_kit | ) |
HPS.CircleKit HPS.CircleKit.SetCenter | ( | HPS.Point | in_center | ) |
HPS.CircleKit HPS.CircleKit.SetNormal | ( | HPS.Vector | in_normal | ) |
HPS.CircleKit HPS.CircleKit.SetPriority | ( | int | in_priority | ) |
Assigns a specific drawing priority value to the CircleKit.
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.CircleKit HPS.CircleKit.SetRadius | ( | float | in_radius | ) |
HPS.CircleKit HPS.CircleKit.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.CircleKit HPS.CircleKit.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.CircleKit HPS.CircleKit.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.CircleKit.Show | ( | out HPS.CircleKit | out_kit | ) |
bool HPS.CircleKit.ShowCenter | ( | out HPS.Point | out_center | ) |
bool HPS.CircleKit.ShowNormal | ( | out HPS.Vector | out_normal | ) |
bool HPS.CircleKit.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.CircleKit.ShowRadius | ( | out float | out_radius | ) |
bool HPS.CircleKit.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.CircleKit.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.CircleKit.ShowUserDataCount | ( | ) |
Get the number of user data indices set on this kit.
bool HPS.CircleKit.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.CircleKit HPS.CircleKit.UnsetAllUserData | ( | ) |
Removes all user data from this kit.
HPS.CircleKit HPS.CircleKit.UnsetCenter | ( | ) |
HPS.CircleKit HPS.CircleKit.UnsetEverything | ( | ) |
HPS.CircleKit HPS.CircleKit.UnsetNormal | ( | ) |
HPS.CircleKit HPS.CircleKit.UnsetPriority | ( | ) |
Removes a drawing priority setting.
HPS.CircleKit HPS.CircleKit.UnsetRadius | ( | ) |
HPS.CircleKit HPS.CircleKit.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.CircleKit HPS.CircleKit.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. |