HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SIM_DataFactoryCreator Class Reference

#include <SIM_DataFactory.h>

Public Types

typedef void(* SIM_DataFactoryCreateFunc )(SIM_Engine *engine)
 Defines a function for creating a SIM_DataFactory. More...
 

Public Member Functions

 SIM_DataFactoryCreator (SIM_DataFactoryCreateFunc createfunc)
 
 ~SIM_DataFactoryCreator ()
 
const UT_StringgetSource () const
 
void createDataFactory (SIM_Engine *engine)
 Call the creation function to make a new SIM_DataFactory instance. More...
 

Static Public Member Functions

static void addDataFactory (SIM_Engine *engine, SIM_DataFactory *factory)
 Call addDataFactory on the specified SIM_Engine. More...
 

Detailed Description

This helper class lets each SIM_Engine create an instance of each SIM_DataFactory available on the system.

Definition at line 96 of file SIM_DataFactory.h.

Member Typedef Documentation

typedef void(* SIM_DataFactoryCreator::SIM_DataFactoryCreateFunc)(SIM_Engine *engine)

Defines a function for creating a SIM_DataFactory.

Definition at line 100 of file SIM_DataFactory.h.

Constructor & Destructor Documentation

SIM_DataFactoryCreator::SIM_DataFactoryCreator ( SIM_DataFactoryCreateFunc  createfunc)

Constructor sets the SIM_DataFactory creation function. It also registers this SIM_DataFactoryCreator instance with the global list in the SIM_Engine class.

SIM_DataFactoryCreator::~SIM_DataFactoryCreator ( )

Destructor which removes this SIM_DataFactoryCreator from the global list owned by the SIM_Engine class.

Member Function Documentation

static void SIM_DataFactoryCreator::addDataFactory ( SIM_Engine engine,
SIM_DataFactory factory 
)
static

Call addDataFactory on the specified SIM_Engine.

void SIM_DataFactoryCreator::createDataFactory ( SIM_Engine engine)

Call the creation function to make a new SIM_DataFactory instance.

const UT_String& SIM_DataFactoryCreator::getSource ( ) const

Returns the name of the DSO or DLL file that defines the data type. For data types defined internally to Houdini the returned string will be empty.


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