InfiniteLineKit

class HPS.InfiniteLineKit : public HPS.Kit 

The InfiniteLineKit class is a user space object. It is a kit analog to an InfiniteLineKey.

Public Functions

void Consume (HPS.InfiniteLineKit in_kit)

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

Param in_kit: The source InfiniteLineKit to consume.

override void Dispose ()

override bool Empty ()

Indicates whether this InfiniteLineKit has any values set on it.

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

bool Equals (HPS.InfiniteLineKit in_kit)

Check if the source InfiniteLineKit is equivalent to this InfiniteLineKit.

Param in_kit: The source InfiniteLineKit to compare to this InfiniteLineKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

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

InfiniteLineKit (HPS.InfiniteLineKit in_kit)

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

Param in_kit: The source InfiniteLineKit to copy.

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.InfiniteLineKit in_kit)

Copies the source InfiniteLineKit into this InfiniteLineKit.

Param in_kit: The source InfiniteLineKit to copy.

HPS.InfiniteLineKit SetFirst (HPS.Point in_first)

Sets the first point for this InfiniteLineKit.

Param in_first: The first point for this InfiniteLineKit. If the type is InfiniteLine.Type.Ray, this will be the point at which the ray starts.
Return: A reference to this InfiniteLineKit.

HPS.InfiniteLineKit SetPriority (int in_priority)

Assigns a specific drawing priority value to the InfiniteLineKit. 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.InfiniteLineKit SetSecond (HPS.Point in_second)

Sets the second point for this InfiniteLineKit.

Param in_second: The second point for this InfiniteLineKit. If the type is InfiniteLine.Type.Ray, this will be the point through which the ray passes.
Return: A reference to this InfiniteLineKit.

HPS.InfiniteLineKit SetType (HPS.InfiniteLine.Type in_type)

Sets the type of this InfiniteLineKit.

Param in_type: The type of this InfiniteLineKit.
Return: A reference to this InfiniteLineKit.

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

Copies this InfiniteLineKit into the given InfiniteLineKit.

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

bool ShowFirst (out HPS.Point out_first)

Shows the first point for this InfiniteLineKit.

Param out_first: The first point for this InfiniteLineKit.
Return: true if a first 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 ShowSecond (out HPS.Point out_second)

Shows the second point for this InfiniteLineKit.