CircularWedgeKit

class HPS.CircularWedgeKit : public HPS.Kit 

The CircularWedgeKit class is a user space object. It is a kit analog to a CircularWedgeKey.

Public Functions

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

CircularWedgeKit (HPS.CircularWedgeKit in_kit)

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

Param in_kit: The source CircularWedgeKit to copy.

void Consume (HPS.CircularWedgeKit in_kit)

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

Param in_kit: The source CircularWedgeKit to consume.

override void Dispose ()

override bool Empty ()

Indicates whether this CircularWedgeKit has any values set on it.

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

bool Equals (HPS.CircularWedgeKit in_kit)

Check if the source CircularWedgeKit is equivalent to this CircularWedgeKit.

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

Copies the source CircularWedgeKit into this CircularWedgeKit.

Param in_kit: The source CircularWedgeKit to copy.

HPS.CircularWedgeKit SetEnd (HPS.Point in_end)

Sets the end point for this CircularWedgeKit. This is the point on the circumference of the circle at which the circular wedge ends.

Param in_end: The end point for this CircularWedgeKit.
Return: A reference to this CircularWedgeKit.

HPS.CircularWedgeKit SetMiddle (HPS.Point in_middle)

Sets the middle point for this CircularWedgeKit. This is a point on the circumference of the circle between the start and end points for the circular wedge.

Param in_middle: The middle point for this CircularWedgeKit.
Return: A reference to this CircularWedgeKit.

HPS.CircularWedgeKit SetPriority (int in_priority)

Assigns a specific drawing priority value to the CircularWedgeKit. 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.CircularWedgeKit SetStart (HPS.Point in_start)

Sets the start point for this CircularWedgeKit. This is the point on the circumference of the circle at which the circular wedge starts.

Param in_start: The start point for this CircularWedgeKit.
Return: A reference to this CircularWedgeKit.

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

Copies this CircularWedgeKit into the given CircularWedgeKit.

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

bool ShowEnd (out HPS.Point out_end)

Shows the end point for this CircularWedgeKit.

Param out_end: The end point for this CircularWedgeKit.
Return: true if an end point was set, false otherwise.

bool ShowMiddle (out HPS.Point out_middle)

Shows the middle point for this CircularWedgeKit.

Param out_middle: The middle point for this CircularWedgeKit.
Return: true if a middle 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 ShowStart (out HPS.Point out_start)

Shows the start point for this CircularWedgeKit.