Class GraphicalSceneMovie

Class GraphicalSceneMovie#

Inheritance Relationships#

Base Type#

  • public Karana::Models::KModel< GraphicalSceneMovie, GraphicalSceneMovieParams > (Template Class KModel)

Class Documentation#

class GraphicalSceneMovie : public Karana::Models::KModel<GraphicalSceneMovie, GraphicalSceneMovieParams>#

The GraphicalSceneMovie model updates the visualization at each postHop.

Public Functions

GraphicalSceneMovie(std::string_view name, const kc::ks_ptr<kd::StatePropagator> &sp, const kc::ks_ptr<ks::ProxyScene> &scene)#

GraphicalSceneMovie constructor. The constructor is not meant to be called directly. Please use the create(…) method instead to create an instance.

Parameters:

  • name – The name of the GraphicalSceneMovie model.

  • sp – The StatePropagator to register this model with.

  • scene – The ProxyScene whose graphics() scene’s frames will be rendered to create a movie.

~GraphicalSceneMovie()#

Destructor for GraphicalSceneMovie.

void postModelStep(const km::Ktime &t, const km::Vec &x)#

Update the GraphicalScene.

Parameters:

  • t – Current time. Not used.

  • x – Current state. Not used.

std::string getFfmpegCommand() const#

Get the ffmpeg command you should run to turn the images into a movie.

Returns:

The ffmpeg command you should run to turn the images into a movie as a string.

Public Static Functions

static kc::ks_ptr<GraphicalSceneMovie> create(std::string_view name, const kc::ks_ptr<kd::StatePropagator> &sp, const kc::ks_ptr<ks::ProxyScene> &scene)#

Constructor.

Parameters:

  • name – The name of the GraphicalSceneMovie model.

  • sp – The StatePropagator to register this model with.

  • scene – The ProxyScene whose graphics() scene’s frames will be rendered to create a movie.

Returns:

A ks_ptr to the newly created instance of the GraphicalSceneMovie model.

Protected Functions

virtual void _registerModel() override#

Register the model.

virtual void _unregisterModel() override#

Unregister the model.

Contents