EllipticalArcKit

class HPS.EllipticalArcKit : public HPS.Kit 

The EllipticalArcKit class is a user space object. It is the kit analog to an EllipticalArcKey.

Public Functions

void Consume (HPS.EllipticalArcKit in_kit)

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

Param in_kit: The source EllipticalArcKit to consume.

override void Dispose ()

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

EllipticalArcKit (HPS.EllipticalArcKit in_kit)

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

Param in_kit: The source EllipticalArcKit to copy.

override bool Empty ()

Indicates whether this EllipticalArcKit has any values set on it.

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

bool Equals (HPS.EllipticalArcKit in_kit)

Check if the source EllipticalArcKit is equivalent to this EllipticalArcKit.

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

Copies the source EllipticalArcKit into this EllipticalArcKit.

Param in_kit: The source EllipticalArcKit to copy.

HPS.EllipticalArcKit SetCenter (HPS.Point in_center)

Sets the center point for the ellipse used to define the elliptical arc.

Param in_center: The center point for the ellipse used to define the elliptical arc.
Return: A reference to this EllipticalArcKit.

HPS.EllipticalArcKit SetEnd (float in_end)

Sets the normalized parametric value on the ellipse at which the elliptical arc ends. The value should be in the range [0.0f,1.0f] and be larger than the start value. It is defined such that 0.0f is the point where the major axis intersects the ellipse, and as the value increases it passes through the point at which the minor axis intersects the ellipse (0.25f), and that 1.0f maps to the same point as 0.0f.

Param in_end: The normalized parametric value on the ellipse at which the elliptical arc ends. This value should be in the range [0.0f,1.0f] and be larger than the start value.
Return: A reference to this EllipticalArcKit.

HPS.EllipticalArcKit SetMajor (HPS.Point in_major)

Sets the intersection point of the major axis and the ellipse used to define the elliptical arc.

Param in_major: The intersection point of the major axis and the ellipse used to define the elliptical arc.
Return: A reference to this EllipticalArcKit.

HPS.EllipticalArcKit SetMinor (HPS.Point in_minor)

Sets the intersection point of the minor axis and the ellipse used to define the elliptical arc.

Param in_minor: The intersection point of the minor axis and the ellipse used to define the elliptical arc.
Return: A reference to this EllipticalArcKit.

HPS.EllipticalArcKit SetPriority (int in_priority)

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

Sets the normalized parametric value on the ellipse at which the elliptical arc starts. The value should be in the range [0.0f,1.0f] and be smaller than the end value. It is defined such that 0.0f is the point where the major axis intersects the ellipse, and as the value increases it passes through the point at which the minor axis intersects the ellipse (0.25f), and that 1.0f maps to the same point as 0.0f.

Param in_start: The normalized parametric value on the ellipse at which the elliptical arc starts. This value should be in the range [0.0f,1.0f] and be smaller than the end value.
Return: A reference to this EllipticalArcKit.

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

Copies this EllipticalArcKit into the given EllipticalArcKit.

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

bool ShowCenter (out HPS.Point out_center)

Shows the center point for the ellipse used to define the elliptical arc.

Param out_center: The center point for the ellipse used to define the elliptical arc.
Return: true if a center was set, false otherwise.

bool ShowEnd (out float out_end)

Shows the normalized parametric value on the ellipse at which the elliptical arc ends.

Param out_end: The normalized parametric value on the ellipse at which the elliptical arc ends.
Return: true if a normalized parametric end value was set, false otherwise.

bool ShowMajor (out HPS.Point out_major)

Shows the intersection point of the major axis and the ellipse used to define the elliptical arc.

Param out_major: The intersection point of the major axis and the ellipse used to define the elliptical arc.
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 used to define the elliptical arc.

Param out_minor: The intersection point of the minor axis and the ellipse used to define the elliptical arc.
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 ShowStart (out float out_start)

Shows the normalized parametric value on the ellipse at which the elliptical arc starts.

Param out_start: The normalized parametric value on the ellipse at which the elliptical arc starts.
Return: true if a normalized parametric start value was set, false otherwise.

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