Medical Imaging Interaction Toolkit  2022.04.99-b2814023
Medical Imaging Interaction Toolkit
mitk::MovieGenerator Class Referenceabstract

#include <mitkMovieGenerator.h>

Inheritance diagram for mitk::MovieGenerator:
Collaboration diagram for mitk::MovieGenerator:

Public Member Functions

 mitkClassMacroItkParent (MovieGenerator, itk::LightObject)
 
virtual void SetStepper (Stepper *stepper)
 stepper used to control movie generation More...
 
virtual void SetRenderer (BaseRenderer *renderer)
 renderer to record More...
 
virtual void SetFileName (const char *fileName)
 filename under which movie is saved More...
 
virtual bool WriteMovie ()
 uses given stepper and filename to create a movie from the active OpenGL context More...
 
virtual bool WriteCurrentFrameToMovie ()
 alternative way, which does not use a stepper; More...
 
virtual void ReleaseMovieWriter ()
 releases a movie writer after usage of WriteCurrentFrameToMovie() More...
 
virtual void SetFrameRate (unsigned int rate)
 
unsigned int GetFrameRate ()
 

Static Public Member Functions

static Pointer New (void)
 

Protected Member Functions

 MovieGenerator ()
 default constructor More...
 
virtual bool InitGenerator ()=0
 called directly before the first frame is added, determines movie size from renderer More...
 
virtual bool AddFrame (void *data)=0
 used to add a frame More...
 
virtual bool TerminateGenerator ()=0
 called after the last frame is added More...
 

Protected Attributes

char m_fileName [1024]
 stores the movie filename More...
 
Stepperm_stepper
 stores the used stepper More...
 
BaseRendererm_renderer
 stores the uses renderer More...
 
int m_width
 InitGenerator() stores movie size in those variables. More...
 
int m_height
 
bool m_initialized
 
unsigned int m_FrameRate
 

Detailed Description

Definition at line 24 of file mitkMovieGenerator.h.

Constructor & Destructor Documentation

◆ MovieGenerator()

mitk::MovieGenerator::MovieGenerator ( )
protected

default constructor

Member Function Documentation

◆ AddFrame()

virtual bool mitk::MovieGenerator::AddFrame ( void *  data)
protectedpure virtual

used to add a frame

Implemented in mitk::MovieGeneratorOpenCV, and mitk::MovieGeneratorWin32.

◆ GetFrameRate()

unsigned int mitk::MovieGenerator::GetFrameRate ( )

◆ InitGenerator()

virtual bool mitk::MovieGenerator::InitGenerator ( )
protectedpure virtual

called directly before the first frame is added, determines movie size from renderer

Implemented in mitk::MovieGeneratorOpenCV, and mitk::MovieGeneratorWin32.

◆ mitkClassMacroItkParent()

mitk::MovieGenerator::mitkClassMacroItkParent ( MovieGenerator  ,
itk::LightObject   
)

◆ New()

static Pointer mitk::MovieGenerator::New ( void  )
static

◆ ReleaseMovieWriter()

virtual void mitk::MovieGenerator::ReleaseMovieWriter ( )
virtual

releases a movie writer after usage of WriteCurrentFrameToMovie()

◆ SetFileName()

virtual void mitk::MovieGenerator::SetFileName ( const char *  fileName)
inlinevirtual

filename under which movie is saved

Reimplemented in mitk::MovieGeneratorOpenCV, and mitk::MovieGeneratorWin32.

Definition at line 37 of file mitkMovieGenerator.h.

◆ SetFrameRate()

virtual void mitk::MovieGenerator::SetFrameRate ( unsigned int  rate)
virtual

Reimplemented in mitk::MovieGeneratorOpenCV.

◆ SetRenderer()

virtual void mitk::MovieGenerator::SetRenderer ( BaseRenderer renderer)
inlinevirtual

renderer to record

Definition at line 35 of file mitkMovieGenerator.h.

◆ SetStepper()

virtual void mitk::MovieGenerator::SetStepper ( Stepper stepper)
inlinevirtual

stepper used to control movie generation

Definition at line 33 of file mitkMovieGenerator.h.

◆ TerminateGenerator()

virtual bool mitk::MovieGenerator::TerminateGenerator ( )
protectedpure virtual

called after the last frame is added

Implemented in mitk::MovieGeneratorOpenCV, and mitk::MovieGeneratorWin32.

◆ WriteCurrentFrameToMovie()

virtual bool mitk::MovieGenerator::WriteCurrentFrameToMovie ( )
virtual

alternative way, which does not use a stepper;

◆ WriteMovie()

virtual bool mitk::MovieGenerator::WriteMovie ( )
virtual

uses given stepper and filename to create a movie from the active OpenGL context

Member Data Documentation

◆ m_fileName

char mitk::MovieGenerator::m_fileName[1024]
protected

stores the movie filename

Definition at line 66 of file mitkMovieGenerator.h.

◆ m_FrameRate

unsigned int mitk::MovieGenerator::m_FrameRate
protected

Definition at line 79 of file mitkMovieGenerator.h.

◆ m_height

int mitk::MovieGenerator::m_height
protected

Definition at line 75 of file mitkMovieGenerator.h.

◆ m_initialized

bool mitk::MovieGenerator::m_initialized
protected

Definition at line 77 of file mitkMovieGenerator.h.

◆ m_renderer

BaseRenderer* mitk::MovieGenerator::m_renderer
protected

stores the uses renderer

Definition at line 72 of file mitkMovieGenerator.h.

◆ m_stepper

Stepper* mitk::MovieGenerator::m_stepper
protected

stores the used stepper

Definition at line 69 of file mitkMovieGenerator.h.

◆ m_width

int mitk::MovieGenerator::m_width
protected

InitGenerator() stores movie size in those variables.

Definition at line 75 of file mitkMovieGenerator.h.


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