Brief Index      Full Index      Events Index      I.M. Reference

Show_Clip_Region


Functions

void Show_Clip_Region (int *loopCount, int *loopSizeArray, HC_POINT *points, char *options)
void DShow_Clip_Region (int *loopCount, int *loopSizeArray, HC_DPOINT *points, char *options)
void Show_Clip_Region_Size (int *loopCount, int *clipSizeArray, char *options)
void PShow_Net_Clip_Region (int count, const HC_KEY *keys, int *loops, int *lengths, HC_POINT *points, char *spec)
int PShow_Net_Clip_Region_Size (int count, const HC_KEY *keys, int *loops, int *total, char *spec)

Function Documentation

void Show_Clip_Region ( int *  loopCount,
int *  loopSizeArray,
HC_POINT *  points,
char *  options 
)

Show the clip region settings on the currently open segment.

Parameters:
loopCount - Number of clip regions defined in the points array. This will be the size of the array loopSizeArray. Returned to caller. Passed by reference always.
loopSizeArray - An array of integers defining the number of points in each clip region. The sum of these values will be the size of the points array. Returned to caller. Passed by reference always.
points - The array of points which are used to define the clip region. Returned to caller. Passed by reference always.
options - Options that were used to define that clip region. Returned to caller. Passed by reference always.

DETAILS

Show_Clip_Region() allows you to query the clip region settings on the currently open segment. Visualize only supports one polygonal clip region per segment. Thus, loopCount will always be returned as 1. The contents of loopSizeArray will be returned as a single integer, although this will change as the API is scaled.

The function signature is designed in this way to allow for the future support of complex clip regions.

NOTES

RESTRICTIONS

There can only be one clip region defined in a single segment, so loopCount will always be '1'.

See also:
Set_Polygonal_Clip_Region

void DShow_Clip_Region ( int *  loopCount,
int *  loopSizeArray,
HC_DPOINT *  points,
char *  options 
)

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

Parameters:
loopCount - Number of clip regions defined in the points array. This will be the size of the array loopSizeArray. Returned to caller. Passed by reference always.
loopSizeArray - An array of integers defining the number of points in each clip region. The sum of these values will be the size of the points array. Returned to caller. Passed by reference always.
points - The array of points which are used to define the clip region. Returned to caller. Passed by reference always.
options - Options that were used to define that clip region. Returned to caller. Passed by reference always.

void Show_Clip_Region_Size ( int *  loopCount,
int *  loopSizeArray,
char *  options 
)

Finds the size of a clip region. Use this function to determine the size of the data structure that must hold points in preparation for calling ShowClipRegion.

Parameters:
loopCount - Number of clip regions defined in the points array. This will be the size of the array loopSizeArray. Returned to caller. Passed by reference always.
loopSizeArray - An array of integers defining the number of points in each clip region. The sum of these values will be the size of the points array. Returned to caller. Passed by reference always.
options - Options that were used to define that clip region. Returned to caller. Passed by reference always.

DETAILS

Visualize currently only supports one clip region per segment, so loopCount will always be returned as 1. Likewise, loopSizeArray will be returned as a single integer.

See also:
See Show_Clip_Region()

void PShow_Net_Clip_Region ( int  count,
const HC_KEY *  keys,
int *  loops,
int *  lengths,
HC_POINT *  points,
char *  spec 
)

Similar to Show_Clip_Region(), but returns the net effective value of the attribute(s) along a path of segments specified by an array of HC_KEY's.

Parameters:
count - Number of keys in the keys array
keys - The list of keys starting with the owning segment and following all the way back to the root segment or other desired segment.
loops - Number of clip regions defined in the points array. This will be the size of the array clipSizeArray. Returned to caller. Passed by reference always
length - An array of integers defining the number of points in each clip region. The sum of these values will be the size of the points array.
points - The array of points which are used to define the clip region. Returned to caller. Passed by reference always
spec - Options that were used to define that clip region. Returned to caller. Passed by reference always

DETAILS

As with all PShow_Net_* routines, pathkeys[0] represents the lowest (a.k.a the "most local" or "leaf"), and pathkeys[keycount-1] represents the highest segment. If the path is incomplete, missing segments are filled in if possible. Missing segments must be part of the same direct ancestry in order to be filled in. If the desired path contains an include link, the shortest unambiguous set of pathkeys would be [leaf, includelink, root], where includelink is the return value from Include_Segment().

By default, HOOPS will determine the Net attribute from the last specified key all the way to the root. If you add -1 at the end of the array, the PShow_Net routines will not proceed beyond the end of the last specified key.

A return value of 0 indicates no clip region was found. A value of 1 indicates a single-precision clip region was found. A value of 2 indicates a double-precision clip region was found.

For other details, see Show_Clip_Region()

int PShow_Net_Clip_Region_Size ( int  count,
const HC_KEY *  keys,
int *  loops,
int *  total,
char *  spec 
)

Similar to Show_Clip_Region_Size(), but returns the net effective value of the attribute(s) along a path of segments specified by an array of HC_KEY's.

Parameters:
count - Number of keys in the keys array
keys - The list of keys starting with the owning segment and following all the way back to the root segment or other desired segment.
loops - Number of clip regions defined in the points array. This will be the size of the array clipSizeArray. Returned to caller. Passed by reference always
total - An array of integers defining the number of points in each clip region. The sum of these values will be the size of the points array.
spec - Options that were used to define that clip region. Returned to caller. Passed by reference always

DETAILS

As with all PShow_Net_* routines, pathkeys[0] represents the lowest (a.k.a the "most local" or "leaf"), and pathkeys[keycount-1] represents the highest segment. If the path is incomplete, missing segments are filled in if possible. Missing segments must be part of the same direct ancestry in order to be filled in. If the desired path contains an include link, the shortest unambiguous set of pathkeys would be [leaf, includelink, root], where includelink is the return value from Include_Segment().

By default, HOOPS will determine the Net attribute from the last specified key all the way to the root. If you add -1 at the end of the array, the PShow_Net routines will not proceed beyond the end of the last specified key.

For other details, see Show_Clip_Region_Size()

Brief Index      Full Index      Events Index      I.M. Reference