vtkTimestepsAnimationPlayer Class Reference

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

#include <vtkTimestepsAnimationPlayer.h>

Inheritance diagram for vtkTimestepsAnimationPlayer:

Collaboration diagram for vtkTimestepsAnimationPlayer:

List of all members.

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	RemoveAllTimeSteps ()
unsigned int	GetNumberOfTimeSteps ()
double	GetNextTimeStep (double time)
void	AddTimeStep (double time)
void	RemoveTimeStep (double time)
virtual void	SetFramesPerTimestep (unsigned long)
virtual unsigned long	GetFramesPerTimestep ()
Static Public Member Functions
static vtkTimestepsAnimationPlayer *	New ()
static int	IsTypeOf (const char *type)
static vtkTimestepsAnimationPlayer *	SafeDownCast (vtkObject *o)
Protected Member Functions
virtual void	StartLoop (double, double, double)
virtual void	EndLoop ()
virtual double	GetNextTime (double currentime)
virtual double	GoToNext (double, double, double currenttime)
virtual double	GoToPrevious (double, double, double currenttime)
Protected Attributes
unsigned long	FramesPerTimestep
unsigned long	Count
double	GetPreviousTimeStep (double time)
	vtkTimestepsAnimationPlayer ()
	~vtkTimestepsAnimationPlayer ()

---

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 30 of file vtkTimestepsAnimationPlayer.h.

---

Constructor & Destructor Documentation

vtkTimestepsAnimationPlayer::vtkTimestepsAnimationPlayer

(

)

[protected]

Returns the timestep value before the given timestep. If no value exists, returns the argument time itself.

vtkTimestepsAnimationPlayer::~vtkTimestepsAnimationPlayer

(

)

[protected]

Returns the timestep value before the given timestep. If no value exists, returns the argument time itself.

---

Member Function Documentation

static vtkTimestepsAnimationPlayer* vtkTimestepsAnimationPlayer::New

(

)

[static]

Reimplemented from vtkObject.

virtual const char* vtkTimestepsAnimationPlayer::GetClassName

(

)

[virtual]

Reimplemented from vtkAnimationPlayer.

static int vtkTimestepsAnimationPlayer::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkAnimationPlayer.

virtual int vtkTimestepsAnimationPlayer::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkAnimationPlayer.

static vtkTimestepsAnimationPlayer* vtkTimestepsAnimationPlayer::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkAnimationPlayer.

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

Reimplemented from vtkAnimationPlayer.

void vtkTimestepsAnimationPlayer::AddTimeStep

(

double

time

)

Add/Remove timesteps.

void vtkTimestepsAnimationPlayer::RemoveTimeStep

(

double

time

)

Add/Remove timesteps.

void vtkTimestepsAnimationPlayer::RemoveAllTimeSteps

(

)

Remove all timesteps.

unsigned int vtkTimestepsAnimationPlayer::GetNumberOfTimeSteps

(

)

Get number of timesteps.

virtual void vtkTimestepsAnimationPlayer::SetFramesPerTimestep

(

unsigned

long

)

[virtual]

Get/Set the number of frames per timstep.

virtual unsigned long vtkTimestepsAnimationPlayer::GetFramesPerTimestep

(

)

[virtual]

Get/Set the number of frames per timstep.

double vtkTimestepsAnimationPlayer::GetNextTimeStep

(

double

time

)

Returns the timestep value after the given timestep. If no value exists, returns the argument time itself.

double vtkTimestepsAnimationPlayer::GetPreviousTimeStep

(

double

time

)

Returns the timestep value before the given timestep. If no value exists, returns the argument time itself.

virtual void vtkTimestepsAnimationPlayer::StartLoop	(	double	,
		double	,
		double
	)		[protected, virtual]

Implements vtkAnimationPlayer.

virtual void vtkTimestepsAnimationPlayer::EndLoop

(

)

[inline, protected, virtual]

Implements vtkAnimationPlayer.

Definition at line 69 of file vtkTimestepsAnimationPlayer.h.

virtual double vtkTimestepsAnimationPlayer::GetNextTime

(

double

currentime

)

[protected, virtual]

Return the next time given the current time.

Implements vtkAnimationPlayer.

virtual double vtkTimestepsAnimationPlayer::GoToNext	(	double	,
		double	,
		double	currenttime
	)		[inline, protected, virtual]

Implements vtkAnimationPlayer.

Definition at line 75 of file vtkTimestepsAnimationPlayer.h.

virtual double vtkTimestepsAnimationPlayer::GoToPrevious	(	double	,
		double	,
		double	currenttime
	)		[inline, protected, virtual]

Implements vtkAnimationPlayer.

Definition at line 80 of file vtkTimestepsAnimationPlayer.h.

---

Member Data Documentation

unsigned long vtkTimestepsAnimationPlayer::FramesPerTimestep [protected]

Definition at line 85 of file vtkTimestepsAnimationPlayer.h.

unsigned long vtkTimestepsAnimationPlayer::Count [protected]

Definition at line 86 of file vtkTimestepsAnimationPlayer.h.

---

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

• dox/ParaViewCore/VTKExtensions/vtkTimestepsAnimationPlayer.h