Murl::Physics::IFactory Interface Reference

The factory used to create and destroy physics simulators. More...

#include "murl_physics_i_factory.h"

Inheritance diagram for Murl::Physics::IFactory:

Public Member Functions
virtual Bool	Init ()=0
	Initialize the factory. More...
virtual Bool	DeInit ()=0
	Deinitialize the factory. More...
virtual ISimulator *	CreateDefaultSimulator ()=0
	Create a default physics simulator. More...
virtual ISimulator *	CreateSimulator (const String &className)=0
	Create a physics simulator from the set of registered simulators. More...
virtual ISimulator *	CreateSimulator (const ISimulator::ClassInfo &classInfo)=0
	Create a physics simulator from the set of registered simulators. More...
virtual Bool	DestroySimulator (ISimulator *&simulator)=0
	Destroy a previously created physics simulator. More...
Public Member Functions inherited from Murl::Physics::IFactoryRegistry
virtual Bool	RegisterSimulatorClass (const ISimulator::ClassInfo &classInfo)=0
	Register a physics simulator class. More...
virtual Bool	UnregisterSimulatorClass (const ISimulator::ClassInfo &classInfo)=0
	Unregister a previously registered physics simulator class. More...
virtual SInt32	GetRegisteredSimulatorClassInfoIndex (const ISimulator::ClassInfo &classInfo) const =0
	Query the index of a registered physics simulator class, by its ClassInfo structure. More...
virtual SInt32	GetRegisteredSimulatorClassInfoIndex (const String &className) const =0
	Query the index of a registered physics simulator class, by its class name. More...
virtual UInt32	GetNumberOfRegisteredSimulatorClassInfos () const =0
	Get the total number of registered physics simulator classes. More...
virtual const ISimulator::ClassInfo *	GetRegisteredSimulatorClassInfo (UInt32 index) const =0
	Get the ClassInfo structure of a registered physics simulator class. More...

Detailed Description

The factory used to create and destroy physics simulators.

Use the Physics::IFactoryRegistry base interface for managing registered simulator classes.

Member Function Documentation

Init()

virtual Bool Murl::Physics::IFactory::Init ( )

pure virtual

Initialize the factory.

Returns

true if successful.

DeInit()

virtual Bool Murl::Physics::IFactory::DeInit ( )

pure virtual

Deinitialize the factory.

Returns

true if successful.

CreateDefaultSimulator()

virtual ISimulator* Murl::Physics::IFactory::CreateDefaultSimulator ( )

pure virtual

Create a default physics simulator.

Returns

The newly created simulator, or null if failed.

CreateSimulator() [1/2]

virtual ISimulator* Murl::Physics::IFactory::CreateSimulator ( const String &  className )

pure virtual

Create a physics simulator from the set of registered simulators.

Parameters

className

The class name of the simulator to create.

Returns

The newly created simulator, or null if failed.

CreateSimulator() [2/2]

virtual ISimulator* Murl::Physics::IFactory::CreateSimulator ( const ISimulator::ClassInfo &  classInfo )

pure virtual

Create a physics simulator from the set of registered simulators.

Parameters

classInfo

The ClassInfo structure of the simulator to create.

Returns

The newly created simulator, or null if failed.

DestroySimulator()

virtual Bool Murl::Physics::IFactory::DestroySimulator ( ISimulator *&  simulator )

pure virtual

Destroy a previously created physics simulator.

Parameters

simulator

A reference to a pointer holding the simulator to destroy.

Returns

true if successful.

---

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

• murl_physics_i_factory.h