Brief Index      Full Index      I.M. Reference

Show_Color


Functions

void Show_Color (char *color_spec)
void QShow_Color (const char *segment, char *color_spec)
void Show_Net_Color (char *color_spec)
void PShow_Net_Color (int keycount, HC_KEY *pathkeys, char *color_spec)
void QShow_Net_Color (const char *segment, char *color_spec)
void Show_Color_By_Index (char *types, int *index)
void QShow_Color_By_Index (const char *segment, char *types, int *index)
void Show_Net_Color_By_Index (char *types, int *index)
void PShow_Net_Color_By_Index (int keycount, HC_KEY *pathkeys, char *types, int *index)
void QShow_Net_Color_By_Index (const char *segment, char *types, int *index)
void Show_Color_By_Value (char *types, char *colorspace, float *a, float *b, float *c)
void QShow_Color_By_Value (const char *segment, char *types, char *colorspace, float *a, float *b, float *c)
void Show_Net_Color_By_Value (char *types, char *colorspace, float *a, float *b, float *c)
void PShow_Net_Color_By_Value (int keycount, HC_KEY *pathkeys, char *types, char *colorspace, float *a, float *b, float *c)
void QShow_Net_Color_By_Value (const char *segment, char *types, char *colorspace, float *a, float *b, float *c)

Function Documentation

void Show_Color ( char *  color_spec  ) 

Returns the named color(s) used to render the contents of the currently open segment.

Parameters:
color_spec - A specification for the desired color setting. Passed by reference. Returned to user.
Supported Options:
ambient light, ambient, back, cut edges, cut faces, cut geometry, edges, edge contrast, faces, face contrast, geometry, lights, lighting, lines, line contrast, markers, marker contrast, polygon contrast, polygons, polylines, text, text contrast, vertex contrast, vertices, windows, window contrast

DETAILS

No additional details. See Set_Color()

NOTES

When the value being passed back is a char *, be sure you've declared your string variable to be long enough.

The Show Color routines will complain if they're called and the attribute is not actually set in the segment. Use Show_Existence() to avoid this, if necessary.

RESTRICTIONS

In the Show Color routines 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.

The internal RGB-to-HLS and HLS-to-RGB routines are not exactly inverse. This might cause Show_Color_By_Value() not to give results matching the loaded values.

See also:
Set_Color_By_Value, Set_Color_By_Index, Set_Color_By_FIndex, Set_Color_Map, Define_Color_Name, Define_Texture, Set_Rendering_Options, Set_Line_Pattern, Set_Edge_Pattern, Set_Marker_Symbol, Set_Face_Pattern, Set_Text_Font, Insert_Distant_Light, Open_Face, Open_Edge, Open_Vertex

void QShow_Color ( const char *  segment,
char *  color_spec 
)

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

Parameters:
segment - Name of the segment(s) to be changed.
color_spec - A specification for the desired color setting. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Color()

void Show_Net_Color ( char *  color_spec  ) 

Similar to Show_Color(), but returns the net effective setting rather than the local one.

Parameters:
color_spec - A specification for the desired color setting. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Color()

void PShow_Net_Color ( int  count,
HC_KEY *  keys,
char *  color_spec 
)

Similar to Show_Net_Color(), but returns the net effective settings along a discrete path of segments.

Parameters:
keycount The size of pathkeys
pathkeys An array of HC_KEY's delineating a path of segments.
color_spec - A specification for the desired color setting. Passed by reference. Returned to user.

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_Color()

void QShow_Net_Color ( const char *  segment,
char *  color_spec 
)

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

Parameters:
segment - Name of the segment(s) to be changed.
color_spec - A specification for the desired color setting. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Color()

void Show_Color_By_Index ( char *  types,
int *  index 
)

Returns the color map indices used to render the contents of the currently open segment.

Parameters:
types - A list of geometry types. Passed by reference. Returned to user.
index - The offset in the applicable color map in which the colors are found. The very first entry is at offset zero. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Color_By_Index()

void QShow_Color_By_Index ( const char *  segment,
char *  types,
int *  index 
)

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

Parameters:
segment - Name of the segment to query.
types - A list of geometry types. Passed by reference. Returned to user.
index - The offset in the applicable color map in which the colors are found. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Color_By_Index()

void Show_Net_Color_By_Index ( char *  types,
int *  index 
)

Similar to Show_Color_By_Index(), but returns the net effective setting rather than the local one.

Parameters:
types - A list of geometry types. Passed by reference. Returned to user.
index - The offset in the applicable color map in which the colors are found. The very first entry is at offset zero. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Color_By_Index()

void PShow_Net_Color_By_Index ( int  count,
HC_KEY *  keys,
char *  types,
int *  index 
)

Similar to Show_Net_Color_By_Index(), but returns the net effective setting along a discrete segment path.

Parameters:
keycount The size of pathkeys
pathkeys An array of HC_KEY's delineating a path of segments.
types - A list of geometry types. Passed by reference. Returned to user.
index - The offset in the applicable color map in which the colors are found. The very first entry is at offset zero. Passed by reference. Returned to user.

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_Color_By_Index()

void QShow_Net_Color_By_Index ( const char *  segment,
char *  types,
int *  index 
)

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

Parameters:
segment - Name of the segment to query.
types - A list of geometry types. Passed by reference. Returned to user.
index - The offset in the applicable color map in which the colors are found. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Color_By_Index()

void Show_Color_By_Value ( char *  types,
char *  colorspace,
float *  a,
float *  b,
float *  c 
)

Returns the numerically-defined colors of objects in the currently open segment.

Parameters:
types - A list of geometry types. Passed by reference. Returned to user.
colorspace - Special constant---either "HLS", "HSV", "HIC", or "RGB". Passed by reference. Returned to user.
a - The location in the given color space. Passed by reference. Returned to user.
b -
c -

DETAILS

No additional details. See Set_Color_By_Value()

void QShow_Color_By_Value ( const char *  segment,
char *  types,
char *  colorspace,
float *  a,
float *  b,
float *  c 
)

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

Parameters:
segment - Name of the segment to query.
types - A list of geometry types. Passed by reference. Returned to user.
colorspace - Special constant---either "HLS", "HSV", "HIC", or "RGB". Passed by reference. Returned to user.
a - The location in the given color space. Passed by reference. Returned to user.
b -
c -

DETAILS

No additional details. See Set_Color_By_Value()

void Show_Net_Color_By_Value ( char *  types,
char *  colorspace,
float *  a,
float *  b,
float *  c 
)

Similar to Show_Color_By_Value(), but returns the net effective setting rather than the local one.

Parameters:
types - A list of geometry types. Passed by reference. Returned to user.
colorspace - Special constant---either "HLS", "HSV", "HIC", or "RGB". Passed by reference. Returned to user.
a - The location in the given color space. Passed by reference. Returned to user.
b -
c -

DETAILS

No additional details. See Set_Color_By_Value()

void PShow_Net_Color_By_Value ( int  keycount,
HC_KEY *  pathkeys,
char *  types,
char *  colorspace,
float *  a,
float *  b,
float *  c 
)

Similar to Show_Net_Color_By_Value(), but returns the net effective setting along a discrete segment path.

Parameters:
keycount The size of pathkeys
pathkeys An array of HC_KEY's delineating a path of segments.
types - A list of geometry types. Passed by reference. Returned to user.
colorspace - Special constant---either "HLS", "HSV", "HIC", or "RGB". Passed by reference. Returned to user.
a - The location in the given color space. Passed by reference. Returned to user.
b -
c -

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_Color_By_Value()

void QShow_Net_Color_By_Value ( const char *  segment,
char *  types,
char *  colorspace,
float *  a,
float *  b,
float *  c 
)

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

Parameters:
segment - Name of the segment to query.
types - A list of geometry types. Passed by reference. Returned to user.
colorspace - Special constant---either "HLS", "HSV", "HIC", or "RGB". Passed by reference. Returned to user.
a - The location in the given color space. Passed by reference. Returned to user.
b -
c -

DETAILS

No additional details. See Set_Color_By_Value()

Main Index
Brief Index      Full Index      I.M. Functions