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