SPH
Public Member Functions | List of all members
Movie Class Reference

Object managing periodic rendering of images and saving them to given paths. More...

#include <Movie.h>

Inheritance diagram for Movie:
Noncopyable

Public Member Functions

 Movie (const GuiSettings &settings, AutoPtr< IRenderer > &&renderer, Array< AutoPtr< IColorizer >> &&colorizers, RenderParams &&params)
 
 ~Movie ()
 
void onTimeStep (const Storage &storage, Statistics &stats)
 Called every time step, saves the images every IMAGES_TIMESTEP. More...
 
void save (const Storage &storage, Statistics &stats)
 Manually saves the images. More...
 
void setCamera (AutoPtr< ICamera > &&camera)
 
void finalize ()
 Creates the animations from generated images. More...
 
void setEnabled (const bool enable=true)
 
- Public Member Functions inherited from Noncopyable
 Noncopyable ()=default
 
 Noncopyable (const Noncopyable &)=delete
 
 Noncopyable (Noncopyable &&)=default
 
Noncopyableoperator= (const Noncopyable &)=delete
 
Noncopyableoperator= (Noncopyable &&)=default
 

Detailed Description

Object managing periodic rendering of images and saving them to given paths.

Rendered images are independend from the images in interactive window, i.e. they have dedicated renderer, camera and list of colorizers to render.

Definition at line 22 of file Movie.h.

Constructor & Destructor Documentation

◆ Movie()

Movie::Movie ( const GuiSettings settings,
AutoPtr< IRenderer > &&  renderer,
Array< AutoPtr< IColorizer >> &&  colorizers,
RenderParams &&  params 
)

Definition at line 22 of file Movie.cpp.

◆ ~Movie()

Movie::~Movie ( )
default

Member Function Documentation

◆ finalize()

void Movie::finalize ( )

Creates the animations from generated images.

Definition at line 161 of file Movie.cpp.

◆ onTimeStep()

void Movie::onTimeStep ( const Storage storage,
Statistics stats 
)

Called every time step, saves the images every IMAGES_TIMESTEP.

If the time since the last frame is less than the required framerate, function does nothing. If the run starts at negative time, no images are dumped till the time passes zero, consistently with Output implementations.

Can be called from any thread; the function is blocking, waits until all images are saved.

Definition at line 103 of file Movie.cpp.

◆ save()

void Movie::save ( const Storage storage,
Statistics stats 
)

Manually saves the images.

Definition at line 112 of file Movie.cpp.

◆ setCamera()

void Movie::setCamera ( AutoPtr< ICamera > &&  camera)

Definition at line 157 of file Movie.cpp.

◆ setEnabled()

void Movie::setEnabled ( const bool  enable = true)

Definition at line 187 of file Movie.cpp.


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