MShow_Face_Colors_With_Existence

Functions

int MShow_Face_Colors_With_Existence (HC_KEY key, const char *geometry, int offset, int count, char *result_type, float *index_colors, HC_RGB *rgb_colors)
 Returns face color settings from a range of faces without having to open each face. More...
 
int MShow_Specific_Face_Colors_With_Existence (HC_KEY key, const char *geometry, int count, const int *faces, char *result_type, float *index_colors, HC_RGB *rgb_colors)
 Returns face color settings from an arbitrary set of faces without having to open each face. More...
 

Detailed Description

Function Documentation

◆ MShow_Face_Colors_With_Existence()

int MShow_Face_Colors_With_Existence ( HC_KEY  key,
const char *  geometry,
int  offset,
int  count,
char *  result_type,
float *  index_colors,
HC_RGB *  rgb_colors 
)

Returns face color settings from a range of faces without having to open each face.

Parameters
key- Key to the piece of geometry to query.
geometry- A list of which geometry types are to be affected. Currently the only legal value for this parameter is "faces". Upper case versus lowercase is not significant.
offset- Index of the key's point array on which to start querying values.
count- Number of points from offset to query.
result_type- An array of size count whose values would be populated with either 0, 1 or 2 describing what type of color value was set (see details for more information). Passed by reference. Returned to user.
index_colors- An array of size count populated with the index color value. Passed by reference. Returned to user.
rgb_colors- Array of (r, g, b) triplets whose size is count. Passed by reference. Returned to user.
Returns
The number of items that have the attribute set.

DETAILS

Use MShow_Face_Colors_With_Existence to query face color values efficiently. Since color values may or may not exist, the return values gives you the total number of color values that have been set. The result_type array gives you further information about each face's color setting. For a given face, the result_type value may be one of the following:

  • 0 : There was no color value set.
  • 1 : The color setting is index value.
  • 2 : The color setting is an rgb value.

See also
MSet_Face_Colors_By_Value, MSet_Face_Colors_By_FIndex, MShow_Face_Colors_By_FIndex, MShow_Vertex_Colors_By_Value, MShow_Vertex_Colors_By_FInd, MShow_Face_Regions, Insert_Shell, Show_Shell, Edit_Shell_Faces, Edit_Shell_Points

◆ MShow_Specific_Face_Colors_With_Existence()

int MShow_Specific_Face_Colors_With_Existence ( HC_KEY  key,
const char *  geometry,
int  count,
const int *  faces,
char *  result_type,
float *  index_colors,
HC_RGB *  rgb_colors 
)

Returns face color settings from an arbitrary set of faces without having to open each face.

Parameters
key- Key to the piece of geometry to query.
geometry- A list of which geometry types are to be affected. Currently the only legal value for this parameter is "faces". Upper case versus lowercase is not significant.
count- Number of faces to query.
faces- The list of faces to query values.
result_type- An array of size count whose values would be populated with either 0, 1, 2 or 3 describing what type of color value was set (see details for more information). Passed by reference. Returned to user.
index_colors- An array of size count populated with the index color value. Passed by reference. Returned to user.
rgb_colors- Array of (r, g, b) triplets whose size is count. Passed by reference. Returned to user.
Returns
The number of items that have the attribute set.

DETAILS

See MShow_Face_Colors_With_Existence() for more details.

NOTES

RESTRICTIONS

See also
MSet_Face_Colors_By_Value, MSet_Face_Colors_By_FIndex, MShow_Face_Colors_By_FIndex, MShow_Vertex_Colors_By_Value, MShow_Vertex_Colors_By_FInd, MShow_Face_Regions, Insert_Shell, Show_Shell, Edit_Shell_Faces, Edit_Shell_Points