Cortex  10.0.0-a4
Public Member Functions | List of all members
IECoreMaya::ParameterisedHolderInterface Class Referenceabstract

#include <ParameterisedHolderInterface.h>

+ Inheritance diagram for IECoreMaya::ParameterisedHolderInterface:

Public Member Functions

virtual MStatus setParameterised (const std::string &className, int classVersion, const std::string &searchPathEnvVar)=0
 
virtual MStatus setParameterised (IECore::RunTimeTypedPtr p)=0
 Sets the Parameterised object this node is holding, directly.
 
virtual MStatus updateParameterised ()=0
 
virtual IECore::RunTimeTypedPtr getParameterised (std::string *className=0, int *classVersion=0, std::string *searchPathEnvVar=0)=0
 
IECore::ParameterisedInterfacegetParameterisedInterface ()
 Convenience method to return dynamic_cast<IECore::ParameterisedInterface *>( getParameterised().get() )
 
IECore::ParameterisedInterfacegetParameterisedInterface (std::string *className, int *classVersion=0, std::string *searchPathEnvVar=0)
 
virtual MStatus setNodeValues ()=0
 
virtual MStatus setNodeValue (IECore::ParameterPtr pa)=0
 
virtual MStatus setParameterisedValues ()=0
 
virtual MStatus setParameterisedValue (IECore::ParameterPtr pa)=0
 
virtual MPlug parameterPlug (IECore::ConstParameterPtr parameter)=0
 
virtual IECore::ParameterPtr plugParameter (const MPlug &plug)=0
 

Detailed Description

A base class from which nodes to hold IECore::ParameterisedInterface objects should multiply inherit (for example, Maya RI procedurals).

Member Function Documentation

virtual IECore::RunTimeTypedPtr IECoreMaya::ParameterisedHolderInterface::getParameterised ( std::string *  className = 0,
int *  classVersion = 0,
std::string *  searchPathEnvVar = 0 
)
pure 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.

Implemented in IECoreMaya::ParameterisedHolder< BaseType >, and IECoreMaya::OpHolder< BaseType >.

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

IECore::ParameterisedInterface* IECoreMaya::ParameterisedHolderInterface::getParameterisedInterface ( std::string *  className,
int *  classVersion = 0,
std::string *  searchPathEnvVar = 0 
)
Todo:
Remove version with no arguments and default className to 0 as well.
virtual MPlug IECoreMaya::ParameterisedHolderInterface::parameterPlug ( IECore::ConstParameterPtr  parameter)
pure virtual

Returns the plug used to represent the specified parameter, which should be a child of getParameterised()->parameters(). On failure returns a plug for which plug.isNull() returns true.

Implemented in IECoreMaya::ParameterisedHolder< BaseType >.

Referenced by IECoreMaya.FnParameterisedHolder::setNodeValue().

virtual IECore::ParameterPtr IECoreMaya::ParameterisedHolderInterface::plugParameter ( const MPlug &  plug)
pure virtual

Returns the parameter represented by the specified plug, returning 0 if no such parameter exists.

Implemented in IECoreMaya::ParameterisedHolder< BaseType >.

virtual MStatus IECoreMaya::ParameterisedHolderInterface::setNodeValue ( IECore::ParameterPtr  pa)
pure virtual

Sets the attribute of the node to reflect the current value of the specified parameter in the held Parameterised object. Performs validation of the parameter values and will return kFailure if any one is not valid.

Implemented in IECoreMaya::ParameterisedHolder< BaseType >.

virtual MStatus IECoreMaya::ParameterisedHolderInterface::setNodeValues ( )
pure virtual

Sets the attributes of the node to reflect the current values of the parameters in the held Parameterised object. Performs validation of the parameter values and will return kFailure if any one is not valid.

Implemented in IECoreMaya::ParameterisedHolder< BaseType >.

virtual MStatus IECoreMaya::ParameterisedHolderInterface::setParameterised ( const std::string &  className,
int  classVersion,
const std::string &  searchPathEnvVar 
)
pure virtual

Sets the Parameterised object this node is holding. An IECore.ClassLoader object will be used with searchpaths obtained from the specified environment variable to actually load the Parameterised object. This mechanism is used rather than passing a ParameterisedPtr as it allows the Parameterised object to be loaded again when a maya scene is opened.

Implemented in IECoreMaya::ParameterisedHolder< BaseType >.

Referenced by IECoreMaya.FnProceduralHolder::setProcedural().

virtual MStatus IECoreMaya::ParameterisedHolderInterface::setParameterisedValue ( IECore::ParameterPtr  pa)
pure virtual

Sets the value of the specified parameter of the held Parameterised object to reflect the value of the corresponding attribute on the node. Performs validation of the parameter values and will return kFailure if any one in not valid.

Implemented in IECoreMaya::ParameterisedHolder< BaseType >.

virtual MStatus IECoreMaya::ParameterisedHolderInterface::setParameterisedValues ( )
pure virtual

Sets the values of the parameters of the held Parameterised object to reflect the values of the attributes of the node. Performs validation of the parameter values and will return kFailure if any one in not valid.

Implemented in IECoreMaya::ParameterisedHolder< BaseType >.

Referenced by IECoreMaya.FnParameterisedHolder::setParameterised().

virtual MStatus IECoreMaya::ParameterisedHolderInterface::updateParameterised ( )
pure virtual

Updates this object to represent any changes in the held parameters. It is the responsibility of the caller to ensure that there is some means of preserving these changes across file save/open if this is desired - the ClassParameterHandler provides an example of doing this.

Implemented in IECoreMaya::ParameterisedHolder< BaseType >.


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