Mitsuba Renderer  0.5.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
mitsuba::Utility Class Referenceabstract

Abstract utility class – can be used to implement loadable utility plugins that perform various actions. They can be started using the 'mtsutil' launcher. More...

#include <mitsuba/render/util.h>

+ Inheritance diagram for mitsuba::Utility:

Public Member Functions

virtual int run (int argc, char **argv)=0
 
virtual const ClassgetClass () const
 Retrieve this object's class. More...
 
- Public Member Functions inherited from Object
 Object ()
 Construct a new object. More...
 
int getRefCount () const
 Return the current reference count. More...
 
void incRef () const
 Increase the reference count of the object by one. More...
 
void decRef (bool autoDeallocate=true) const
 Decrease the reference count of the object and possibly deallocate it. More...
 
virtual std::string toString () const
 Return a human-readable string representation of the object's contents. More...
 

Static Public Attributes

static Classm_theClass
 
- Static Public Attributes inherited from Object
static Classm_theClass
 Pointer to the object's class descriptor. More...
 

Protected Types

typedef std::map< std::string,
std::string,
SimpleStringOrdering
ParameterMap
 

Protected Member Functions

virtual ~Utility ()
 Virtual destructor. More...
 
ref< SceneloadScene (const fs::path &fname, const ParameterMap &params=ParameterMap())
 Load a scene from an external file. More...
 
ref< SceneloadSceneFromString (const std::string &content, const ParameterMap &params=ParameterMap())
 Load a scene from a string. More...
 
- Protected Member Functions inherited from Object
virtual ~Object ()
 Virtual private deconstructor. (Will only be called by ref) More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
static void staticInitialization ()
 Initializes the built-in reference count debugger (if enabled) More...
 
static void staticShutdown ()
 Free the memory taken by staticInitialization() More...
 

Detailed Description

Abstract utility class – can be used to implement loadable utility plugins that perform various actions. They can be started using the 'mtsutil' launcher.

Member Typedef Documentation

typedef std::map<std::string, std::string, SimpleStringOrdering> mitsuba::Utility::ParameterMap
protected

Constructor & Destructor Documentation

virtual mitsuba::Utility::~Utility ( )
inlineprotectedvirtual

Virtual destructor.

Member Function Documentation

virtual const Class* mitsuba::Utility::getClass ( ) const
virtual

Retrieve this object's class.

Reimplemented from Object.

Reimplemented in mitsuba::TestCase.

ref<Scene> mitsuba::Utility::loadScene ( const fs::path &  fname,
const ParameterMap params = ParameterMap() 
)
protected

Load a scene from an external file.

ref<Scene> mitsuba::Utility::loadSceneFromString ( const std::string &  content,
const ParameterMap params = ParameterMap() 
)
protected

Load a scene from a string.

virtual int mitsuba::Utility::run ( int  argc,
char **  argv 
)
pure virtual

Run the utility. The supplied argc and argv parameters contain any extra arguments passed to mtsutil. The value returned here will be used as the return value of the 'mtsutil' process.

Implemented in mitsuba::Viewer.

Member Data Documentation

Class* mitsuba::Utility::m_theClass
static

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