CircularWedgeKey

class HPS.CircularWedgeKey : public HPS.GeometryKey

The CircularWedgeKey class is a smart pointer to a database object. It is a handle to a circular wedge inserted via SegmentKey.InsertCircularWedge. A circular wedge has face geometry contained within the boundary edges of the circular wedge. The visualization of the wedge will be determined by attribute settings affecting faces and edges.

Public Functions

CircularWedgeKey ()

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

CircularWedgeKey (HPS.CircularWedgeKey in_that)

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

Param in_that

The source CircularWedgeKey to copy.

CircularWedgeKey (HPS.Key in_that)

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

void Consume (HPS.CircularWedgeKit in_kit)

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

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.CircularWedgeKit in_kit)

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

Param in_kit

The kit from which to get the settings to replace on this CircularWedgeKey.

HPS.CircularWedgeKey SetEnd (HPS.Point in_end)

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

Param in_end

The end point for this CircularWedgeKey.

Return

A reference to this CircularWedgeKey.

HPS.CircularWedgeKey SetMiddle (HPS.Point in_middle)

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

Param in_middle

The middle point for this CircularWedgeKey.

Return

A reference to this CircularWedgeKey.

HPS.CircularWedgeKey SetStart (HPS.Point in_start)

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

Param in_start

The start point for this CircularWedgeKey.

Return

A reference to this CircularWedgeKey.

void Show (out HPS.CircularWedgeKit out_kit)

Copy the contents of this CircularWedgeKey into the specified kit.

Param out_kit

The kit to populate with the contents of this CircularWedgeKey.

bool ShowEnd (out HPS.Point out_end)

Shows the end point for this CircularWedgeKey.

Param out_end

The end point for this CircularWedgeKey.

Return

true if an end point was set, false otherwise.

bool ShowMiddle (out HPS.Point out_middle)

Shows the middle point for this CircularWedgeKey.

Param out_middle

The middle point for this CircularWedgeKey.

Return

true if a middle point was set, false otherwise.

bool ShowStart (out HPS.Point out_start)

Shows the start point for this CircularWedgeKey.

Param out_start

The start point for this CircularWedgeKey.

Return

true if a start point was set, false otherwise.