MFnBase Class Reference
Related help topics: #include <MFnBase.h>
Class Description
Function Set Base Class.
Defines the interface for the API RTTI and Maya Object attachment methods common to all Function Set Classes.
Implements the Function Set compatibility test methods for all Function Sets.
The API provides access to Maya Objects as generic MObjects. Under the C++ class scheme MObjects simply have type MObject with no base or derived hierarchy. However, MObjects may be many different types of model or scene objects, from Attributes to Transforms, within Maya. This allows many different types of objects to be moved across or accessed through the API without undue concern on the part of plug-in developers for the type of object being manipulated.
Since it is impractical to provide every applicable method on MObjects, the methods applicable to Maya Objects are encapsulated in Function Sets. Function Sets can be attached to compatible MObjects to provide an external interface to methods appropriate to that MObject. All Function Sets provide a method setObject() which attaches them to the specified Maya Object. Additionally, most Function Sets provide a version of their constructor which attaches the new Function Set to a specified MObject.
The link between an MObject and the role it performs as a Maya scene or model object, as well as the compatibility between MObjects and Function Sets is managed by the API Run-Time Type Identification (RTTI) system. The two key concepts of this system are the Maya Object type and the Function Set type (both are MFn::Type). All MObjects have one and only one Maya Object type. All Function Sets have one and only one Function Set type. MObjects may, however, be compatible with many types of Function Sets. This compatibility follows the class hierarchy of the Function Sets. Thus an MObject with Maya Object type MFn::kNurbsSurface would be compatible with MFnNurbsSurface, MFnDagNode, MFnDependencyNode, MFnNamedObject and MFnBase.
Any MObject can be queried with the MObject::hasFn() method to determine if it is comaptible with a given Function Set.
The purpose of the Base Function Set (MFnBase) is to provide methods for determining whether or not a Function Set is compatible with a given Maya Object (MObject) type (MFn::Type) or a specific MObject. See: MFnBase::hasObj(MFn::Type) and MFnBase::hasObj(const MObject &)
As well, this Function Set provides virtual methods for determining the type of a Function Set under the API RTTI system.
Inheritance diagram for MFnBase:
Public Member Functions | |
| virtual | ~MFnBase () |
| Class Destructor. More... | |
| virtual MFn::Type | type () const |
| Determines the type of the Function Set within the API RTTI system. More... | |
| bool | hasObj (MFn::Type) const |
| Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More... | |
| bool | hasObj (const MObject &) const |
| Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More... | |
| MObject | object (MStatus *ReturnStatus=NULL) const |
| Returns the MObject that is attached to the Function Set. More... | |
| virtual MStatus | setObject (MObject &object) |
| Attaches the Function Set to the specified Maya Object. More... | |
| virtual MStatus | setObject (const MObject &object) |
| NO SCRIPT SUPPORT. More... | |
Static Public Member Functions | |
| static const char * | className () |
| Returns the name of this class. More... | |
Constructor & Destructor Documentation
|
virtual |
Class Destructor.
No additional action.
Member Function Documentation
|
virtual |
Determines the type of the Function Set within the API RTTI system.
- Returns
- Function Set type
Reimplemented in MFnAnimCurve, MFnSubd, MFnMesh, MFnTransform, MFnNurbsSurface, MFnPlugin, MFnNurbsCurve, MFnAssembly, MFnClip, MFnCharacter, MFnBlendShapeDeformer, MFnParticleSystem, MFnDagNode, MFnPluginData, MFnAttribute, MFnIkJoint, MFnLatticeDeformer, MFnNurbsSurfaceData, MFnWeightGeometryFilter, MFnComponent, MFnDynSweptGeometryData, MFnNurbsCurveData, MFnSubdData, MFnSet, MFnDependencyNode, MFnLattice, MFnCompoundAttribute, MFnData, MFnMeshData, MFnCameraSet, MFnMotionPath, MFnNumericAttribute, MFnNIdData, MFnNumericData, MFnRotateManip, MFnScaleManip, MFnSkinCluster, MFnUnitAttribute, MFnKeyframeDeltaTangent, MFnArrayAttrsData, MFnDoubleArrayData, MFnFloatArrayData, MFnGenericAttribute, MFnToggleManip, MFnGeometryData, MFnGeometryFilter, MFnKeyframeDelta, MFnKeyframeDeltaBlockAddRemove, MFnSphereData, MFnDirectionManip, MFnFreePointTriadManip, MFnImageSource, MFnKeyframeDeltaScale, MFnReference, MFnSpotLight, MFnStateManip, MFnWireDeformer, MFnCircleSweepManip, MFnComponentListData, MFnCurveSegmentManip, MFnHikEffector, MFnIntArrayData, MFnKeyframeDeltaInfType, MFnMatrixArrayData, MFnMatrixData, MFnPartition, MFnPointArrayData, MFnPointOnCurveManip, MFnPointOnSurfaceManip, MFnStringArrayData, MFnStringData, MFnUInt64ArrayData, MFnVectorArrayData, MFnContainerNode, MFnDiscManip, MFnLayeredShader, MFnPhongEShader, MFnTypedAttribute, MFnAnisotropyShader, MFnExpression, MFnFluid, MFnIkEffector, MFnIkSolver, MFnLambertShader, MFnLatticeData, MFnManip3D, MFnMessageAttribute, MFnReflectShader, MFnToolContext, MFnCamera, MFnDistanceManip, MFnDragField, MFnNewtonField, MFnNonAmbientLight, MFnNonExtendedLight, MFnRadialField, MFnRenderPass, MFnVortexField, MFnAmbientLight, MFnAreaLight, MFnDirectionalLight, MFnDoubleIndexedComponent, MFnGravityField, MFnKeyframeDeltaMove, MFnLight, MFnLightDataAttribute, MFnPointLight, MFnRenderLayer, MFnSingleIndexedComponent, MFnTripleIndexedComponent, MFnTurbulenceField, MFnUint64SingleIndexedComponent, MFnUniformField, MFnVolumeAxisField, MFnVolumeLight, MFnAirField, MFnBlinnShader, MFnField, MFnIkHandle, MFnPhongShader, MFnEnumAttribute, MFnInstancer, MFnKeyframeDeltaAddRemove, MFnKeyframeDeltaBreakdown, MFnKeyframeDeltaWeighted, MFnMatrixAttribute, MFnNObjectData, and MFnPfxGeometry.
| bool hasObj | ( | MFn::Type | mtype | ) | const |
Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system.
- Parameters
-
[in] mtype Maya Object type
- Returns
- true = Compatible
- false = Not Compatible
- Examples:
| bool hasObj | ( | const MObject & | object | ) | const |
Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system.
- Parameters
-
[in] object Maya Object to be tested for compatibility
- Returns
- true = Compatible
- false = Not Compatible
Returns the MObject that is attached to the Function Set.
- Parameters
-
[in] ReturnStatus Status Code (see below)
- Returns
- An MObject that references the object to which the Function Set is attached. If the function set is not attached to an MObject, MObject::kNullObj will be returned.
- Status Codes:
- MS::kSuccess Success
- MS::kInvalidParameter The Function Set was not attached to an object.
- Examples:
Attaches the Function Set to the specified Maya Object.
- Parameters
-
[in] object Maya Object which is the target for attachment
- Returns
- Status Code (see below)
- Status Codes:
- MS::kSuccess Successful attachment
- MS::kInvalidParameter Invalid parameter passed for object - could not access object, object does not exist or object is incompatible type
Reimplemented in MFnDagNode.
- Examples:
NO SCRIPT SUPPORT.
Attaches the Function Set to the specified read-only Maya Object.
- Parameters
-
[in] object Maya Object which is the target for attachment
- Returns
- Status Code (see below)
- Status Codes:
- MS::kSuccess Successful attachment
- MS::kInvalidParameter Invalid parameter passed for object - could not access object, object does not exist or object is incompatible type
Reimplemented in MFnDagNode.
|
static |
Returns the name of this class.
- Returns
- Name of this class.
The documentation for this class was generated from the following files:
- MFnBase.h
- MFnBase.cpp