Brief Index      Full Index      Events Index      I.M. Reference

MShow_Vertex_Colors_With_Existence

Functions

int MShow_Vertex_Colors_With_Existence (HC_KEY key, const char *geometry, int offset, int count, char *result_type, float *index_colors, HC_RGB *rgb_colors, HC_RGBA *rgba_colors)
 
int MShow_Specific_Vertex_Colors_With_Existence (HC_KEY key, const char *geometry, int count, const int *vertices, char *result_type, float *index_colors, HC_RGB *rgb_colors, HC_RGBA *rgba_colors)
 

Detailed Description

Function Documentation

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

Returns vertex color settings from a range of vertices without having to open each vertex.

Parameters
key- Key to the piece of geometry to query.
geometry- Type of geometry referred affected by the color value. This can be either "vertex", "edge", or "face".
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, 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.
rgba_colors- Array of (r, g, b, a) quads whose size is count. Passed by reference. Returned to user.
Returns
The number of items that have the attribute set.

DETAILS

Use MShow_Vertex_Colors_With_Existence to query vertex 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 vertex's color setting. For a given vertex, 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.
  • 3 : The color setting is an rgba value.
See Also
MSet_Vertex_Colors_By_FIndex, MSet_Vertex_Colors_By_Value, MShow_Vertex_Colors_By_Value, MShow_Face_Colors_By_FIndex, MShow_Face_Colors_By_Value, MShow_Face_Regions, Insert_Shell, Show_Shell, Edit_Shell_Faces, Edit_Shell_Points
int MShow_Specific_Vertex_Colors_With_Existence ( HC_KEY  key,
const char *  geometry,
int  count,
const int *  vertices,
char *  result_type,
float *  index_colors,
HC_RGB *  rgb_colors,
HC_RGBA *  rgba_colors 
)

Returns vertex color settings from an arbitrary set of vertices without having to open each vertex.

Parameters
key- Key to the piece of geometry to query.
geometry- Type of geometry referred affected by the color value. This can be either "vertex", "edge", or "face".
count- Number of vertices to query.
vertices- The list of vertices 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.
rgba_colors- Array of (r, g, b, a) quads whose size is count. Passed by reference. Returned to user.
Returns
The number of items that have the attribute set.

DETAILS

See MShow_Vertex_Colors_With_Existence() for more details.

NOTES

RESTRICTIONS

See Also
MSet_Vertex_Colors_By_FIndex, MSet_Vertex_Colors_By_Value, MShow_Vertex_Colors_By_Value, MShow_Face_Colors_By_FIndex, MShow_Face_Colors_By_Value, MShow_Face_Regions, Insert_Shell, Show_Shell, Edit_Shell_Faces, Edit_Shell_Points

Brief Index      Full Index      Events Index      I.M. Reference