Brief Index      Full Index      Events Index      I.M. Reference

MShow_Face_Visibilities

Functions

void MShow_Face_Visibilities (HC_KEY key, int offset, int count, char *settings)
int MShow_Face_Visibilities_With_Existence (HC_KEY key, int offset, int count, char *existence, char *visibilities)
void MShow_Face_Visibilities_By_Index (HC_KEY key, int count, int *indices, char *settings)
void MShow_Specific_Face_Visibilities (HC_KEY key, int count, const int *indices, char *settings)
int MShow_Specific_Face_Visibilities_With_Existence (HC_KEY key, int count, const int *indices, char *existence, char *visibilities)

Function Documentation

void MShow_Face_Visibilities ( HC_KEY  key,
int  offset,
int  count,
char *  settings 
)

Shows the visibility settings for a range of faces.

Parameters:
key- Key of a shell or mesh.
offset- First face number.
count- Number of faces.
settings- Visibility setting per face, zero (0) for off, one (1) for on. Passed by reference. Returned to user.

DETAILS

This function is equivalent to MShow_Specific_Face_Visibilities.

See also:
MSet_Specific_Face_Visibilities, MSet_Face_Colors_By_FIndex, MSet_Face_Colors_By_Value, MSet_Face_Regions, MShow_Face_Colors_By_FIndex, MShow_Face_Colors_By_Value, MShow_Face_Regions
int MShow_Face_Visibilities_With_Existence ( HC_KEY  key,
int  offset,
int  count,
char *  existence,
char *  visibilities 
)

Shows the visibility settings for a range of faces.

Parameters:
key- Key of a shell or mesh.
offset- First face number.
count- Number of faces.
existence- An array of size count whose values would be populated with either 0 (does not exist) or 1 (exists). Passed by reference. Returned to user.
visibilities- Visibility setting per face, zero (0) for off, one (1) for on. Passed by reference. Returned to user.
Returns:
The number of items that have the attribute set.

DETAILS

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

  • 0 : There was no visibility value is set.
  • 1 : The visibility value is set.
See also:
MSet_Specific_Face_Visibilities, MSet_Face_Colors_By_FIndex, MSet_Face_Colors_By_Value, MSet_Face_Regions, MShow_Face_Colors_By_FIndex, MShow_Face_Colors_By_Value, MShow_Face_Regions
void MShow_Face_Visibilities_By_Index ( HC_KEY  key,
int  count,
int *  indices,
char *  settings 
)

Similar to MShow_Specific_Face_Visibilities() which shows the visibility settings for a precise list of faces.

Parameters:
key- Key of a shell or mesh.
count- Number of faces.
indices- The list of faces to show the visibility setting.
settings- Visibility setting per face, zero (0) for off, one (1) for on. Passed by reference. Returned to user.

DETAILS

settings is a character array with a 0 or non 0 value in each character.

NOTES

An error is generated (like the other MShow functions) if a face within the range does not have a visibility setting.

See also:
MSet_Specific_Face_Visibilities, MSet_Face_Colors_By_FIndex, MSet_Face_Colors_By_Value, MSet_Face_Regions, MShow_Face_Colors_By_FIndex, MShow_Face_Colors_By_Value, MShow_Face_Regions
void MShow_Specific_Face_Visibilities ( HC_KEY  key,
int  count,
const int *  indices,
char *  settings 
)

Shows the visibility settings for a list of faces.

Parameters:
key- Key of a shell or mesh.
count- Number of faces.
indices- The list of faces to show the visibility setting.
settings- Visibility setting per face, zero (0) for off, one (1) for on. Passed by reference. Returned to user.

DETAILS

settings is a character array with a 0 or non 0 value in each character.

NOTES

An error is generated (like the other MShow functions) if a face within the range does not have a visibility setting.

See also:
MSet_Specific_Face_Visibilities, MSet_Face_Colors_By_FIndex, MSet_Face_Colors_By_Value, MSet_Face_Regions, MShow_Face_Colors_By_FIndex, MShow_Face_Colors_By_Value, MShow_Face_Regions
int MShow_Specific_Face_Visibilities_With_Existence ( HC_KEY  key,
int  count,
const int *  indices,
char *  existence,
char *  visibilities 
)

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

Parameters:
key- Key of a shell or mesh.
count- Number of faces.
indices- The list of faces.
existence- An array of size count whose values would be populated with either 0 (does not exist) or 1 (exists). Passed by reference. Returned to user.
visibilities- Visibility setting per face, zero (0) for off, one (1) for on. Passed by reference. Returned to user.
Returns:
The number of items that have the attribute set.

DETAILS

See MShow_Face_Visibilities_With_Existence() for more details.

See also:
MSet_Specific_Face_Visibilities, MSet_Face_Colors_By_FIndex, MSet_Face_Colors_By_Value, MSet_Face_Regions, MShow_Face_Colors_By_FIndex, MShow_Face_Colors_By_Value, MShow_Face_Regions

Brief Index      Full Index      Events Index      I.M. Reference