ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkTimestepsAnimationPlayer Class Reference

vtkAnimationPlayer subclass that plays through a discrete set of time values. More...

#include <vtkTimestepsAnimationPlayer.h>

Inheritance diagram for vtkTimestepsAnimationPlayer:
Inheritance graph
[legend]
Collaboration diagram for vtkTimestepsAnimationPlayer:
Collaboration graph
[legend]

Public Types

typedef vtkAnimationPlayer Superclass
 
- Public Types inherited from vtkAnimationPlayer
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void RemoveAllTimeSteps ()
 Remove all timesteps. More...
 
unsigned int GetNumberOfTimeSteps ()
 Get number of timesteps. More...
 
double GetNextTimeStep (double time)
 Returns the timestep value after the given timestep. More...
 
void AddTimeStep (double time)
 Add/Remove timesteps. More...
 
void RemoveTimeStep (double time)
 Add/Remove timesteps. More...
 
virtual void SetFramesPerTimestep (unsigned long)
 Get/Set the number of frames per timstep. More...
 
virtual unsigned long GetFramesPerTimestep ()
 Get/Set the number of frames per timstep. More...
 
- Public Member Functions inherited from vtkAnimationPlayer
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 vtkTimestepsAnimationPlayerNew ()
 
static int IsTypeOf (const char *type)
 
static vtkTimestepsAnimationPlayerSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkAnimationPlayer
static int IsTypeOf (const char *type)
 
static vtkAnimationPlayerSafeDownCast (vtkObject *o)
 

Protected Member Functions

virtual void StartLoop (double, double, double *)
 
virtual void EndLoop ()
 
virtual double GetNextTime (double currentime)
 Return the next time given the current time. More...
 
virtual double GoToNext (double, double, double currenttime)
 
virtual double GoToPrevious (double, double, double currenttime)
 
- Protected Member Functions inherited from vtkAnimationPlayer
 vtkAnimationPlayer ()
 
 ~vtkAnimationPlayer ()
 

Protected Attributes

double PlaybackWindow [2]
 
unsigned long FramesPerTimestep
 
unsigned long Count
 
double GetPreviousTimeStep (double time)
 Returns the timestep value before the given timestep. More...
 
 vtkTimestepsAnimationPlayer ()
 Returns the timestep value before the given timestep. More...
 
 ~vtkTimestepsAnimationPlayer ()
 Returns the timestep value before the given timestep. More...
 

Detailed Description

vtkAnimationPlayer subclass that plays through a discrete set of time values.

Player to play an animation scene through a discrete set of time values. FramesPerTimestep controls how many frames are generated for each time value.

Definition at line 32 of file vtkTimestepsAnimationPlayer.h.

Member Typedef Documentation

§ Superclass

Definition at line 36 of file vtkTimestepsAnimationPlayer.h.

Constructor & Destructor Documentation

§ vtkTimestepsAnimationPlayer()

vtkTimestepsAnimationPlayer::vtkTimestepsAnimationPlayer ( )
protected

Returns the timestep value before the given timestep.

If no value exists, returns the argument time itself.

§ ~vtkTimestepsAnimationPlayer()

vtkTimestepsAnimationPlayer::~vtkTimestepsAnimationPlayer ( )
protected

Returns the timestep value before the given timestep.

If no value exists, returns the argument time itself.

Member Function Documentation

§ New()

static vtkTimestepsAnimationPlayer* vtkTimestepsAnimationPlayer::New ( )
static

§ GetClassName()

virtual const char* vtkTimestepsAnimationPlayer::GetClassName ( )
virtual

Reimplemented from vtkAnimationPlayer.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkAnimationPlayer.

§ SafeDownCast()

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

§ PrintSelf()

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

§ AddTimeStep()

void vtkTimestepsAnimationPlayer::AddTimeStep ( double  time)

Add/Remove timesteps.

§ RemoveTimeStep()

void vtkTimestepsAnimationPlayer::RemoveTimeStep ( double  time)

Add/Remove timesteps.

§ RemoveAllTimeSteps()

void vtkTimestepsAnimationPlayer::RemoveAllTimeSteps ( )

Remove all timesteps.

§ GetNumberOfTimeSteps()

unsigned int vtkTimestepsAnimationPlayer::GetNumberOfTimeSteps ( )

Get number of timesteps.

§ SetFramesPerTimestep()

virtual void vtkTimestepsAnimationPlayer::SetFramesPerTimestep ( unsigned  long)
virtual

Get/Set the number of frames per timstep.

§ GetFramesPerTimestep()

virtual unsigned long vtkTimestepsAnimationPlayer::GetFramesPerTimestep ( )
virtual

Get/Set the number of frames per timstep.

§ GetNextTimeStep()

double vtkTimestepsAnimationPlayer::GetNextTimeStep ( double  time)

Returns the timestep value after the given timestep.

If no value exists, returns the argument time itself.

§ GetPreviousTimeStep()

double vtkTimestepsAnimationPlayer::GetPreviousTimeStep ( double  time)

Returns the timestep value before the given timestep.

If no value exists, returns the argument time itself.

§ StartLoop()

virtual void vtkTimestepsAnimationPlayer::StartLoop ( double  ,
double  ,
double *   
)
protectedvirtual

Implements vtkAnimationPlayer.

§ EndLoop()

virtual void vtkTimestepsAnimationPlayer::EndLoop ( )
inlineprotectedvirtual

Implements vtkAnimationPlayer.

Definition at line 84 of file vtkTimestepsAnimationPlayer.h.

§ GetNextTime()

virtual double vtkTimestepsAnimationPlayer::GetNextTime ( double  currentime)
protectedvirtual

Return the next time given the current time.

Implements vtkAnimationPlayer.

§ GoToNext()

virtual double vtkTimestepsAnimationPlayer::GoToNext ( double  ,
double  ,
double  currenttime 
)
inlineprotectedvirtual

Implements vtkAnimationPlayer.

Definition at line 91 of file vtkTimestepsAnimationPlayer.h.

§ GoToPrevious()

virtual double vtkTimestepsAnimationPlayer::GoToPrevious ( double  ,
double  ,
double  currenttime 
)
inlineprotectedvirtual

Implements vtkAnimationPlayer.

Definition at line 96 of file vtkTimestepsAnimationPlayer.h.

Member Data Documentation

§ PlaybackWindow

double vtkTimestepsAnimationPlayer::PlaybackWindow[2]
protected

Definition at line 101 of file vtkTimestepsAnimationPlayer.h.

§ FramesPerTimestep

unsigned long vtkTimestepsAnimationPlayer::FramesPerTimestep
protected

Definition at line 102 of file vtkTimestepsAnimationPlayer.h.

§ Count

unsigned long vtkTimestepsAnimationPlayer::Count
protected

Definition at line 103 of file vtkTimestepsAnimationPlayer.h.


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