User Tools

Site Tools


DzSimulationEngine

Base class for all simulation engines.

More...

Inherits :

Methods

Signals

voidaboutToSimulate ( DzSimulationEngine engine )
voidsimulateFinished ( DzSimulationEngine engine )
voidsimulationError ( String errorMsg )

Detailed Description

Implements a simulation engine.

Since:

  • 4.9.4.1

Methods


DzError : clearSimulation()

Clears all simulation data in the scene for this engine.


DzError : customSimulate( Array nodes )

Starts a custom simulation on the list of nodes specified, using this engine.

Parameter(s):

  • nodes - The list of nodes to perform the simulation on.

Array : getSimulationElements( Array list )

Return Value:

  • A list of elements that hold the properties for controlling this engine.

DzError : simulate()

Starts a simulation using this engine.

Signals


void : aboutToSimulate( DzSimulationEngine engine )

Signature:“aboutToSimulate(DzSimulationEngine*)”

Emitted just before the engine begins simulating.

Parameter(s):

  • engine - This engine.

void : simulateFinished( DzSimulationEngine engine )

Signature:“simulateFinished(DzSimulationEngine*)”

Emitted just after the engine finishes simulating.

Parameter(s):

  • engine - This engine.

void : simulationError( String errorMsg )

Signature:“simulationError(const QString&)”

Emitted when an error occurs while the engine is simulating.

Parameter(s):

  • errorMsg - The error message.