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

#include <ParameterisedHolderInterface.h>

+ Inheritance diagram for IECoreHoudini::ParameterisedHolderInterface:

Public Member Functions

virtual void setParameterised (const std::string &className, int classVersion, const std::string &searchPathEnvVar)=0
 
virtual void setParameterised (IECore::RunTimeTypedPtr p)=0
 Sets the Parameterised object this node is holding, directly.
 
virtual bool hasParameterised ()=0
 Returns whether or not this node is holding a valid parameterised object.
 
virtual IECore::RunTimeTypedPtr getParameterised ()=0
 Returns the parameterised object held by this node.
 
IECore::ParameterisedInterfacegetParameterisedInterface ()
 Convenience method to return dynamic_cast<IECore::ParameterisedInterface *>( getParameterised().get() )
 
virtual bool setNodeValues ()=0
 
virtual void setParameterisedValues (double time)=0
 Sets the values of the parameters of the held Parameterised object to reflect the values.
 

Detailed Description

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

Member Function Documentation

virtual bool IECoreHoudini::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 false if

Implemented in IECoreHoudini::ParameterisedHolder< BaseType >, and IECoreHoudini::ParameterisedHolder< SOP_Node >.

virtual void IECoreHoudini::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 houdini scene is opened.

Implemented in IECoreHoudini::ParameterisedHolder< BaseType >, and IECoreHoudini::ParameterisedHolder< SOP_Node >.


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