MFnUniformField Class Reference
[OpenMayaFX - API module for effectsFunctionSet classes]

#include <MFnUniformField.h>
Inheritance diagram for MFnUniformField:
Inheritance graph
[legend]
Collaboration diagram for MFnUniformField:
Collaboration graph
[legend]

List of all members.


Detailed Description

Function set for Uniform Fields.

Function set for creation, edit, and query of Uniform Fields.

A uniform field pushes objects uniformly in a single direction.


Public Member Functions

virtual MFn::Type  type () const
  Function set type.
virtual  ~MFnUniformField ()
  Destructor.
  MFnUniformField ()
  Default constructor.
  MFnUniformField (MObject &object, MStatus *ReturnStatus=NULL)
  Constructor.
  MFnUniformField (const MDagPath &object, MStatus *ret=NULL)
  Constructor.
MVector  direction (MStatus *ReturnStatus=NULL) const
MStatus  setDirection (const MVector &uniformDirection)
  MFnUniformField (const MObject &object, MStatus *ret=NULL)
  Constructor.

Protected Member Functions

virtual const char *  className () const
  Class name.

Constructor & Destructor Documentation

MFnUniformField::~MFnUniformField (  )  [virtual]

Destructor.

Class destructor.

MFnUniformField::MFnUniformField ( MObject object,
MStatus ReturnStatus = NULL  
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:
[in]  object  The MObject to attach the function set to
[out]  ReturnStatus  the return status
Status Codes:

MFnUniformField::MFnUniformField ( const MDagPath object,
MStatus ReturnStatus = NULL  
)

Constructor.

Class constructor that initializes the function set to the given constant MDagPath object.

Parameters:
[in]  object  The const MDagPath to attach the function set to
[out]  ReturnStatus  The return status
Status Codes:

MFnUniformField::MFnUniformField ( const MObject object,
MStatus ReturnStatus = NULL  
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:
[in]  object  The MObject to attach the function set to
[out]  ReturnStatus  the return status
Status Codes:

Member Function Documentation

MFn::Type MFnUniformField::type (  )  const [virtual]

Function set type.

Return the class type : MFn::kUniform

Reimplemented from MFnField.

MVector MFnUniformField::direction ( MStatus ReturnStatus = NULL  )  const

Returns the direction the uniform field pushes objects.

Parameters:
[out]  ReturnStatus  Status code
Returns:
A vector representing direction.
Status Codes:

MStatus MFnUniformField::setDirection ( const MVector uniformDirection  ) 

Sets the direction the uniform field pushes objects.

Parameters:
[in]  uniformDirection  A vector representing direction.
Returns:
Status code
Status Codes:

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