Feature::Implementation< Policy > Class Template Referenceabstract
#include <Feature.hh>
Public Member Functions | |
virtual | ~Implementation ()=default |
Virtual destructor. More... | |
virtual Identity | InitiateEngine (std::size_t engineID=0)=0 |
Tell the physics plugin to initiate a physics engine. More... | |
Constructor & Destructor Documentation
◆ ~Implementation()
|
virtualdefault |
Virtual destructor.
Member Function Documentation
◆ InitiateEngine()
|
pure virtual |
Tell the physics plugin to initiate a physics engine.
Some physics plugins might be able to provide multiple simultaneous physics engines, in which case engineID might vary. The meaning of engineID is implementation-defined, but every physics plugins must support at least engineID==0 to be well-formed. If a physics plugin only supports having one engine at a time, then it may only support engineID==0.
- Returns
- The Identity of the physics engine. For engineID==0 this should also return an Identity whose id is 0. In the event of an error (or an invalid engineID), the Identity id should be INVALID_ENTITY_ID.
The documentation for this class was generated from the following file: