Options for control of smooth mesh generation.
The MMeshSmoothOptions class encapsulates settings that control the generation of smoothed version of a mesh. Meant for use with MFnMesh::generateSmoothMesh().
#include <MMeshSmoothOptions.h>
Public Types | |
enum | BoundaryRule { kInvalid = -1, kLegacy = 0, kCreaseAll, kCreaseEdge, kLast } |
Specifies how to apply boundary creasing to subd poly object. More... | |
Public Member Functions | |
MMeshSmoothOptions (void) | |
Constructor. | |
virtual | ~MMeshSmoothOptions (void) |
Destructor. | |
void | setDivisions (int numDivisions, MStatus *ReturnStatus=NULL) |
Sets the number of divisions stored in this options object. | |
int | divisions (MStatus *ReturnStatus=NULL) const |
Retrieves the level of smoothing these options specify to perform on the mesh. | |
void | setSmoothness (float smoothness, MStatus *ReturnStatus=NULL) |
Sets the the smoothness parameter for this set of smooth options which has range [0,1] where 1 smooths the faces as much as possible. | |
float | smoothness (MStatus *ReturnStatus=NULL) const |
Retrieves the smoothness parameter for this set of smooth options which has range [0,1] where 1 smooths the faces as much as possible. | |
void | setSmoothUVs (bool smoothUVs, MStatus *ReturnStatus=NULL) |
Sets whether or not these options specify to smooth UVs as well as geometry. | |
bool | smoothUVs (MStatus *ReturnStatus=NULL) const |
Retrieves whether or not these options specify to smooth UVs as well as geometry. | |
void | setPropEdgeHardness (bool propEdgeHardness, MStatus *ReturnStatus=NULL) |
Sets whether or not these options specify that smooth mesh edges which are a result of edges from the base cage will share the hardness value. | |
bool | propEdgeHardness (MStatus *ReturnStatus=NULL) const |
Retrieves whether or not these options specify that the smooth mesh edges which are a result of edges from the base cage will share the same hardness value. | |
void | setKeepBorderEdge (bool keepBorderEdge, MStatus *ReturnStatus=NULL) |
Sets whether or not these options specify that border edges will not be smoothed. | |
bool | keepBorderEdge (MStatus *ReturnStatus=NULL) const |
Retrieves whether or not these options specify that border edges will not be smoothed. | |
void | setKeepHardEdge (bool keepHardEdge, MStatus *ReturnStatus=NULL) |
Sets whether or not these options specify that hard edges will not be smoothed. | |
bool | keepHardEdge (MStatus *ReturnStatus=NULL) const |
Retrieves whether or not these options specify that hard edges will not be smoothed. | |
void | setBoundaryRule (BoundaryRule rule, MStatus *ReturnStatus=NULL) |
Set the rule used to determine how boundary edges and vertices are creased. | |
BoundaryRule | boundaryRule (MStatus *ReturnStatus=NULL) const |
Returns the current value for the boundary rule. | |
Static Public Member Functions | |
static const char * | className () |
Returns the name of this class. | |
Friends | |
class | MFnMesh |
enum BoundaryRule |
Specifies how to apply boundary creasing to subd poly object.
void setDivisions | ( | int | numDivisions, |
MStatus * | ReturnStatus = NULL |
||
) |
Sets the number of divisions stored in this options object.
[in] | numDivisions | Number of divisions. |
[out] | ReturnStatus | Status code (see below) |
int divisions | ( | MStatus * | ReturnStatus = NULL | ) | const |
Retrieves the level of smoothing these options specify to perform on the mesh.
[out] | ReturnStatus | Status code (see below) |
void setSmoothness | ( | float | smoothness, |
MStatus * | ReturnStatus = NULL |
||
) |
Sets the the smoothness parameter for this set of smooth options which has range [0,1] where 1 smooths the faces as much as possible.
[in] | smoothness | The smoothness |
[out] | ReturnStatus | Status code (see below) |
float smoothness | ( | MStatus * | ReturnStatus = NULL | ) | const |
Retrieves the smoothness parameter for this set of smooth options which has range [0,1] where 1 smooths the faces as much as possible.
[out] | ReturnStatus | Status code (see below) |
void setSmoothUVs | ( | bool | smoothUVs, |
MStatus * | ReturnStatus = NULL |
||
) |
Sets whether or not these options specify to smooth UVs as well as geometry.
[in] | smoothUVs | True if UVs should be smoothed |
[out] | ReturnStatus | Status code (see below) |
bool smoothUVs | ( | MStatus * | ReturnStatus = NULL | ) | const |
Retrieves whether or not these options specify to smooth UVs as well as geometry.
[out] | ReturnStatus | Status code (see below) |
void setPropEdgeHardness | ( | bool | propEdgeHardness, |
MStatus * | ReturnStatus = NULL |
||
) |
Sets whether or not these options specify that smooth mesh edges which are a result of edges from the base cage will share the hardness value.
[in] | propEdgeHardness | True if smooth edges should share hardness with the base cage |
[out] | ReturnStatus | Status code (see below) |
bool propEdgeHardness | ( | MStatus * | ReturnStatus = NULL | ) | const |
Retrieves whether or not these options specify that the smooth mesh edges which are a result of edges from the base cage will share the same hardness value.
[out] | ReturnStatus | Status code (see below) |
void setKeepBorderEdge | ( | bool | keepBorderEdge, |
MStatus * | ReturnStatus = NULL |
||
) |
Sets whether or not these options specify that border edges will not be smoothed.
[in] | keepBorderEdge | True if border edges should not be smoothed |
[out] | ReturnStatus | Status code (see below) |
bool keepBorderEdge | ( | MStatus * | ReturnStatus = NULL | ) | const |
Retrieves whether or not these options specify that border edges will not be smoothed.
[out] | ReturnStatus | Status code (see below) |
void setKeepHardEdge | ( | bool | keepHardEdge, |
MStatus * | ReturnStatus = NULL |
||
) |
Sets whether or not these options specify that hard edges will not be smoothed.
[in] | keepHardEdge | True if hard edges should not be smoothed |
[out] | ReturnStatus | Status code (see below) |
bool keepHardEdge | ( | MStatus * | ReturnStatus = NULL | ) | const |
Retrieves whether or not these options specify that hard edges will not be smoothed.
[out] | ReturnStatus | Status code (see below) |
void setBoundaryRule | ( | MMeshSmoothOptions::BoundaryRule | rule, |
MStatus * | ReturnStatus = NULL |
||
) |
Set the rule used to determine how boundary edges and vertices are creased.
By default, creases are automatically applied to all boundary edges and all vertices that have only 2 incident edges prior to being converted to a smooth mesh.
The possible rules are:
[in] | rule | to apply |
[out] | ReturnStatus | Status code |
MMeshSmoothOptions::BoundaryRule boundaryRule | ( | MStatus * | ReturnStatus = NULL | ) | const |
Returns the current value for the boundary rule.
See setBoundaryRule() for more details.
[out] | ReturnStatus | Status code |
const char * className | ( | ) | [static] |