Show_Clip_Region

Functions

int DPShow_Net_Clip_Region (int in_count, const HC_KEY *in_keys, int *out_loops, int *out_lengths, HC_DPOINT *out_points, char *out_spec)
 Like PShow_Net_Clip_Region, but operates on double-precision data. More...
 
int DPShow_Net_Clip_Region_Size (int count, const HC_KEY *keys, int *loops, int *total, char *spec)
 Similar to PShow_Clip_Region_Size(), but operates on double-precision data. More...
 
void DShow_Clip_Region (int *loopCount, int *loopSizeArray, HC_DPOINT *points, char *options)
 Similar to Show_Clip_Region(), but returns double-precision data. More...
 
int PShow_Net_Clip_Region (int in_count, const HC_KEY *in_keys, int *out_loops, int *out_lengths, HC_POINT *out_points, char *out_spec)
 As of version 23.00, returns all the clip regions found on the key path passed to the function. More...
 
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. More...
 
void Show_Clip_Region (int *loopCount, int *loopSizeArray, HC_POINT *points, char *options)
 Show the clip region settings on the currently open segment. More...
 
void Show_Clip_Region_Size (int *loopCount, int *clipSizeArray, 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. More...
 

Detailed Description

Function Documentation

◆ DPShow_Net_Clip_Region()

int DPShow_Net_Clip_Region ( int  in_count,
const HC_KEY *  in_keys,
int *  out_loops,
int *  out_lengths,
HC_DPOINT *  out_points,
char *  out_spec 
)

Like PShow_Net_Clip_Region, but operates on double-precision data.

Parameters
in_count- Number of keys in the keys array.
in_keys- The list of keys starting with the owning segment and following all the way back to the root segment or other desired segment.
out_loops- Number of loops defined in the points array. This will be the size of the array out_lengths. Returned to caller. Passed by reference always
out_lengths- An array of integers defining the number of points in each loop. The sum of the absolute values of these integers will be the size of the out_points array. Please refer to the Details section for an explanation of the positive/negative values.
out_points- The array of points used to define the clip region. Returned to caller. Passed by reference always.
out_spec- Options that were used to define that clip region. Returned to caller. Passed by reference always.
See also
PShow_Net_Clip_Region()

◆ DPShow_Net_Clip_Region_Size()

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

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

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 loops defined in the points array. This will be the size of the array total array. 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
See also
PShow_Clip_Region_Size()

◆ DShow_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 loops 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.

◆ PShow_Net_Clip_Region()

int PShow_Net_Clip_Region ( int  in_count,
const HC_KEY *  in_keys,
int *  out_loops,
int *  out_lengths,
HC_POINT *  out_points,
char *  out_spec 
)

As of version 23.00, returns all the clip regions found on the key path passed to the function.

Parameters
in_count- Number of keys in the keys array.
in_keys- The list of keys starting with the owning segment and following all the way back to the root segment or other desired segment.
out_loops- Number of loops defined in the points array. This will be the size of the array out_lengths. Returned to caller. Passed by reference always
out_lengths- An array of integers defining the number of points in each loop. The sum of the absolute values of these integers will be the size of the out_points array. Please refer to the Details section for an explanation of the positive/negative values.
out_points- The array of points used to define the clip region. Returned to caller. Passed by reference always.
out_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 (i.e., 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 negative integer in the out_lengths array indicates that the loop represented by that integer is part of the clip region represented by the previous integer. In an array with the values [4, -5, 7, -6], the loop represented by the second element (-5) is part of the clip region that also includes the first element (4). When sequential values in the array change from negative to positive, the positive integer represents a new clip region, so in this case, the third element (7) represents a new clip region. Because the value of the fourth element is negative (-6), then that loop is part of the same clip region as the third element (7).

The out_spec parameter includes a comma-separated list of attribute pairs for each clip region, e.g.: (window,type=mask),(world,type=clip). This indicates that there are two clip regions, with the first clip region set in window space using a mask attribute (hiding objects within the clip region that are in or below the current segment), and the second in world space with a clip attribute (hiding objects outside the clip region that are in or below the current segment).

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.

See also
Show_Clip_Region()

◆ PShow_Net_Clip_Region_Size()

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 loops defined in the points array. This will be the size of the array total array. 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.

See also
Show_Clip_Region_Size()

◆ Show_Clip_Region()

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 loops 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.

See also
Set_Polygonal_Clip_Region
Set_Complex_Clip_Region

◆ Show_Clip_Region_Size()

void Show_Clip_Region_Size ( int *  loopCount,
int *  clipSizeArray,
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 loops 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()