Cortex  10.0.0-a4
Static Public Member Functions | Protected Member Functions | List of all members
IECoreMaya::ClassVectorParameterHandler Class Reference

#include <ClassVectorParameterHandler.h>

+ Inheritance diagram for IECoreMaya::ClassVectorParameterHandler:

Static Public Member Functions

static MStatus setClasses (IECore::ParameterPtr parameter, const MStringArray &parameterNames, const MStringArray &classNames, const MIntArray &classVersions)
 
static MStatus getClasses (IECore::ConstParameterPtr parameter, MStringArray &parameterNames, MStringArray &classNames, MIntArray &classVersions)
 
static void currentClasses (const MPlug &plug, MStringArray &parameterNames, MStringArray &classNames, MIntArray &classVersions)
 
- Static Public Member Functions inherited from IECoreMaya::ParameterHandler
static MPlug create (IECore::ConstParameterPtr parameter, const MString &plugName, MObject &node)
 
static MStatus update (IECore::ConstParameterPtr parameter, MPlug &plug)
 
static MStatus setValue (IECore::ConstParameterPtr parameter, MPlug &plug)
 Sets the value of plug to reflect the value of parameter.
 
static MStatus setValue (const MPlug &plug, IECore::ParameterPtr parameter)
 Sets the value of parameter to reflect the value of plug.
 
static MStatus restore (const MPlug &plug, IECore::ParameterPtr parameter)
 

Protected Member Functions

virtual MPlug doCreate (IECore::ConstParameterPtr parameter, const MString &plugName, MObject &node) const
 
virtual MStatus doUpdate (IECore::ConstParameterPtr parameter, MPlug &plug) const
 
virtual MStatus doSetValue (IECore::ConstParameterPtr parameter, MPlug &plug) const
 
virtual MStatus doSetValue (const MPlug &plug, IECore::ParameterPtr parameter) const
 
virtual MStatus doRestore (const MPlug &plug, IECore::ParameterPtr parameter) const
 
- Protected Member Functions inherited from IECoreMaya::ParameterHandler
MPlug finishCreating (IECore::ConstParameterPtr parameter, MPlug &plug) const
 
MPlug finishCreating (IECore::ConstParameterPtr parameter, MObject &attribute, MObject &node) const
 An overload for the above function which accepts an attribute for which a plug needs to be made.
 
MStatus finishUpdating (IECore::ConstParameterPtr parameter, MPlug &plug) const
 
MStatus finishUpdating (IECore::ConstParameterPtr parameter, MObject &attribute, MObject &node) const
 An overload for the above function which accepts an attribute for which a plug needs to be made.
 

Additional Inherited Members

- Public Types inherited from IECore::RefCounted
typedef size_t RefCount
 
- Public Member Functions inherited from IECore::RefCounted
 IE_CORE_DECLAREMEMBERPTR (RefCounted)
 
void addRef () const
 Add a reference to the current object.
 
void removeRef () const
 Remove a reference from the current object.
 
RefCount refCount () const
 Returns the current reference count.
 
- Static Protected Member Functions inherited from IECoreMaya::ParameterHandler
static ConstParameterHandlerPtr create (IECore::ConstParameterPtr parameter)
 Return a handler which can deal with the given parameter.
 
static ConstParameterHandlerPtr create (IECore::ConstObjectPtr object)
 Return a handler which can deal with the given object.
 
static ConstParameterHandlerPtr create (IECore::TypeId id)
 Return a handler which can deal with an object or parameter of the given type id.
 

Detailed Description

A ParameterHandler which deals with ClassVectorParameters. Note that no attempt is made to represent the child parameters - separate calls to other parameter handlers should be used to do that.

Member Function Documentation

static void IECoreMaya::ClassVectorParameterHandler::currentClasses ( const MPlug &  plug,
MStringArray &  parameterNames,
MStringArray &  classNames,
MIntArray &  classVersions 
)
static

Can be used to query the details of the classes currently being held by the parameter represented by the specified plug. Note that this returns the classes currently being represented in maya, which may not be the same as the classes on the parameter if the two have not been synchronised. Again, this function typically shouldn't be called directly, as a combination of direct access to parameters and IECoreMaya.FnParameterisedHolder should be enough to achieve most things.

static MStatus IECoreMaya::ClassVectorParameterHandler::getClasses ( IECore::ConstParameterPtr  parameter,
MStringArray &  parameterNames,
MStringArray &  classNames,
MIntArray &  classVersions 
)
static

Convenience function for getting the classes held by parameter. This has nothing to do with the maya representation of the classes whatsoever - see below for that.

static MStatus IECoreMaya::ClassVectorParameterHandler::setClasses ( IECore::ParameterPtr  parameter,
const MStringArray &  parameterNames,
const MStringArray &  classNames,
const MIntArray &  classVersions 
)
static

Convenience function for setting the class held by parameter. This makes no changes to the maya representation of the parameter whatsoever.


The documentation for this class was generated from the following file: