Privacy
An open-source, flexible 3D physical simulation framework
Public Member Functions | Static Public Member Functions | List of all members
mars::interfaces::SimulatorInterface Class Referenceabstract

#include <SimulatorInterface.h>

Public Member Functions

virtual ~SimulatorInterface ()
 
virtual void runSimulation (bool startThread=true)=0
 
virtual void step (bool setState=false)=0
 
virtual void StartSimulation ()=0
 
virtual void StopSimulation ()=0
 
virtual void resetSim (bool resetGraphics=true)=0
 
virtual bool isSimRunning () const =0
 
virtual bool startStopTrigger ()=0
 
virtual void singleStep (void)=0
 
virtual void newWorld (bool clear_all=false)=0
 
virtual void exitMars (void)=0
 
virtual void readArguments (int argc, char **argv)=0
 
virtual ControlCenter * getControlCenter (void) const =0
 
virtual void addLight (LightData light)=0
 
virtual void connectNodes (unsigned long id1, unsigned long id2)=0
 
virtual void disconnectNodes (unsigned long id1, unsigned long id2)=0
 
virtual void rescaleEnvironment (sReal x, sReal y, sReal z)=0
 
virtual int loadScene (const std::string &filename, const std::string &robotname, bool threadsave=false, bool blocking=false)=0
 
virtual int loadScene (const std::string &filename, bool wasrunning=false, const std::string &robotname="", bool threadsave=false, bool blocking=false)=0
 
virtual int saveScene (const std::string &filename, bool wasrunning)=0
 
virtual void exportScene () const =0
 make sure the string objects exist during the execution of those functions even if they are running in a different thread; it would probably be better to just copy them instead of using references More...
 
virtual bool sceneChanged () const =0
 
virtual void sceneHasChanged (bool reset)=0
 
bool allConcurrencysHandled ()
 
virtual void setSyncThreads (bool value)=0
 
virtual void physicsThreadLock (void)=0
 
virtual void physicsThreadUnlock (void)=0
 
virtual PhysicsInterface * getPhysics (void) const =0
 
virtual void handleError (PhysicsError error)=0
 
virtual void setGravity (const utils::Vector &gravity)=0
 
virtual const utils::Vector & getGravity (void)=0
 
virtual int checkCollisions (void)=0
 
virtual bool hasSimFault () const =0
 
virtual void finishedDraw (void)=0
 
virtual void allowDraw (void)=0
 
virtual bool getAllowDraw (void)=0
 
virtual bool getSyncGraphics (void)=0
 
virtual void addPlugin (const pluginStruct &plugin)=0
 
virtual void removePlugin (PluginInterface *pl)=0
 
virtual void switchPluginUpdateMode (int mode, PluginInterface *pl)=0
 
virtual void sendDataToPlugin (int plugin_index, void *data)=0
 
virtual unsigned long getTime ()=0
 

Static Public Member Functions

static SimulatorInterface * getInstance (lib_manager::LibManager *libManager)
 

Detailed Description

Definition at line 50 of file SimulatorInterface.h.

Constructor & Destructor Documentation

◆ ~SimulatorInterface()

virtual mars::interfaces::SimulatorInterface::~SimulatorInterface ( )
inlinevirtual

Definition at line 54 of file SimulatorInterface.h.

Member Function Documentation

◆ addLight()

virtual void mars::interfaces::SimulatorInterface::addLight ( LightData  light)
pure virtual

Implemented in mars::sim::Simulator.

◆ addPlugin()

virtual void mars::interfaces::SimulatorInterface::addPlugin ( const pluginStruct &  plugin)
pure virtual

Implemented in mars::sim::Simulator.

◆ allConcurrencysHandled()

bool mars::interfaces::SimulatorInterface::allConcurrencysHandled ( )

◆ allowDraw()

virtual void mars::interfaces::SimulatorInterface::allowDraw ( void  )
pure virtual

Implemented in mars::sim::Simulator.

◆ checkCollisions()

virtual int mars::interfaces::SimulatorInterface::checkCollisions ( void  )
pure virtual

Implemented in mars::sim::Simulator.

◆ connectNodes()

virtual void mars::interfaces::SimulatorInterface::connectNodes ( unsigned long  id1,
unsigned long  id2 
)
pure virtual

Implemented in mars::sim::Simulator.

◆ disconnectNodes()

virtual void mars::interfaces::SimulatorInterface::disconnectNodes ( unsigned long  id1,
unsigned long  id2 
)
pure virtual

Implemented in mars::sim::Simulator.

◆ exitMars()

virtual void mars::interfaces::SimulatorInterface::exitMars ( void  )
pure virtual

Implemented in mars::sim::Simulator.

◆ exportScene()

virtual void mars::interfaces::SimulatorInterface::exportScene ( ) const
pure virtual

make sure the string objects exist during the execution of those functions even if they are running in a different thread; it would probably be better to just copy them instead of using references

Implemented in mars::sim::Simulator.

◆ finishedDraw()

virtual void mars::interfaces::SimulatorInterface::finishedDraw ( void  )
pure virtual

Implemented in mars::sim::Simulator.

◆ getAllowDraw()

virtual bool mars::interfaces::SimulatorInterface::getAllowDraw ( void  )
pure virtual

Implemented in mars::sim::Simulator.

◆ getControlCenter()

virtual ControlCenter* mars::interfaces::SimulatorInterface::getControlCenter ( void  ) const
pure virtual

Implemented in mars::sim::Simulator.

◆ getGravity()

virtual const utils::Vector& mars::interfaces::SimulatorInterface::getGravity ( void  )
pure virtual

Implemented in mars::sim::Simulator.

◆ getInstance()

SimulatorInterface * mars::interfaces::SimulatorInterface::getInstance ( lib_manager::LibManager *  libManager)
static

Definition at line 1395 of file Simulator.cpp.

◆ getPhysics()

virtual PhysicsInterface* mars::interfaces::SimulatorInterface::getPhysics ( void  ) const
pure virtual

Implemented in mars::sim::Simulator.

◆ getSyncGraphics()

virtual bool mars::interfaces::SimulatorInterface::getSyncGraphics ( void  )
pure virtual

Implemented in mars::sim::Simulator.

◆ getTime()

virtual unsigned long mars::interfaces::SimulatorInterface::getTime ( )
pure virtual

Implemented in mars::sim::Simulator.

◆ handleError()

virtual void mars::interfaces::SimulatorInterface::handleError ( PhysicsError  error)
pure virtual

Implemented in mars::sim::Simulator.

◆ hasSimFault()

virtual bool mars::interfaces::SimulatorInterface::hasSimFault ( ) const
pure virtual

Implemented in mars::sim::Simulator.

◆ isSimRunning()

virtual bool mars::interfaces::SimulatorInterface::isSimRunning ( ) const
pure virtual

Implemented in mars::sim::Simulator.

◆ loadScene() [1/2]

virtual int mars::interfaces::SimulatorInterface::loadScene ( const std::string &  filename,
const std::string &  robotname,
bool  threadsave = false,
bool  blocking = false 
)
pure virtual

Implemented in mars::sim::Simulator.

◆ loadScene() [2/2]

virtual int mars::interfaces::SimulatorInterface::loadScene ( const std::string &  filename,
bool  wasrunning = false,
const std::string &  robotname = "",
bool  threadsave = false,
bool  blocking = false 
)
pure virtual

Implemented in mars::sim::Simulator.

◆ newWorld()

virtual void mars::interfaces::SimulatorInterface::newWorld ( bool  clear_all = false)
pure virtual

Implemented in mars::sim::Simulator.

◆ physicsThreadLock()

virtual void mars::interfaces::SimulatorInterface::physicsThreadLock ( void  )
pure virtual

Implemented in mars::sim::Simulator.

◆ physicsThreadUnlock()

virtual void mars::interfaces::SimulatorInterface::physicsThreadUnlock ( void  )
pure virtual

Implemented in mars::sim::Simulator.

◆ readArguments()

virtual void mars::interfaces::SimulatorInterface::readArguments ( int  argc,
char **  argv 
)
pure virtual

Implemented in mars::sim::Simulator.

◆ removePlugin()

virtual void mars::interfaces::SimulatorInterface::removePlugin ( PluginInterface *  pl)
pure virtual

Implemented in mars::sim::Simulator.

◆ rescaleEnvironment()

virtual void mars::interfaces::SimulatorInterface::rescaleEnvironment ( sReal  x,
sReal  y,
sReal  z 
)
pure virtual

Implemented in mars::sim::Simulator.

◆ resetSim()

virtual void mars::interfaces::SimulatorInterface::resetSim ( bool  resetGraphics = true)
pure virtual

Implemented in mars::sim::Simulator.

◆ runSimulation()

virtual void mars::interfaces::SimulatorInterface::runSimulation ( bool  startThread = true)
pure virtual

Implemented in mars::sim::Simulator.

◆ saveScene()

virtual int mars::interfaces::SimulatorInterface::saveScene ( const std::string &  filename,
bool  wasrunning 
)
pure virtual

Implemented in mars::sim::Simulator.

◆ sceneChanged()

virtual bool mars::interfaces::SimulatorInterface::sceneChanged ( ) const
pure virtual

Implemented in mars::sim::Simulator.

◆ sceneHasChanged()

virtual void mars::interfaces::SimulatorInterface::sceneHasChanged ( bool  reset)
pure virtual

Implemented in mars::sim::Simulator.

◆ sendDataToPlugin()

virtual void mars::interfaces::SimulatorInterface::sendDataToPlugin ( int  plugin_index,
void *  data 
)
pure virtual

Implemented in mars::sim::Simulator.

◆ setGravity()

virtual void mars::interfaces::SimulatorInterface::setGravity ( const utils::Vector &  gravity)
pure virtual

Implemented in mars::sim::Simulator.

◆ setSyncThreads()

virtual void mars::interfaces::SimulatorInterface::setSyncThreads ( bool  value)
pure virtual

Implemented in mars::sim::Simulator.

◆ singleStep()

virtual void mars::interfaces::SimulatorInterface::singleStep ( void  )
pure virtual

Implemented in mars::sim::Simulator.

◆ StartSimulation()

virtual void mars::interfaces::SimulatorInterface::StartSimulation ( )
pure virtual

Implemented in mars::sim::Simulator.

◆ startStopTrigger()

virtual bool mars::interfaces::SimulatorInterface::startStopTrigger ( )
pure virtual

Implemented in mars::sim::Simulator.

◆ step()

virtual void mars::interfaces::SimulatorInterface::step ( bool  setState = false)
pure virtual

Implemented in mars::sim::Simulator.

◆ StopSimulation()

virtual void mars::interfaces::SimulatorInterface::StopSimulation ( )
pure virtual

Implemented in mars::sim::Simulator.

◆ switchPluginUpdateMode()

virtual void mars::interfaces::SimulatorInterface::switchPluginUpdateMode ( int  mode,
PluginInterface *  pl 
)
pure virtual

Implemented in mars::sim::Simulator.

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