Public Member Functions | Friends

MnParticle Class Reference

Search for all occurrences

Detailed Description

Class for wrapping N cloth objects.

This class wraps the internal Maya representation of N cloth objects suitable for use with the Nucleus solver.

#include <MnParticle.h>

Inheritance diagram for MnParticle:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 MnParticle ()
 Default constructor.
virtual ~MnParticle ()
 The class destructor.
MStatus createNParticle ()
 Creates the underlying Maya TnParticle and sets this class to wrap it.
MStatus setTopology (const int numPoints)
 Sets the topology of the underlying N Object.
MStatus setPositions (const MFloatPointArray &positions, bool startFrame=true)
 Sets the positions of the vertices of the underlying N cloth object.
MStatus setVelocities (const MFloatPointArray &velocities)
 Sets the velocities of the vertices of the underlying Ncloth object.
MStatus setThickness (float radius)
 sets a radius on each point collision purposes.
MStatus setThickness (float *radius)
 sets a radius (thickness) on a per point basis for collision purposes.
MStatus setInverseMass (float invMass)
 sets the mass for every point in this mesh
MStatus setInverseMass (float *invMass)
 sets the mass on a per point basis
MStatus setBounce (float bounce)
 sets the bounce for every point in this mesh
MStatus setBounce (float *bounce)
 sets the bounce on a per point basis in this mesh
MStatus setFriction (float friction)
 sets the friction for every point in this mesh
MStatus setFriction (float *friction)
 sets the friction on a per point basis for this mesh
MStatus setDamping (float damping)
 sets the damping for every point in this mesh
MStatus setDamping (float *damping)
 sets the damping on a per point basis in this mesh
MStatus setDisableGravity (const bool b)
 Sets whether gravity will affect this object.
MStatus setLiquidSimulation (const bool b)
 Sets whether this object will solve as a liquid.
MStatus setIncompressibility (float incompressibility)
 sets the incompressibility
MStatus setRestDensity (float restDensity)
 sets the rest density for every point in this mesh
MStatus setLiquidRadiusScale (float liquidRadiusScale)
 sets the liquidRadiusScale for every point in this mesh
MStatus setViscosity (float viscosity)
 sets the viscosity for every point in this mesh
MStatus setViscosity (float *viscosity)
 sets the viscosity on a per point basis in this mesh
MStatus setSurfaceTension (float surfaceTension)
 sets the surfaceTension for every point in this mesh
MStatus setSurfaceTension (float *surfaceTension)
 sets the surfaceTension on a per point basis in this mesh
MStatus setMaxIterations (const int it)
 Sets the number of iterations the solver will perform on various dynamic properties like drag, damping, stretch and bend.
MStatus setMaxSelfCollisionIterations (const int it)
 Sets the number of iterations the solver will perform for self collisions on this object.
MStatus setSelfCollisionSoftness (float softness)
 This allows one to lower the repulsive force of self collisions such that some interpenetration within the collide width is allowed.
MStatus setDragAndLift (float drag, float lift)
 Sets the drag and lift values for the cloth.
MStatus setCollide (const bool b)
 Sets whether collisions will affect this object.
MStatus setSelfCollide (const bool b)
 Sets whether self collisions will affect this object.
MStatus setSelfCollideWidth (float width)
 Sets the self collision width.
MStatus getNumVertices (unsigned int &numVerts) const
 Returns the number of vertices in the underlying nParticle.
MStatus getPositions (MFloatPointArray &positions) const
 gets the positions of the points of the underlying N Object.
MStatus getVelocities (MFloatPointArray &velocities) const
 gets the velocities of the points of the underlying N cloth object.
MStatus getThickness (MFloatArray &radius) const
 gets the radii of the points of the underlying N particle object.
MStatus getInverseMass (MFloatArray &inverseMass) const
 gets the inverseMass of the points of the underlying N particle object.
MStatus getBounce (MFloatArray &bounce) const
 gets the Bounce of the points of the underlying N particle object.
MStatus getFriction (MFloatArray &friction) const
 gets the friction of the points of the underlying N particle object.

Friends

class MFnNObjectData

Constructor & Destructor Documentation

Default constructor.

The instance is set to contain nothing.


Member Function Documentation

MStatus createNParticle ( )

Creates the underlying Maya TnParticle and sets this class to wrap it.

Returns:
MStatus setTopology ( const int  numPoints)

Sets the topology of the underlying N Object.

This must be called whenever the number of particles changes, before setting any particle properties

Parameters:
[in]numPointsnumber of particles
Returns:
MStatus setPositions ( const MFloatPointArray positions,
bool  startFrame = true 
)

Sets the positions of the vertices of the underlying N cloth object.

Parameters:
[in]positionsthe array containing the position information
[in]startFramewhether this information represents the state of the object at the start frame.
Returns:
MStatus setVelocities ( const MFloatPointArray velocities)

Sets the velocities of the vertices of the underlying Ncloth object.

Parameters:
[in]velocitiesthe array containing the velocity information
Returns:
MStatus setThickness ( float  radius)

sets a radius on each point collision purposes.

The bigger the radius/thickness, the more easily things collide.

Parameters:
[in]radiusthe radius to set
Returns:
MStatus setThickness ( float *  radius)

sets a radius (thickness) on a per point basis for collision purposes.

The bigger the radius, the more easily things collide.

Parameters:
[in]radiusthe radius to set
Returns:
MStatus setInverseMass ( float  invMass)

sets the mass for every point in this mesh

Parameters:
[in]invMassthe inverse of the mass. A value of 0 means an infinitely heavy object.
Returns:
MStatus setInverseMass ( float *  invMass)

sets the mass on a per point basis

Parameters:
[in]invMassthe inverse of the mass. A value of 0 means an infinitely heave object.
Returns:
MStatus setBounce ( float  bounce)

sets the bounce for every point in this mesh

Parameters:
[in]bouncevalue of bounce to set
Returns:
MStatus setBounce ( float *  bounce)

sets the bounce on a per point basis in this mesh

Parameters:
[in]bouncevalue of bounce to set
Returns:
MStatus setFriction ( float  friction)

sets the friction for every point in this mesh

Parameters:
[in]frictionthe friction to set
Returns:
MStatus setFriction ( float *  friction)

sets the friction on a per point basis for this mesh

Parameters:
[in]frictionthe friction to set
Returns:
MStatus setDamping ( float  damping)

sets the damping for every point in this mesh

Parameters:
[in]dampingthe damping value to set
Returns:
MStatus setDamping ( float *  damping)

sets the damping on a per point basis in this mesh

Parameters:
[in]dampingthe damping value to set
Returns:
MStatus setDisableGravity ( const bool  b)

Sets whether gravity will affect this object.

Parameters:
[in]bwhether to calculate gravity
Returns:
MStatus setLiquidSimulation ( const bool  b)

Sets whether this object will solve as a liquid.

Parameters:
[in]bwhether to calculate liquid
Returns:
MStatus setIncompressibility ( float  incompressibility)

sets the incompressibility

Parameters:
[in]incompressibilitythe incompressibility value to set
Returns:
MStatus setRestDensity ( float  restDensity)

sets the rest density for every point in this mesh

Parameters:
[in]restDensitythe rest density value to set
Returns:
MStatus setLiquidRadiusScale ( float  liquidRadiusScale)

sets the liquidRadiusScale for every point in this mesh

Parameters:
[in]liquidRadiusScalethe liquidRadiusScale value to set
Returns:
MStatus setViscosity ( float  viscosity)

sets the viscosity for every point in this mesh

Parameters:
[in]viscositythe viscosity value to set
Returns:
MStatus setViscosity ( float *  viscosity)

sets the viscosity on a per point basis in this mesh

Parameters:
[in]viscositythe viscosity value to set
Returns:
MStatus setSurfaceTension ( float  surfaceTension)

sets the surfaceTension for every point in this mesh

Parameters:
[in]surfaceTensionthe surfaceTension value to set
Returns:
MStatus setSurfaceTension ( float *  surfaceTension)

sets the surfaceTension on a per point basis in this mesh

Parameters:
[in]surfaceTensionthe surfaceTension value to set
Returns:
MStatus setMaxIterations ( const int  it)

Sets the number of iterations the solver will perform on various dynamic properties like drag, damping, stretch and bend.

Higher iterations take longer, and the primary use of this attribute is to keep things from locking up should high iteration values be requested.

Parameters:
[in]itnumber of iterations
Returns:
MStatus setMaxSelfCollisionIterations ( const int  it)

Sets the number of iterations the solver will perform for self collisions on this object.

Parameters:
[in]itnumber of iterations
Returns:
MStatus setSelfCollisionSoftness ( float  softness)

This allows one to lower the repulsive force of self collisions such that some interpenetration within the collide width is allowed.

This can in some cases reduce jitter due to self collision with low selfCollideIterations. In general its use should be avoided, however.

Parameters:
[in]softnessvalue to set.
Returns:
MStatus setDragAndLift ( float  drag,
float  lift 
)

Sets the drag and lift values for the cloth.

Parameters:
[in]dragvalue of drag
[in]liftvalue of lift
Returns:
MStatus setCollide ( const bool  b)

Sets whether collisions will affect this object.

Parameters:
[in]bwhether to calculate collision
Returns:
MStatus setSelfCollide ( const bool  b)

Sets whether self collisions will affect this object.

Parameters:
[in]bwhether to calculate self collision
Returns:
MStatus setSelfCollideWidth ( float  width)

Sets the self collision width.

Parameters:
[in]widthvalue to set
Returns:
MStatus getNumVertices ( unsigned int &  numVerts) const

Returns the number of vertices in the underlying nParticle.

Parameters:
[out]numVertsNumber of vertices.
Returns:
MStatus getPositions ( MFloatPointArray positions) const

gets the positions of the points of the underlying N Object.

Parameters:
[out]positionsthe array will be filled with the positions.
Returns:
MStatus getVelocities ( MFloatPointArray velocities) const

gets the velocities of the points of the underlying N cloth object.

Parameters:
[out]velocitiesthe array will be filled with the positions.
Returns:
MStatus getThickness ( MFloatArray radius) const

gets the radii of the points of the underlying N particle object.

Parameters:
[out]radiusthe array will be filled with the radii.
Returns:
MStatus getInverseMass ( MFloatArray inverseMass) const

gets the inverseMass of the points of the underlying N particle object.

Parameters:
[out]inverseMassthe array will be filled with the inverse masses.
Returns:
MStatus getBounce ( MFloatArray bounce) const

gets the Bounce of the points of the underlying N particle object.

Parameters:
[out]bouncethe array will be filled with the bounce.
Returns:
MStatus getFriction ( MFloatArray friction) const

gets the friction of the points of the underlying N particle object.

Parameters:
[out]frictionthe array will be filled with the friction.
Returns:

MnParticle MnParticle MnParticle MnParticle MnParticle MnParticle MnParticle MnParticle MnParticle MnParticle
MnParticle MnParticle MnParticle MnParticle MnParticle MnParticle MnParticle MnParticle MnParticle MnParticle