ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
vtkAnimationPlayer Class Referenceabstract

Abstract superclass for an animation player. More...

#include <vtkAnimationPlayer.h>

Inheritance diagram for vtkAnimationPlayer:
Inheritance graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void Play ()
 Start playing the animation. More...
 
void Stop ()
 Stop playing the animation. More...
 
int IsInPlay ()
 Returns if the animation is currently playing. More...
 
virtual bool GetInPlay ()
 
void GoToNext ()
 Take the animation scene to next frame. More...
 
void GoToPrevious ()
 Take animation scene to previous frame. More...
 
void GoToFirst ()
 Take animation scene to first frame. More...
 
void GoToLast ()
 Take animation scene to last frame. More...
 
virtual void SetAnimationScene (vtkSMAnimationScene *)
 Set the animation scene that is to be played by this player. More...
 
vtkSMAnimationSceneGetAnimationScene ()
 Set the animation scene that is to be played by this player. More...
 
virtual void SetLoop (bool)
 Set to true to play the animation in a loop. More...
 
virtual bool GetLoop ()
 Set to true to play the animation in a loop. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkAnimationPlayerSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkAnimationPlayer ()
 
 ~vtkAnimationPlayer ()
 
virtual void StartLoop (double starttime, double endtime, double *playbackWindow)=0
 
virtual void EndLoop ()=0
 
virtual double GetNextTime (double currentime)=0
 Return the next time given the current time. More...
 
virtual double GoToNext (double start, double end, double currenttime)=0
 
virtual double GoToPrevious (double start, double end, double currenttime)=0
 

Friends

class vtkCompositeAnimationPlayer
 

Detailed Description

Abstract superclass for an animation player.

Definition at line 29 of file vtkAnimationPlayer.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkAnimationPlayer::Superclass

Definition at line 32 of file vtkAnimationPlayer.h.

Constructor & Destructor Documentation

◆ vtkAnimationPlayer()

vtkAnimationPlayer::vtkAnimationPlayer ( )
protected

◆ ~vtkAnimationPlayer()

vtkAnimationPlayer::~vtkAnimationPlayer ( )
protected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkAnimationPlayer::GetClassName ( )
virtual

◆ IsTypeOf()

static int vtkAnimationPlayer::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkAnimationPlayer::IsA ( const char *  type)
virtual

◆ SafeDownCast()

static vtkAnimationPlayer* vtkAnimationPlayer::SafeDownCast ( vtkObject *  o)
static

◆ PrintSelf()

void vtkAnimationPlayer::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

◆ SetAnimationScene()

virtual void vtkAnimationPlayer::SetAnimationScene ( vtkSMAnimationScene )
virtual

Set the animation scene that is to be played by this player.

Note that the animation scene is not reference counted to avoid loops.

◆ GetAnimationScene()

vtkSMAnimationScene* vtkAnimationPlayer::GetAnimationScene ( )

Set the animation scene that is to be played by this player.

Note that the animation scene is not reference counted to avoid loops.

◆ Play()

void vtkAnimationPlayer::Play ( )

Start playing the animation.

Fires StartEvent when play begins and EndEvent when play stops.

◆ Stop()

void vtkAnimationPlayer::Stop ( )

Stop playing the animation.

◆ IsInPlay()

int vtkAnimationPlayer::IsInPlay ( )
inline

Returns if the animation is currently playing.

Definition at line 58 of file vtkAnimationPlayer.h.

◆ GetInPlay()

virtual bool vtkAnimationPlayer::GetInPlay ( )
virtual

◆ SetLoop()

virtual void vtkAnimationPlayer::SetLoop ( bool  )
virtual

Set to true to play the animation in a loop.

◆ GetLoop()

virtual bool vtkAnimationPlayer::GetLoop ( )
virtual

Set to true to play the animation in a loop.

◆ GoToNext() [1/2]

void vtkAnimationPlayer::GoToNext ( )

Take the animation scene to next frame.

◆ GoToPrevious() [1/2]

void vtkAnimationPlayer::GoToPrevious ( )

Take animation scene to previous frame.

◆ GoToFirst()

void vtkAnimationPlayer::GoToFirst ( )

Take animation scene to first frame.

◆ GoToLast()

void vtkAnimationPlayer::GoToLast ( )

Take animation scene to last frame.

◆ StartLoop()

virtual void vtkAnimationPlayer::StartLoop ( double  starttime,
double  endtime,
double *  playbackWindow 
)
protectedpure virtual

◆ EndLoop()

virtual void vtkAnimationPlayer::EndLoop ( )
protectedpure virtual

◆ GetNextTime()

virtual double vtkAnimationPlayer::GetNextTime ( double  currentime)
protectedpure virtual

Return the next time given the current time.

Implemented in vtkTimestepsAnimationPlayer, vtkCompositeAnimationPlayer, vtkRealtimeAnimationPlayer, and vtkSequenceAnimationPlayer.

◆ GoToNext() [2/2]

virtual double vtkAnimationPlayer::GoToNext ( double  start,
double  end,
double  currenttime 
)
protectedpure virtual

◆ GoToPrevious() [2/2]

virtual double vtkAnimationPlayer::GoToPrevious ( double  start,
double  end,
double  currenttime 
)
protectedpure virtual

Friends And Related Function Documentation

◆ vtkCompositeAnimationPlayer

friend class vtkCompositeAnimationPlayer
friend

Definition at line 93 of file vtkAnimationPlayer.h.


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