Brief Index      Full Index      I.M. Reference

Insert_Polyline


Functions

void Insert_Polyline (int count, const HC_POINT *points)
HC_KEY KInsert_Polyline (int count, const HC_POINT *points)
void QInsert_Polyline (const char *segment, int count, const HC_POINT *points)
HC_KEY QKInsert_Polyline (const char *segment, int count, const HC_POINT *points)
void DInsert_Polyline (int count, const HCD_POINT *points)
HC_KEY DKInsert_Polyline (int count, const HCD_POINT *points)
void DQInsert_Polyline (const char *segment, int count, const HCD_POINT *points)
HC_KEY DQKInsert_Polyline (const char *segment, int count, const HCD_POINT *points)

Function Documentation

void Insert_Polyline ( int  count,
const HC_POINT *  points 
)

Generates a connected chain of line segments. Can be used to approximate arcs.

Parameters:
count - Number of valid points in points.
points - Vector of x-y-z triplets for the coordinates along the edge of the Polygon. (A simple N x 3 array may also be used.) Passed by reference always.

DETAILS

Insert_Polyline() is the most basic way of inserting a connected sequence of lines into a scene.

The visual difference between lines created with Insert_Polyline() and those created using a series of calls to Insert_Line() is just that the Line Pattern, if any, flows smoothly and without interruption around corners.

Insert_Polyline() does require all the coordinates to be supplied. If the coordinates are not known or are being supplied from a construction operation, use Restart_Ink() and Insert_Ink(). The final result will be the same.

Changing the values of the Line Color, Line Weight, and Line Pattern attributes can vary the way polylines are depicted.

Users can create a disjointed polyline by supplying an even, negative value for count. This will cause the polyline to appear as a collection of 2-point line segments.

NOTES

If you only work in two dimensions, specify all the z coordinates as zero. (The system notices and optimize the drawing.)

There is no requirement for the points in a polyline all to be coplanar.

In most cases line patterns will flow smoothly around the corners of a polyline.

If there is an error the KInsert routine returns a -1.

RESTRICTIONS

See also:
Insert_Polygon, Insert_Line, Insert_Ink, Insert_Shell, Insert_Mesh, Insert_Circular_Arc, Insert_Elliptical_Arc, Set_Line_Pattern, Set_Color, Set_Line_Weight, Set_Visibility, Renumber_Key.

HC_KEY KInsert_Polyline ( int  count,
const HC_POINT *  points 
)

Similar to Insert_Polyline(), but returns an HC_KEY to the object.

Parameters:
count - Number of valid points in points.
points - Vector of x-y-z triplets for the coordinates along the edge of the Polygon. (A simple N x 3 array may also be used.) Passed by reference always.
Returns:
key

DETAILS

No additional details. See Insert_Polyline()

void QInsert_Polyline ( const char *  segment,
int  count,
const HC_POINT *  points 
)

Similar to Insert_Polyline(), but operates on a given segment rather than the currently open one.

Parameters:
segment - Segment(s) to be inserted into, if other than the currently- open segment.
count - Number of valid points in points.
points - Vector of x-y-z triplets for the coordinates along the edge of the Polygon. (A simple N x 3 array may also be used.) Passed by reference always.

DETAILS

No additional details. See Insert_Polyline()

HC_KEY QKInsert_Polyline ( const char *  segment,
int  count,
const HC_POINT *  points 
)

Similar to Insert_Polyline(), but operates on a given segment and returns an HC_KEY to the object.

Parameters:
segment - Segment(s) to be inserted into, if other than the currently- open segment.
count - Number of valid points in points.
points - Vector of x-y-z triplets for the coordinates along the edge of the Polygon. (A simple N x 3 array may also be used.) Passed by reference always.
Returns:
key

DETAILS

No additional details. See Insert_Polyline()

void DInsert_Polyline ( int  count,
const HCD_POINT *  points 
)

Similar to Insert_Polyline() but accepts and/or returns double-precision values. This command can only be used when the application source includes the HOOPS double-precision header, hcd.h.

Parameters:
count - Number of valid points in points.
points - Vector of x-y-z triplets for the coordinates along the edge of the Polygon. (A simple N x 3 array may also be used.) Passed by reference always.

DETAILS

No additional details. See Insert_Polyline().

HC_KEY DKInsert_Polyline ( int  count,
const HCD_POINT *  points 
)

Similar to DInsert_Polyline(), but returns an HC_KEY to the object.

Parameters:
count - Number of valid points in points.
points - Vector of x-y-z triplets for the coordinates along the edge of the Polygon. (A simple N x 3 array may also be used.) Passed by reference always.
Returns:
key

DETAILS

No additional details. See Insert_Polyline()

void DQInsert_Polyline ( const char *  segment,
int  count,
const HCD_POINT *  points 
)

Similar to DInsert_Polyline(), but operates on a given segment rather than the currently open one.

Parameters:
segment - Segment(s) to be inserted into, if other than the currently- open segment.
count - Number of valid points in points.
points - Vector of x-y-z triplets for the coordinates along the edge of the Polygon. (A simple N x 3 array may also be used.) Passed by reference always.

DETAILS

No additional details. See Insert_Polyline()

HC_KEY DQKInsert_Polyline ( const char *  segment,
int  count,
const HCD_POINT *  points 
)

Similar to DInsert_Polyline(), but operates on a given segment and returns an HC_KEY to the object.

Parameters:
segment - Segment(s) to be inserted into, if other than the currently- open segment.
count - Number of valid points in points.
points - Vector of x-y-z triplets for the coordinates along the edge of the Polygon. (A simple N x 3 array may also be used.) Passed by reference always.
Returns:
key

DETAILS

No additional details. See Insert_Polyline()

Main Index
Brief Index      Full Index      I.M. Functions