SphereKit

class HPS.SphereKit : public HPS.Kit 

The SphereKit class is a user space object. It is a kit analog to a SphereKey.

Public Functions

void Consume (HPS.SphereKit in_kit)

Copies the source SphereKit into this SphereKit and resets the source kit.

Param in_kit: The source SphereKit to consume.

override void Dispose ()

override bool Empty ()

Indicates whether this SphereKit has any values set on it.

Return: true if no values are set on this SphereKit, false otherwise.

bool Equals (HPS.SphereKit in_kit)

Check if the source SphereKit is equivalent to this SphereKit.

Param in_kit: The source SphereKit to compare to this SphereKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return: The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.SphereKit in_kit)

Copies the source SphereKit into this SphereKit.

Param in_kit: The source SphereKit to copy.

HPS.SphereKit SetBasis (HPS.Vector in_vertical, HPS.Vector in_horizontal)

Sets the basis for the SphereKit.

Param in_vertical: The vector to use as the vertical axis for the SphereKit.
Param in_horizontal: The vector to use as the horizontal axis for the SphereKit.
Return: A reference to this SphereKit.

HPS.SphereKit SetCenter (HPS.Point in_center)

Sets the center point for the SphereKit.

Param in_center: The center point for the SphereKit.
Return: A reference to this 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.

See: SubwindowKit.SetPriority()
See: SubwindowKit.SetRenderingAlgorithm()

Param in_priority: The drawing priority, higher priority items are drawn on top of lower priority items.
Return: A reference to this object.

HPS.SphereKit SetRadius (float in_radius)

Sets the radius for the SphereKit.

Param in_radius: The radius for the SphereKit.
Return: A reference to this SphereKit.

HPS.SphereKit SetUserData (IntPtr in_index, byte[] in_data)

Sets user data on this kit.

Param in_index: The index of the user data to set.
Param in_data: The bytes of user data to set.
Return: A reference to this kit.

HPS.SphereKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)

Sets user data on this kit.

Param in_index: The index of the user data to set.
Param in_bytes: The number of bytes of user data to set.
Param in_data: The bytes of user data to set.
Return: A reference to this kit.

HPS.SphereKit SetUserData (IntPtr[] in_indices, byte[][] in_data)

Sets user data on this kit.

Param in_indices: An array of user data indices to set.
Param in_data: An array of bytes of user data to set.
Return: A reference to this kit.

void Show (out HPS.SphereKit out_kit)

Copies this SphereKit into the given SphereKit.

Param out_kit: The SphereKit to populate with the contents of this SphereKit.

bool ShowBasis (out HPS.Vector out_vertical, out HPS.Vector out_horizontal)

Shows the basis for the SphereKit.

Param out_vertical: The vector to use as the vertical axis for the SphereKit.
Param out_horizontal: The vector to use as the horizontal axis for the SphereKit.
Return: true if a basis was set, false otherwise.

bool ShowCenter (out HPS.Point out_center)

Shows the center point for this SphereKit.

Param out_center: The center point for the SphereKit.
Return: true if a center point was set, false otherwise.

bool ShowPriority (out int out_priority)

Shows the drawing priority.

Param out_priority: The drawing priority, higher priority items are drawn on top of lower priority items.
Return: true if the setting is valid, false otherwise.

bool ShowRadius (out float out_radius)

Shows the radius for the SphereKit.

Param out_radius: The radius for the SphereKit.
Return: true if a radius was set, false otherwise.

bool ShowUserData (IntPtr in_index, out byte[] out_data)

Shows the user data at a given index for this kit.

Param in_index: The index of the user data to show.
Param out_data: The user data at the given index.
Return: true if there is user data at the given index, false otherwise.

bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)

Shows all user data for this kit.

Param out_indices: An array of all user data indices set on this kit.
Param out_data: An array of all user data set on this kit.
Return: true if there is user data on this kit, false otherwise.

ulong ShowUserDataCount (): Get the number of user data indices set on this kit.

bool ShowUserDataIndices (out IntPtr[] out_indices)

Shows the indices of all user data set on this kit.

Param out_indices: The user data indices set on this kit.
Return: The number of user data indices set on this kit.

SphereKit (): The default constructor creates an empty SphereKit object.

SphereKit (HPS.SphereKit in_kit)

The copy constructor creates a new SphereKit object that contains the same settings as the source SphereKit.

Param in_kit: The source SphereKit to copy.

HPS.SphereKit UnsetAllUserData ()

Removes all user data from this kit.

Return: A reference to this kit.

HPS.SphereKit UnsetBasis ()

Removes the basis for this SphereKit.

Return: A reference to this SphereKit.

HPS.SphereKit UnsetCenter ()

Removes the center point for this SphereKit.

Return: A reference to this SphereKit.

HPS.SphereKit UnsetEverything ()

Removes all settings from the SphereKit.

Return: A reference to this SphereKit.

HPS.SphereKit UnsetPriority ()

Removes a drawing priority setting.

Return: A reference to this object.

HPS.SphereKit UnsetRadius ()

Removes the radius for this SphereKit.

Return: A reference to this SphereKit.

HPS.SphereKit UnsetUserData (IntPtr in_index)

Removes the user data at the given index from this kit.

Param in_index: The index of the user data to remove.
Return: A reference to this kit.

HPS.SphereKit UnsetUserData (IntPtr[] in_indices)

Removes the user data at the given indices from this kit.

Param in_indices: The indices of the user data to remove.
Return: A reference to this kit.

Public Static Functions

bool operator!= (HPS.SphereKit a, HPS.SphereKit b)

bool operator== (HPS.SphereKit a, HPS.SphereKit b)