Cortex  10.0.0-a4
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
IECoreHoudini::OBJ_SceneCacheNode< BaseType > Class Template Referenceabstract

#include <OBJ_SceneCacheNode.h>

+ Inheritance diagram for IECoreHoudini::OBJ_SceneCacheNode< BaseType >:

Public Member Functions

 OBJ_SceneCacheNode (OP_Network *net, const char *name, OP_Operator *op)
 
virtual void expandHierarchy (const IECore::SceneInterface *scene)=0
 Derived classes should define this function to expand the hierarchy contained in the SceneCache.
 
virtual void pushToHierarchy ()=0
 
virtual void collapseHierarchy ()
 Implemented to destroy all child nodes.
 
- Public Member Functions inherited from IECoreHoudini::SceneCacheNode< BaseType >
 SceneCacheNode (OP_Network *net, const char *name, OP_Operator *op)
 
std::string getFile () const
 convenience methods for the common parameters;
 
void setFile (std::string file)
 
std::string getPath () const
 
void setPath (const IECore::SceneInterface *scene)
 
Space getSpace () const
 
void setSpace (Space space)
 
GeometryType getGeometryType () const
 
void setGeometryType (GeometryType type)
 
void getAttributeFilter (UT_String &filter) const
 
void getAttributeFilter (UT_StringMMPattern &filter) const
 
void setAttributeFilter (const UT_String &filter)
 
void getAttributeCopy (UT_String &value) const
 
void setAttributeCopy (const UT_String &value)
 
void getTagFilter (UT_String &filter) const
 
void getTagFilter (UT_StringMMPattern &filter) const
 
void setTagFilter (const UT_String &filter)
 
bool getTagGroups () const
 
void setTagGroups (bool tagGroups)
 
void getShapeFilter (UT_String &filter) const
 
void getShapeFilter (UT_StringMMPattern &filter) const
 
void setShapeFilter (const UT_String &filter)
 
void getFullPathName (UT_String &name) const
 
void setFullPathName (const UT_String &name)
 
void referenceParent (const char *parmName)
 
IECore::ConstSceneInterfacePtr scene () const
 
double time (OP_Context context) const
 

Static Public Member Functions

static PRM_Template * buildParameters (OP_TemplatePair *extraParameters=0)
 
static int expandButtonCallback (void *data, int index, float time, const PRM_Template *tplate)
 
static int pushButtonCallback (void *data, int index, float time, const PRM_Template *tplate)
 
static int collapseButtonCallback (void *data, int index, float time, const PRM_Template *tplate)
 
- Static Public Member Functions inherited from IECoreHoudini::SceneCacheNode< BaseType >
static int sceneParmChangedCallback (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 buildRootMenu (void *data, PRM_Name *menu, int maxSize, const PRM_SpareData *, const PRM_Parm *)
 
static void buildTagFilterMenu (void *data, PRM_Name *menu, int maxSize, const PRM_SpareData *, const PRM_Parm *)
 
static void buildShapeFilterMenu (void *data, PRM_Name *menu, int maxSize, const PRM_SpareData *, const PRM_Parm *)
 
static bool tagged (const IECore::SceneInterface *scene, const UT_StringMMPattern &filter)
 Determine if the given scene has any tag matching the filter.
 

Static Public Attributes

static PRM_Name pMainSwitcher
 
static PRM_Name pExpand
 
static PRM_Name pPush
 
static PRM_Name pCollapse
 
static PRM_Name pExpanded
 
static PRM_Name pOverrideTransform
 
static PRM_Name pOutTranslate
 
static PRM_Name pOutRotate
 
static PRM_Name pOutScale
 
- Static Public Attributes inherited from IECoreHoudini::SceneCacheNode< BaseType >
static PRM_Name pFile
 
static PRM_Name pRoot
 
static PRM_Name pSpace
 
static PRM_Name pReload
 
static PRM_Name pGeometryType
 
static PRM_Name pAttributeFilter
 
static PRM_Name pAttributeCopy
 
static PRM_Name pTagFilter
 
static PRM_Name pTagGroups
 
static PRM_Name pShapeFilter
 
static PRM_Name pFullPathName
 
static PRM_Default rootDefault
 
static PRM_Default spaceDefault
 
static PRM_Default filterDefault
 
static PRM_Default geometryTypeDefault
 
static PRM_ChoiceList rootMenu
 
static PRM_ChoiceList spaceList
 
static PRM_ChoiceList geometryTypeList
 
static PRM_ChoiceList attributeCopyMenu
 
static PRM_ChoiceList tagFilterMenu
 
static PRM_ChoiceList shapeFilterMenu
 

Protected Member Functions

virtual void sceneChanged ()
 
virtual OP_ERROR cookMyObj (OP_Context &context)
 
virtual bool getParmTransform (OP_Context &context, UT_DMatrix4 &xform)
 
virtual bool updateParmsFlags ()
 
void updateState ()
 
- Protected Member Functions inherited from IECoreHoudini::SceneCacheNode< BaseType >
Imath::M44d worldTransform (const std::string &fileName, const std::string &path, double time)
 Computes the worldTransform for the specified path.
 
bool ensureFile (std::string &file)
 get the file and ensure it is a valid SCC
 
void descendantNames (const IECore::SceneInterface *scene, std::vector< std::string > &descendants)
 get a breadth first list of all descendant paths
 
void objectNames (const IECore::SceneInterface *scene, std::vector< std::string > &objects)
 get a depth first list of all object names
 
void createMenu (PRM_Name *menu, const std::vector< std::string > &values)
 utility method to build a UI menu from one of the previous lists
 

Protected Attributes

UT_Matrix4D m_xform
 
- Protected Attributes inherited from IECoreHoudini::SceneCacheNode< BaseType >
bool m_loaded
 
boost::tribool m_static
 
IECore::MurmurHash m_hash
 

Additional Inherited Members

- Public Types inherited from IECoreHoudini::SceneCacheNode< BaseType >
enum  Space { World, Path, Local, Object }
 
enum  GeometryType { Cortex, Houdini, BoundingBox, PointCloud }
 
- Static Protected Member Functions inherited from IECoreHoudini::SceneCacheNode< BaseType >
static IECore::ConstSceneInterfacePtr scene (const std::string &fileName, const std::string &path)
 
static std::string getFullScenePath (const IECore::SceneInterface *scene)
 get the full path to a scene including the name
 
static OP_TemplatePair * buildMainParameters ()
 
static OP_TemplatePair * buildOptionParameters ()
 

Detailed Description

template<typename BaseType>
class IECoreHoudini::OBJ_SceneCacheNode< BaseType >

Abstract base class for all OBJ SceneCacheNodes. See OBJ_SceneCacheGeometry or OBJ_SceneCacheTransform for specific implementations.

Member Function Documentation

template<typename BaseType>
virtual void IECoreHoudini::OBJ_SceneCacheNode< BaseType >::sceneChanged ( )
protectedvirtual

Called from setFile, setPath, and when either the file or path parameters are changed. The default implementation sets m_loaded false. Derived nodes may override this if convenient.

Reimplemented from IECoreHoudini::SceneCacheNode< BaseType >.


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