Cortex  10.0.0-a4
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
IECoreMaya::OpHolder< BaseType > Class Template Reference

#include <OpHolder.h>

+ Inheritance diagram for IECoreMaya::OpHolder< BaseType >:

Public Member Functions

virtual MStatus setDependentsDirty (const MPlug &plug, MPlugArray &plugArray)
 
virtual MStatus compute (const MPlug &plug, MDataBlock &block)
 
virtual MStatus setParameterised (IECore::RunTimeTypedPtr p)
 
virtual IECore::RunTimeTypedPtr getParameterised (std::string *className=0, int *classVersion=0, std::string *searchPathEnvVar=0)
 
virtual MStatus setOp (const std::string &className, int classVersion)
 
virtual IECore::OpPtr getOp (std::string *className=0, int *classVersion=0, std::string *searchPathEnvVar=0)
 
- Public Member Functions inherited from IECoreMaya::ParameterisedHolder< BaseType >
virtual void postConstructor ()
 
virtual MStatus shouldSave (const MPlug &plug, bool &isSaving)
 
virtual MStatus setParameterised (const std::string &className, int classVersion, const std::string &searchPathEnvVar)
 
virtual MStatus updateParameterised ()
 
virtual MStatus setNodeValues ()
 
virtual MStatus setNodeValue (IECore::ParameterPtr pa)
 
virtual MStatus setParameterisedValues ()
 
virtual MStatus setParameterisedValue (IECore::ParameterPtr pa)
 
virtual MPlug parameterPlug (IECore::ConstParameterPtr parameter)
 
virtual IECore::ParameterPtr plugParameter (const MPlug &plug)
 
- Public Member Functions inherited from IECoreMaya::ParameterisedHolderInterface
IECore::ParameterisedInterfacegetParameterisedInterface ()
 Convenience method to return dynamic_cast<IECore::ParameterisedInterface *>( getParameterised().get() )
 
IECore::ParameterisedInterfacegetParameterisedInterface (std::string *className, int *classVersion=0, std::string *searchPathEnvVar=0)
 

Static Public Member Functions

static void * creator ()
 
static MStatus initialize ()
 
- Static Public Member Functions inherited from IECoreMaya::ParameterisedHolder< BaseType >
static void * creator ()
 
static MStatus initialize ()
 

Static Public Attributes

static MTypeId id
 
- Static Public Attributes inherited from IECoreMaya::ParameterisedHolder< BaseType >
static MTypeId id
 
static MString typeName
 
static MObject aParameterisedClassName
 
static MObject aParameterisedVersion
 
static MObject aParameterisedSearchPathEnvVar
 

Additional Inherited Members

- Protected Member Functions inherited from IECoreMaya::ParameterisedHolder< BaseType >
MStatus setParameterisedValues (bool lazy)
 
MStatus createOrUpdateAttribute (IECore::ParameterPtr parameter, const MString &attributeName, bool callRestore=false)
 Creates an attribute to represent the specified parameter, or updates an existing attribute.
 
- Protected Attributes inherited from IECoreMaya::ParameterisedHolder< BaseType >
IECore::RunTimeTypedPtr m_parameterised
 
bool m_failedToLoad
 
- Static Protected Attributes inherited from IECoreMaya::ParameterisedHolder< BaseType >
static const std::string g_attributeNamePrefix
 

Detailed Description

template<typename BaseType>
class IECoreMaya::OpHolder< BaseType >

The OpHolder class presents op parameters as maya attributes, evaluating the result of the Op within compute() when appropriate.

Member Function Documentation

template<typename BaseType >
virtual IECore::RunTimeTypedPtr IECoreMaya::OpHolder< BaseType >::getParameterised ( std::string *  className = 0,
int *  classVersion = 0,
std::string *  searchPathEnvVar = 0 
)
virtual

Returns the held Parameterised object, loading it if necessary. May return 0 if loading fails. Note that this doesn't update the values of the parameters - you can use the separate setParameterisedValues() call for that. If provided, the optional className, classVersion and searchPathEnvVar are updated to reflect the last values passed to setParameterised - in the case of a 0 return value these values are left unchanged.

Reimplemented from IECoreMaya::ParameterisedHolder< BaseType >.

Referenced by IECoreMaya.FnProceduralHolder::getProcedural(), IECoreMaya.FnParameterisedHolder::ls(), IECoreMaya.FnParameterisedHolder::removeSetClassParameterClassCallback(), and IECoreMaya.FnParameterisedHolder::setParameterised().

template<typename BaseType >
virtual MStatus IECoreMaya::OpHolder< BaseType >::setParameterised ( IECore::RunTimeTypedPtr  p)
virtual

Set the node to hold a particular Parameterised object. When using this version of setParameterised the node will not be able to preserve the object across scene save/load - this becomes your responsibility if it's necessary.

Reimplemented from IECoreMaya::ParameterisedHolder< BaseType >.

Referenced by IECoreMaya.FnProceduralHolder::setProcedural().


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