Show_One_Color

Functions

HC_BOOLEAN PShow_One_Net_Color (int count, const HC_KEY *keys, const char *type, char *color)
 Similar to Show_One_Color(), but returns the net effective value of a single attribute along a path of segments specified by an array of HC_KEY's. More...
 
HC_BOOLEAN PShow_One_Net_Color_By_Index (int count, const HC_KEY *keys, const char *type, int *index)
 Similar to Show_One_Color(), but returns the net effective value of a single attribute along a path of segments specified by an array of HC_KEY's. Operates with map indices rather than names or values. More...
 
HC_BOOLEAN PShow_One_Net_Color_By_Value (int count, const HC_KEY *keys, const char *type, char *color_space, float *a, float *b, float *c)
 Similar to Show_One_Color(), but returns the net effective value of a single attribute along a path of segments specified by an array of HC_KEY's. Operates with a color values rather than names or map indices. More...
 
void Show_One_Color (const char *type, char *color)
 Returns the color value for one particular type of geometry. More...
 
void Show_One_Color_By_Index (const char *type, int *index)
 Similar to Show_One_Color(), but returns the value of a single attribute in the currently open segment. Operates with map indices rather than names or values. More...
 
HC_BOOLEAN Show_One_Color_By_Value (const char *type, char *color_space, float *a, float *b, float *c)
 Similar to Show_One_Color(), but returns the value of a single attribute in the currently open segment. Operates with a color values rather than names or map indices. More...
 

Detailed Description

Function Documentation

◆ PShow_One_Net_Color()

HC_BOOLEAN PShow_One_Net_Color ( int  count,
const HC_KEY *  keys,
const char *  type,
char *  color 
)

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

Parameters
count- The size of 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.
type- The type of geometry whose current color setting should be shown.
color- An English description of the color's current setting. Returned to caller. Passed by reference in all languages.

DETAILS

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 additional details, see Show_One_Color().

◆ PShow_One_Net_Color_By_Index()

HC_BOOLEAN PShow_One_Net_Color_By_Index ( int  count,
const HC_KEY *  keys,
const char *  type,
int *  index 
)

Similar to Show_One_Color(), but returns the net effective value of a single attribute along a path of segments specified by an array of HC_KEY's. Operates with map indices rather than names or values.

Parameters
count- The size of 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.
type- The type of geometry whose current color setting should be shown.
index- The offset in the applicable Color Map. Returned to caller. Passed by reference in all languages.

DETAILS

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 additional details, see Show_One_Color().

◆ PShow_One_Net_Color_By_Value()

HC_BOOLEAN PShow_One_Net_Color_By_Value ( int  count,
const HC_KEY *  keys,
const char *  type,
char *  color_space,
float *  a,
float *  b,
float *  c 
)

Similar to Show_One_Color(), but returns the net effective value of a single attribute along a path of segments specified by an array of HC_KEY's. Operates with a color values rather than names or map indices.

Parameters
count- The size of 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.
type- The type of geometry whose current color setting should be shown.
color_space- Special constant—either "HLS", "HSV", "HIC", or "RGB". Returned to caller. Passed by reference in all languages.
a- The location in the color space—hue, lightness, and satura tion; red, green, and blue; etc. Returned to caller. Passed by reference in all languages.
b-
c-

DETAILS

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 additional details, see Show_One_Color().

◆ Show_One_Color()

void Show_One_Color ( const char *  type,
char *  color 
)

Returns the color value for one particular type of geometry.

Parameters
type- The type of geometry whose current color setting should be shown.
color- An English description of the color's current setting. Returned to caller. Passed by reference in all languages.

DETAILS

Show_Color() is the general-purpose "show all the current colors". This may be more information than you really want, if all you really want is, for example, is the current edge color. The "Show One Color" routines allow you to specify a particular kind of color.
Legal choices for type are the same as in Set_Color_By_Value() . If you use a name that is really composed of more than one color, such as "polygons", all the pieces (edges and faces) have to agree or you'll get an error.

NOTES

Users can query the suboption settings for specific geometries by using an "=" sign. For example, use Show_One_Color("faces=transmission") to return only the transmission setting. Note: only one suboption per call is allowed.

The color_space is returned to you, not passed in. In the present implementation, the color will be equivalent to the color you originally set, but it won't necessarily be written the same way. For example, if you set a color by RGB value, the system may, at its discretion, return an HLS color when asked to show that color. If you want a particular color space, use Compute_Color() on the return values.
An error will occur if you Show a color by value that was originally set by index, or vice versa.
The "Show Net" routines can always return a value, but you'll get an error if you use one of the "simple" Show routines on a segment that doesn't have that particular color set on it.

RESTRICTIONS

See also
Show_One_(Attribute), Compute_Color, Define_Color_Name, Set_Color, Set_Window, Set_Color_By_Value, Set_Color_By_Index.

◆ Show_One_Color_By_Index()

void Show_One_Color_By_Index ( const char *  type,
int *  index 
)

Similar to Show_One_Color(), but returns the value of a single attribute in the currently open segment. Operates with map indices rather than names or values.

Parameters
type- The type of geometry whose current color setting should be shown.
index- The offset in the applicable Color Map. Returned to caller. Passed by reference in all languages.

DETAILS

No additional details. See Show_One_Color()

◆ Show_One_Color_By_Value()

HC_BOOLEAN Show_One_Color_By_Value ( const char *  type,
char *  color_space,
float *  a,
float *  b,
float *  c 
)

Similar to Show_One_Color(), but returns the value of a single attribute in the currently open segment. Operates with a color values rather than names or map indices.

Parameters
type- The type of geometry whose current color setting should be shown.
color_space- Special constant—either "HLS", "HSV", "HIC", or "RGB". Returned to caller. Passed by reference in all languages.
a- The location in the color space—hue, lightness, and satura tion; red, green, and blue; etc. Returned to caller. Passed by reference in all languages.
b-
c-

DETAILS

No additional details. See Show_One_Color()