Cortex  10.0.0-a4
Public Member Functions | Protected Member Functions | List of all members
IECoreHoudini::SOP_ParameterisedHolder Class Reference

Class representing a SOP node acting as a holder for the abstract Parameterised class. More...

#include <SOP_ParameterisedHolder.h>

+ Inheritance diagram for IECoreHoudini::SOP_ParameterisedHolder:

Public Member Functions

 SOP_ParameterisedHolder (OP_Network *net, const char *name, OP_Operator *op)
 
virtual void getNodeSpecificInfoText (OP_Context &context, OP_NodeInfoParms &parms)
 
- Public Member Functions inherited from IECoreHoudini::ParameterisedHolder< SOP_Node >
 ParameterisedHolder (OP_Network *net, const char *name, OP_Operator *op)
 
virtual const char * inputLabel (unsigned pos) const
 
virtual unsigned minInputs () const
 
virtual unsigned maxInputs () const
 
virtual void setParameterised (IECore::RunTimeTypedPtr p)
 
virtual void setParameterised (const std::string &className, int classVersion, const std::string &searchPathEnvVar)
 
virtual bool hasParameterised ()
 Returns whether or not this node is holding a valid parameterised object.
 
virtual IECore::RunTimeTypedPtr getParameterised ()
 Returns the parameterised object held by this node.
 
virtual bool setNodeValues ()
 
virtual void setParameterisedValues (double time)
 Sets the values of the parameters of the held Parameterised object to reflect the values.
 
- Public Member Functions inherited from IECoreHoudini::ParameterisedHolderInterface
IECore::ParameterisedInterfacegetParameterisedInterface ()
 Convenience method to return dynamic_cast<IECore::ParameterisedInterface *>( getParameterised().get() )
 

Protected Member Functions

virtual void setInputParameterValues (float now)
 
virtual void setInputParameterValue (IECore::Parameter *parameter, const GU_DetailHandle &handle, unsigned inputIndex)
 
GU_DetailHandle filteredInputValue (const IECore::Parameter *parameter, unsigned inputIndex)
 
bool getNameFilter (const IECore::Parameter *parameter, UT_StringMMPattern &filter)
 Used to find and evaluate the nameFilter, if it is enabled.
 
virtual void refreshInputConnections ()
 Updates the input connections for parameters relevant to FromHoudiniGeometryConverters.
 
- Protected Member Functions inherited from IECoreHoudini::ParameterisedHolder< SOP_Node >
virtual bool load (UT_IStream &is, const char *ext, const char *path)
 
virtual IECore::MessageHandlergetMessageHandler ()
 
virtual void setMessageHandler (IECore::MessageHandler *handler)
 
void updateParameter (IECore::ParameterPtr parm, float now, std::string prefix="", bool top_level=false)
 

Additional Inherited Members

- Static Public Member Functions inherited from IECoreHoudini::ParameterisedHolder< SOP_Node >
static void buildClassCategoryMenu (void *data, PRM_Name *menu, int maxSize, const PRM_SpareData *, const PRM_Parm *)
 
static void buildClassNameMenu (void *data, PRM_Name *menu, int maxSize, const PRM_SpareData *, const PRM_Parm *)
 
static void buildVersionMenu (void *data, PRM_Name *menu, int maxSize, const PRM_SpareData *, const PRM_Parm *)
 
static int reloadClassCallback (void *data, int index, float time, const PRM_Template *tplate)
 
static int reloadButtonCallback (void *data, int index, float time, const PRM_Template *tplate)
 
static void classNames (const std::string searchPathEnvVar, const std::string &matchString, std::vector< std::string > &names)
 
static void classVersions (const std::string className, const std::string searchPathEnvVar, std::vector< int > &versions)
 
static int defaultClassVersion (const std::string className, const std::string searchPathEnvVar)
 
- Static Public Attributes inherited from IECoreHoudini::ParameterisedHolder< SOP_Node >
static PRM_Template parameters []
 
static CH_LocalVariable variables []
 
static PRM_Name pParameterisedClassCategory
 
static PRM_Name pParameterisedClassName
 
static PRM_Name pParameterisedVersion
 
static PRM_Name pParameterisedSearchPathEnvVar
 
static PRM_Name pMatchString
 
static PRM_Name pReloadButton
 
static PRM_Name pEvaluateParameters
 
static PRM_Name pSwitcher
 
static PRM_Default matchStringDefault
 
static PRM_Default switcherDefaults []
 
static PRM_ChoiceList classCategoryMenu
 
static PRM_ChoiceList classNameMenu
 
static PRM_ChoiceList classVersionMenu
 
- Protected Attributes inherited from IECoreHoudini::ParameterisedHolder< SOP_Node >
IECore::CompoundParameter::ParameterVector m_inputParameters
 
bool m_dirty
 Determines if the node is dirty.
 

Detailed Description

Class representing a SOP node acting as a holder for the abstract Parameterised class.

Member Function Documentation

GU_DetailHandle IECoreHoudini::SOP_ParameterisedHolder::filteredInputValue ( const IECore::Parameter parameter,
unsigned  inputIndex 
)
protected

Used to pre-filter the input geometry during setInputParameterValue. It checks for the existance of a nameFilter parm cooresponding to the input parameter, and uses FromHoudiniGeometryConverter::extract to limit the input geometry based on that filter.

virtual void IECoreHoudini::SOP_ParameterisedHolder::setInputParameterValue ( IECore::Parameter parameter,
const GU_DetailHandle &  handle,
unsigned  inputIndex 
)
protectedvirtual

Used by setInputParameterValues to set the value on each individual input parameter. Providing a null handle will result in the default behaviour of using the filteredInputValue for this input.

Reimplemented in IECoreHoudini::SOP_OpHolder.

virtual void IECoreHoudini::SOP_ParameterisedHolder::setInputParameterValues ( float  now)
protectedvirtual

Pushes the geometry data from the incomming connections into the associated Cortex parameters. This method will cook the incomming nodes. If the input node derives from SOP_ParameterisedHolder, it's Cortex output will be passed through. If it is a native Houdini node, it will be converted using the appropriate FromHoudiniGeometryConverter.

Implements IECoreHoudini::ParameterisedHolder< SOP_Node >.


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