CircleKit

class HPS.CircleKit : public HPS.Kit 

The HPS.CircleKit class is a user space object. It is a kit analog to a HPS.CircleKey.

Public Functions

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

CircleKit (HPS.CircleKit in_kit)

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

Param in_kit: The source CircleKit to copy.

void Consume (HPS.CircleKit in_kit)

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

Param in_kit: The source CircleKit to consume.

override void Dispose ()

override bool Empty ()

Indicates whether this CircleKit has any values set on it.

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

bool Equals (HPS.CircleKit in_kit)

Check if the source CircleKit is equivalent to this CircleKit.

Param in_kit: The source CircleKit to compare to this CircleKit.
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.CircleKit in_kit)

Copies the source CircleKit into this CircleKit.

Param in_kit: The source CircleKit to copy.

HPS.CircleKit SetCenter (HPS.Point in_center)

Sets the center point for this CircleKit.

Param in_center: The center point for this CircleKit.
Return: A reference to this CircleKit.

HPS.CircleKit SetNormal (HPS.Vector in_normal)

Sets the normal for this CircleKit. This is the normal for the plane in which the circle lies.

Param in_normal: The normal for this CircleKit.
Return: A reference to this 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.

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.CircleKit SetRadius (float in_radius)

Sets the radius for this CircleKit.

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

HPS.CircleKit 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.CircleKit 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.CircleKit 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.CircleKit out_kit)

Copies this CircleKit into the given CircleKit.

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

bool ShowCenter (out HPS.Point out_center)

Shows the center point for this CircleKit.

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

bool ShowNormal (out HPS.Vector out_normal)

Shows the normal for this CircleKit.

Param out_normal: The normal for this CircleKit.
Return: true if a normal 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 this CircleKit.

Param out_radius: The radius for this CircleKit.
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.

HPS.CircleKit UnsetAllUserData ()

Removes all user data from this kit.

Return: A reference to this kit.

HPS.CircleKit UnsetCenter ()

Removes the center point for this CircleKit.

Return: A reference to this CircleKit.

HPS.CircleKit UnsetEverything ()

Removes all settings from the CircleKit.

Return: A reference to this CircleKit.

HPS.CircleKit UnsetNormal ()

Removes the normal for this CircleKit.

Return: A reference to this CircleKit.

HPS.CircleKit UnsetPriority ()

Removes a drawing priority setting.

Return: A reference to this object.

HPS.CircleKit UnsetRadius ()

Removes the radius for this CircleKit.

Return: A reference to this CircleKit.

HPS.CircleKit 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.CircleKit 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.CircleKit a, HPS.CircleKit b)

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