Brief Index      Full Index      I.M. Reference

Show_Clip_Region


Functions

void Show_Clip_Region (int *clipCount, int *clipSizeArray, HC_POINT *points, char *options)
void Show_Clip_Region_Size (int *clipCount, int *clipSizeArray, char *options)
void Show_Net_Clip_Region_Size (int *clipCount, int *clipSizeArray, char *options)
void Show_Net_Clip_Region (int *clipCount, int *clipSizeArray, HC_POINT *points, char *options)
void QShow_Clip_Region (const char *segment, int *clipCount, int *clipSizeArray, HC_POINT *points, char *options)
void QShow_Clip_Region_Size (const char *segment, int *clipCount, int *clipSizeArray, char *options)
void QShow_Net_Clip_Region (const char *segment, int *clipCount, int *clipSizeArray, HC_POINT *points, char *options)
void QShow_Net_Clip_Region_Size (const char *segment, int *clipCount, int *clipSizeArray, char *options)
void PShow_Net_Clip_Region (int keycount, HC_KEY *pathkeys, int *clipCount, int *clipSizeArray, HC_POINT *points, char *options)
void PShow_Net_Clip_Region_Size (int keycount, HC_KEY *pathkeys, int *clipCount, int *clipSizeArray, char *options)

Function Documentation

void Show_Clip_Region ( int *  clipCount,
int *  clipSizeArray,
HC_POINT *  points,
char *  options 
)

Show the clip region settings on the currently open segment.

Parameters:
clipCount - 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
clipSizeArray - an array of integers defining the number of points in each clip region. The sum of these values will
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 a specified segment. The API is allowing for the future support of multiple clip regions on the same segment and so you must provide an index value to access a specific clip. The libraries currently only support 1 clip region per segment and so you should use the index value of '0' currently.

NOTES

RESTRICTIONS

There can only be one clip region defined in a single region and so clipCount will always be '1'.

See also:
Set_Polygonal_Clip_Region

void Show_Clip_Region_Size ( int *  clipCount,
int *  clipSizeArray,
char *  options 
)

Finds the size of a clip region. This is useful in determining the size of the data structure that must hold points.

Parameters:
clipCount - 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
clipSizeArray - an array of integers defining the number of points in each clip region. The sum of these values will
options - Options that were used to define that clip region. Returned to caller. Passed by reference always

DETAILS

No additional details. See Show_Clip_Region()

void Show_Net_Clip_Region_Size ( int *  clipCount,
int *  clipSizeArray,
char *  options 
)

Similar to Show_Clip_Region(), but returns the net effective value of the attribute(s) in the currently open segment.

Parameters:
clipCount - 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
clipSizeArray - an array of integers defining the number of points in each clip region. The sum of these values will
options - Options that were used to define that clip region. Returned to caller. Passed by reference always

DETAILS

No additional details. See Show_Clip_Region()

void Show_Net_Clip_Region ( int *  clipCount,
int *  clipSizeArray,
HC_POINT *  points,
char *  options 
)

Similar to Show_Clip_Region(), but returns the net effective value of the attribute(s) in the currently open segment.

Parameters:
clipCount - 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
clipSizeArray - an array of integers defining the number of points in each clip region. The sum of these values will
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

No additional details. See Show_Clip_Region()

void QShow_Clip_Region ( const char *  segment,
int *  clipCount,
int *  clipSizeArray,
HC_POINT *  points,
char *  options 
)

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

Parameters:
segment - Name of the segment to be queried
clipCount - 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
clipSizeArray - an array of integers defining the number of points in each clip region. The sum of these values will
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

No additional details. See Show_Clip_Region()

void QShow_Clip_Region_Size ( const char *  segment,
int *  clipCount,
int *  clipSizeArray,
char *  options 
)

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

Parameters:
segment - Name of the segment to be queried
clipCount - 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
clipSizeArray - an array of integers defining the number of points in each clip region. The sum of these values will
options - Options that were used to define that clip region. Returned to caller. Passed by reference always

DETAILS

No additional details. See Show_Clip_Region()

void QShow_Net_Clip_Region ( const char *  segment,
int *  clipCount,
int *  clipSizeArray,
HC_POINT *  points,
char *  options 
)

Similar to Show_Clip_Region(), but returns the net effective value of the attribute(s) in a given segment, rather than the currently open one.

Parameters:
segment - Name of the segment to be queried
clipCount - 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
clipSizeArray - an array of integers defining the number of points in each clip region. The sum of these values will
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

No additional details. See Show_Clip_Region()

void QShow_Net_Clip_Region_Size ( const char *  segment,
int *  clipCount,
int *  clipSizeArray,
char *  options 
)

Similar to Show_Clip_Region(), but returns the net effective value of the attribute(s) in a given segment, rather than the currently open one.

Parameters:
segment - Name of the segment to be queried
clipCount - 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
clipSizeArray - an array of integers defining the number of points in each clip region. The sum of these values will
options - Options that were used to define that clip region. Returned to caller. Passed by reference always

DETAILS

No additional details. See Show_Clip_Region()

void PShow_Net_Clip_Region ( int  keycount,
HC_KEY *  pathkeys,
int *  clipCount,
int *  clipSizeArray,
HC_POINT *  points,
char *  options 
)

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:
keycount - number of keys in the keys array
pathkeys - The list of keys starting with the owning segment and following all the way back to the root segment or other desired segment.
clipCount - 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
clipSizeArray - an array of integers defining the number of points in each clip region. The sum of these values will
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

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 KInclude_Segment(). For other details, see Show_Net_Clip_Region()

void PShow_Net_Clip_Region_Size ( int  keycount,
HC_KEY *  pathkeys,
int *  clipCount,
int *  clipSizeArray,
char *  options 
)

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:
keycount - number of keys in the keys array
pathkeys - The list of keys starting with the owning segment and following all the way back to the root segment or other desired segment.
clipCount - 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
clipSizeArray - an array of integers defining the number of points in each clip region. The sum of these values will
options - 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 KInclude_Segment(). For other details, see Show_Net_Clip_Region_Size()

Main Index
Brief Index      Full Index      I.M. Functions