CircularArcKey

class HPS.CircularArcKey : HPS.GeometryKey

The CircularArcKey class is a smart pointer to a database object. It is handle to a circular arc inserted via SegmentKey.InsertCircularArc. A circular arc is the line geometry, as such its visualization will be determined by attributes affecting lines.

Public Functions

CircularArcKey ()

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

CircularArcKey (HPS.CircularArcKey in_that)

The copy constructor creates a CircularArcKey object that shares the underlying smart-pointer of the source CircularArcKey.

Param in_that:The source CircularArcKey to copy.

CircularArcKey (HPS.Key in_that)

This constructor creates a CircularArcKey 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 a CircularArc key. Otherwise the copy will fail and the resulting CircularArcKey will be invalid.

void Consume (HPS.CircularArcKit in_kit)

Completely replaces all settings on this CircularArcKey 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 CircularArcKey.

override void Dispose ()

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)

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

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

HPS.CircularArcKey SetEnd (HPS.Point in_end)

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

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

HPS.CircularArcKey SetMiddle (HPS.Point in_middle)

Sets the middle point for this CircularArcKey. 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 CircularArcKey. Return:A reference to this CircularArcKey.

HPS.CircularArcKey SetStart (HPS.Point in_start)

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

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

void Show (out HPS.CircularArcKit out_kit)

Copy the contents of this CircularArcKey into the specified kit.

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

bool ShowEnd (out HPS.Point out_end)

Shows the end point for this CircularArcKey.

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

bool ShowMiddle (out HPS.Point out_middle)

Shows the middle point for this CircularArcKey.

Param out_middle:  The middle point for this CircularArcKey. Return:true if a middle point was set, false otherwise.

bool ShowStart (out HPS.Point out_start)

Shows the start point for this CircularArcKey.

Param out_start:  The start point for this CircularArcKey. Return:true if a start point was set, false otherwise.