InfiniteLineKey

class HPS.InfiniteLineKey : HPS.GeometryKey

The InfiniteLineKey class is a smart pointer to a database object. It is a handle to an infinite line or ray inserted via SegmentKey.InsertInfiniteLine.

Public Functions

void Consume (HPS.InfiniteLineKit in_kit)

Completely replaces all settings on this InfiniteLineKey with those set on the specified kit and resets the kit.

Param in_kit:The kit from which to get the settings to replace on this InfiniteLineKey.

override void Dispose ()

InfiniteLineKey ()

The default constructor creates an uninitialized InfiniteLineKey object. The Type() function will return Type.None.

InfiniteLineKey (HPS.InfiniteLineKey in_that)

The copy constructor creates an InfiniteLineKey object that shares the underlying smart-pointer of the source InfiniteLineKey.

Param in_that:The source InfiniteLineKey to copy.

InfiniteLineKey (HPS.Key in_that)

This constructor creates an InfiniteLineKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of an InfiniteLine key. Otherwise the copy will fail and the resulting InfiniteLineKey will be invalid.

Param in_that:The source Key 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)

Replace those settings on this InfiniteLineKey with those set on the specified kit.

Param in_kit:The kit from which to get the settings to replace on this InfiniteLineKey.

HPS.InfiniteLineKey SetFirst (HPS.Point in_first)

Sets the first point for this InfiniteLineKey.

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

HPS.InfiniteLineKey SetSecond (HPS.Point in_second)

Sets the second point for this InfiniteLineKey.

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

HPS.InfiniteLineKey SetType (HPS.InfiniteLine.Type in_type)

Sets the type of this InfiniteLineKey.

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

void Show (out HPS.InfiniteLineKit out_kit)

Copy the contents of this InfiniteLineKey into the specified kit.

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

bool ShowFirst (out HPS.Point out_first)

Shows the first point for this InfiniteLineKey.

Param out_first:  The first point for this InfiniteLineKey. Return:true if a first point was set, false otherwise.

bool ShowSecond (out HPS.Point out_second)

Shows the second point for this InfiniteLineKey.

Param out_second:  The second point for this InfiniteLineKey. Return:true if a second point was set, false otherwise.

bool ShowType (out HPS.InfiniteLine.Type out_type)

Shows the type of this InfiniteLineKey.

Param out_type:The type of this InfiniteLineKey. Return:true if a type was set, false otherwise.