CircularArcKit

class HPS.CircularArcKit : public HPS.Kit 

The CircularArcKit class is a user space object. It is a kit analog to a CircularArcKey.

Public Functions

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

CircularArcKit (HPS.CircularArcKit in_kit)

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

Param in_kit: The source CircularArcKit to copy.

void Consume (HPS.CircularArcKit in_kit)

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

Param in_kit: The source LineKit to consume.

override void Dispose ()

override bool Empty ()

Indicates whether this CircularArcKit has any values set on it.

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

bool Equals (HPS.CircularArcKit in_kit)

Check if the source CircularArcKit is equivalent to this CircularArcKit.

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

Copies the source CircularArcKit into this CircularArcKit.

Param in_kit: The source CircularArcKit to copy.

HPS.CircularArcKit SetEnd (HPS.Point in_end)

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

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

HPS.CircularArcKit SetMiddle (HPS.Point in_middle)

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

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

HPS.CircularArcKit SetPriority (int in_priority)

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

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

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

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

Copies this CircularArcKit into the given CircularArcKit.

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

bool ShowEnd (out HPS.Point out_end)

Shows the end point for this CircularArcKit.

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

bool ShowMiddle (out HPS.Point out_middle)

Shows the middle point for this CircularArcKit.

Param out_middle: The middle point for this CircularArcKit.
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 CircularArcKit.