EllipseKit

class HPS.EllipseKit : public HPS.Kit 

The EllipseKit class is a user space object. It is the kit analog to an EllipseKey.

Public Functions

void Consume (HPS.EllipseKit in_kit)

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

Param in_kit: The source EllipseKit to consume.

override void Dispose ()

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

EllipseKit (HPS.EllipseKit in_kit)

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

Param in_kit: The source EllipseKit to copy.

override bool Empty ()

Indicates whether this EllipseKit has any values set on it.

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

bool Equals (HPS.EllipseKit in_kit)

Check if the source EllipseKit is equivalent to this EllipseKit.

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

Copies the source EllipseKit into this EllipseKit.

Param in_kit: The source EllipseKit to copy.

HPS.EllipseKit SetCenter (HPS.Point in_center)

Sets the center point for the ellipse.

Param in_center: The center point for the ellipse.
Return: A reference to this EllipseKit.

HPS.EllipseKit SetMajor (HPS.Point in_major)

Sets the intersection point of the major axis and the ellipse.

Param in_major: The intersection point of the major axis and the ellipse.
Return: A reference to this EllipseKit.

HPS.EllipseKit SetMinor (HPS.Point in_minor)

Sets the intersection point of the minor axis and the ellipse.

Param in_minor: The intersection point of the minor axis and the ellipse.
Return: A reference to this EllipseKit.

HPS.EllipseKit SetPriority (int in_priority)

Assigns a specific drawing priority value to the EllipseKit. 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.EllipseKit 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.EllipseKit 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.EllipseKit 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.EllipseKit out_kit)

Copies this EllipseKit into the given EllipseKit.

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

bool ShowCenter (out HPS.Point out_center)

Shows the center point for the ellipse.

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

bool ShowMajor (out HPS.Point out_major)

Shows the intersection point of the major axis and the ellipse.

Param out_major: The intersection point of the major axis and the ellipse.
Return: true if an intersection point with the major axis was set, false otherwise.

bool ShowMinor (out HPS.Point out_minor)

Shows the intersection point of the minor axis and the ellipse.

Param out_minor: The intersection point of the minor axis and the ellipse.
Return: true if an intersection point with the minor axis 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 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.EllipseKit UnsetAllUserData ()

Removes all user data from this kit.

Return: A reference to this kit.

HPS.EllipseKit UnsetCenter ()

Removes the center point for the ellipse.

Return: A reference to this EllipseKit.

HPS.EllipseKit UnsetEverything ()

Removes all settings from this EllipseKit.

Return: A reference to this EllipseKit.

HPS.EllipseKit UnsetMajor ()

Removes the intersection point of the major axis and the ellipse.

Return: A reference to this EllipseKit.

HPS.EllipseKit UnsetMinor ()

Removes the intersection point of the minor axis and the ellipse.

Return: A reference to this EllipseKit.

HPS.EllipseKit UnsetPriority ()

Removes a drawing priority setting.

Return: A reference to this object.

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

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