MMeshSmoothOptions Class Reference
[OpenMaya - API module for common classes]

#include <MMeshSmoothOptions.h>

List of all members.


Detailed Description

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

Public Member Functions

 MMeshSmoothOptions (void)
virtual ~MMeshSmoothOptions (void)
void setDivisions (int numDivisions, MStatus *ReturnStatus=NULL)
int divisions (MStatus *ReturnStatus=NULL) const
void setSmoothness (float smoothness, MStatus *ReturnStatus=NULL)
float smoothness (MStatus *ReturnStatus=NULL) const
void setSmoothUVs (bool smoothUVs, MStatus *ReturnStatus=NULL)
bool smoothUVs (MStatus *ReturnStatus=NULL) const
void setPropEdgeHardness (bool propEdgeHardness, MStatus *ReturnStatus=NULL)
bool propEdgeHardness (MStatus *ReturnStatus=NULL) const
void setKeepBorderEdge (bool keepBorderEdge, MStatus *ReturnStatus=NULL)
bool keepBorderEdge (MStatus *ReturnStatus=NULL) const
void setKeepHardEdge (bool keepHardEdge, MStatus *ReturnStatus=NULL)
bool keepHardEdge (MStatus *ReturnStatus=NULL) const

Friends

class MFnMesh


Constructor & Destructor Documentation

MMeshSmoothOptions::MMeshSmoothOptions ( void   ) 

Constructor

MMeshSmoothOptions::~MMeshSmoothOptions ( void   )  [virtual]

Destructor.


Member Function Documentation

void MMeshSmoothOptions::setDivisions ( int  numDivisions,
MStatus ReturnStatus = NULL 
)

Sets the number of divisions stored in this options object.

Parameters:
[in] numDivisions Number of divisions.
[out] ReturnStatus Status code (see below)
Status Codes:

int MMeshSmoothOptions::divisions ( MStatus ReturnStatus = NULL  )  const

Retrieves the level of smoothing these options specify to perform on the mesh.

Parameters:
[out] ReturnStatus Status code (see below)
Returns:
The smoothing level
Status Codes:

void MMeshSmoothOptions::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

Parameters:
[in] smoothness The smoothness
[out] ReturnStatus Status code (see below)
Status Codes:

float MMeshSmoothOptions::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

Parameters:
[out] ReturnStatus Status code (see below)
Returns:
The smoothness parameter
Status Codes:

void MMeshSmoothOptions::setSmoothUVs ( bool  smoothUVs,
MStatus ReturnStatus = NULL 
)

Sets whether or not these options specify to smooth UVs as well as geometry.

Parameters:
[in] smoothUVs True if UVs should be smoothed
[out] ReturnStatus Status code (see below)
Status Codes:

bool MMeshSmoothOptions::smoothUVs ( MStatus ReturnStatus = NULL  )  const

Retrieves whether or not these options specify to smooth UVs as well as geometry.

Parameters:
[out] ReturnStatus Status code (see below)
Returns:
True if UVs are set to be smoothed
Status Codes:

void MMeshSmoothOptions::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

Parameters:
[in] propEdgeHardness True if smooth edges should share hardness with the base cage
[out] ReturnStatus Status code (see below)
Status Codes:

bool MMeshSmoothOptions::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.

Parameters:
[out] ReturnStatus Status code (see below)
Returns:
True if smooth edges share hardness with the base cage
Status Codes:

void MMeshSmoothOptions::setKeepBorderEdge ( bool  keepBorderEdge,
MStatus ReturnStatus = NULL 
)

Sets whether or not these options specify that border edges will not be smoothed

Parameters:
[in] keepBorderEdge True if border edges should not be smoothed
[out] ReturnStatus Status code (see below)
Status Codes:

bool MMeshSmoothOptions::keepBorderEdge ( MStatus ReturnStatus = NULL  )  const

Retrieves whether or not these options specify that border edges will not be smoothed

Parameters:
[out] ReturnStatus Status code (see below)
Returns:
True if border edges will not be smoothed
Status Codes:

void MMeshSmoothOptions::setKeepHardEdge ( bool  keepHardEdge,
MStatus ReturnStatus = NULL 
)

Sets whether or not these options specify that hard edges will not be smoothed

Parameters:
[in] keepHardEdge True if hard edges should not be smoothed
[out] ReturnStatus Status code (see below)
Status Codes:

bool MMeshSmoothOptions::keepHardEdge ( MStatus ReturnStatus = NULL  )  const

Retrieves whether or not these options specify that hard edges will not be smoothed

Parameters:
[out] ReturnStatus Status code (see below)
Returns:
True if hard edges will not be smoothed
Status Codes:


Autodesk® Maya® 2010 © 1997-2009 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6