Brief Index      Full Index      Events Index      I.M. Reference

Show_Polygon

Functions

void Show_Polygon (HC_KEY key, int *count, HC_POINT *points)
void DShow_Polygon (HC_KEY key, int *count, HC_DPOINT *points)
void Show_Polygon_Count (HC_KEY key, int *count)
void Show_Partial_Polygon (HC_KEY key, int offset, int request, HC_POINT *points)
void DShow_Polygon (HC_KEY key, int *count, HCD_POINT *points)

Function Documentation

void Show_Polygon ( HC_KEY  key,
int *  count,
HC_POINT *  points 
)

Returns the vector of points along the edge of the polygon referenced by a key.

Parameters:
key- Unique numeric identifier pointing to a polygon in the database.
count- Number of valid points in points. Returned to user. Passed by reference always.
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.) Returned to user. Passed by reference always.

DETAILS

Show_Polygon finds the coordinates of the points along the edge of the polygon in the database corresponding to the given key. You could use this ability, for example, to extract the data necessary to extrude a polygon selected by the user. The key for the polygon might come from Show_Selection_Element() or Find_Contents, or it might have been saved by your program when the polygon was created (via Insert_Polygon() ).

To aid in the allocation of a data structure large enough to receive the array, you may wish to call Show_Polygon_Count first which just returns the number of points in the polygon.

Show_Partial_Polygon() is useful when you want to look at just one or a few points of the polygon.

NOTE

If you originally specified the last point as identical to your first point, Insert_Polygon() will have trimmed it off as redundant.

NOTES

RESTRICTIONS

See also:
Show_Selection_Element, Insert_Polygon, Get_Selection, Begin_Contents_Search, Compute_Coordinates.
void DShow_Polygon ( HC_KEY  key,
int *  count,
HC_DPOINT *  points 
)

Similar to Show_Polygon(), but returns double-precision values.

Parameters:
key- Unique numeric identifier pointing to a polygon in the database.
count- Number of valid points in points. Returned to user. Passed by reference always.
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.) Returned to user. Passed by reference always.
void Show_Polygon_Count ( HC_KEY  key,
int *  count 
)

Finds the number of points in a given polygon. This is useful in determining the size of the data structure that must hold points

Parameters:
key- Unique numeric identifier pointing to a polygon in the database.
count- Number of valid points in points. Returned to user. Passed by reference always.

DETAILS

No additional details. See Show_Polygon()

void Show_Partial_Polygon ( HC_KEY  key,
int  offset,
int  request,
HC_POINT *  points 
)

Returns a portion of the vector of points along the edge of a given polygon, as referenced by a key.

Parameters:
key- Unique numeric identifier pointing to a polygon in the database.
offset- Starting point to be returned in points. The first point in the polygon is at offset0.
request- Number of points requested by this call.
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.) Returned to user. Passed by reference always.

DETAILS

No additional details. See Show_Polygon()

void DShow_Polygon ( HC_KEY  key,
int *  count,
HCD_POINT *  points 
)

Similar to Show_Polygon(), but operates on double-precision data.

Parameters:
key- Unique numeric identifier pointing to a polygon in the database.
count- Number of valid points in points. Returned to user. Passed by reference always.
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.) Returned to user. Passed by reference always.

DETAILS

No additional details. See Show_Polygon().

Brief Index      Full Index      Events Index      I.M. Reference