Show_Polyline

Functions

void DShow_Polyline (HC_KEY key, int *count, HC_DPOINT *points)
 Similar to Show_Polyline(), but returns double-precision data. More...
 
void DShow_Polyline (HC_KEY key, int *count, HCD_POINT *points)
 Similar to Show_Polyline(), but returns double-precision values. More...
 
void Show_Partial_Polyline (HC_KEY key, int offset, int request, HC_POINT *points)
 Returns a portion of the vector of points along a given polyline, as referenced by a key. More...
 
void Show_Polyline (HC_KEY key, int *count, HC_POINT *points)
 Returns the vector of points along the polyline, as referenced by a key. More...
 
void Show_Polyline_Count (HC_KEY key, int *count)
 Finds the number of points in a given polyline. This is useful in determining the size of the data structure that must hold points More...
 

Detailed Description

Function Documentation

◆ DShow_Polyline() [1/2]

void DShow_Polyline ( HC_KEY  key,
int *  count,
HC_DPOINT *  points 
)

Similar to Show_Polyline(), but returns double-precision data.

Parameters
key- Unique numeric identifier pointing to a polyline 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 polyline. (A simple N x 3 array may also be used.) Returned to user. Passed by reference always.

◆ DShow_Polyline() [2/2]

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

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

Parameters
key- Unique numeric identifier pointing to a polyline 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_Polyline().

◆ Show_Partial_Polyline()

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

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

Parameters
key- Unique numeric identifier pointing to a polyline in the database.
offset- Starting point to be returned in points. The first point in the polyline 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 polyline. (A simple N x 3 array may also be used.) Returned to user. Passed by reference always.

DETAILS

No additional details. See Show_Polyline()

◆ Show_Polyline()

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

Returns the vector of points along the polyline, as referenced by a key.

Parameters
key- Unique numeric identifier pointing to a polyline 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 polyline. (A simple N x 3 array may also be used.) Returned to user. Passed by reference always.

DETAILS

Show_Polyline finds the coordinates of the points along the edge of the polyline in the database that correspond to the given key. You could use this function, for example, to compute the length of a polyline selected by the user. The key for the polyline might come from Show_Selection_Element() or Find_Contents(), or it might have been saved by your program when the polyline was created (via Insert_Polyline() ).
To aid in the allocation of a data structure large enough to receive the array, you can call Show_Polyline_Count() first, which just returns the number of points in the polyline.
Show_Partial_Polyline() is useful when you want to look at just one or a few points of the polyline.

NOTES

If the polyline was created using a negative value for count, Show_Polyline() will return a negative value.

RESTRICTIONS

See also
Show_Selection_Element, Insert_Polyline, Get_Selection, Begin_Contents_Search, Compute_Coordinates.

◆ Show_Polyline_Count()

void Show_Polyline_Count ( HC_KEY  key,
int *  count 
)

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

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

DETAILS

No additional details. See Show_Polyline()