vtkCompositeAnimationPlayer Class Reference

#include <vtkCompositeAnimationPlayer.h>

Inheritance diagram for vtkCompositeAnimationPlayer:

Collaboration diagram for vtkCompositeAnimationPlayer:

List of all members.

Public Types
enum	Modes { SEQUENCE = 0, REAL_TIME = 1, SNAP_TO_TIMESTEPS = 2 }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetNumberOfFrames (int val)
void	SetDuration (int val)
virtual void	SetPlayMode (int)
virtual int	GetPlayMode ()
void	AddTimeStep (double val)
void	RemoveAllTimeSteps ()
void	SetFramesPerTimestep (int val)
Static Public Member Functions
static vtkCompositeAnimationPlayer *	New ()
static int	IsTypeOf (const char *type)
static vtkCompositeAnimationPlayer *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkCompositeAnimationPlayer ()
	~vtkCompositeAnimationPlayer ()
virtual double	GoToNext (double start, double end, double currenttime)
virtual double	GoToPrevious (double start, double end, double currenttime)
vtkAnimationPlayer *	GetActivePlayer ()
virtual void	StartLoop (double starttime, double endtime, double currenttime)
virtual void	EndLoop ()
virtual double	GetNextTime (double currentime)
Protected Attributes
vtkSequenceAnimationPlayer *	SequenceAnimationPlayer
vtkRealtimeAnimationPlayer *	RealtimeAnimationPlayer
vtkTimestepsAnimationPlayer *	TimestepsAnimationPlayer
int	PlayMode

---

Detailed Description

This is composite animation player that can me made to play an animation using the active player. It provides API to add animation players and then set one of them as the active one.

Definition at line 31 of file vtkCompositeAnimationPlayer.h.

---

Member Enumeration Documentation

enum vtkCompositeAnimationPlayer::Modes

Enumerator:

SEQUENCE
REAL_TIME
SNAP_TO_TIMESTEPS

Definition at line 38 of file vtkCompositeAnimationPlayer.h.

---

Constructor & Destructor Documentation

vtkCompositeAnimationPlayer::vtkCompositeAnimationPlayer

(

)

[protected]

vtkCompositeAnimationPlayer::~vtkCompositeAnimationPlayer

(

)

[protected]

---

Member Function Documentation

static vtkCompositeAnimationPlayer* vtkCompositeAnimationPlayer::New

(

)

[static]

Reimplemented from vtkObject.

virtual const char* vtkCompositeAnimationPlayer::GetClassName

(

)

[virtual]

Reimplemented from vtkAnimationPlayer.

static int vtkCompositeAnimationPlayer::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkAnimationPlayer.

virtual int vtkCompositeAnimationPlayer::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkAnimationPlayer.

static vtkCompositeAnimationPlayer* vtkCompositeAnimationPlayer::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkAnimationPlayer.

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

Reimplemented from vtkAnimationPlayer.

virtual void vtkCompositeAnimationPlayer::SetPlayMode

(

int

)

[virtual]

Get/Set the play mode

virtual int vtkCompositeAnimationPlayer::GetPlayMode

(

)

[virtual]

Get/Set the play mode

void vtkCompositeAnimationPlayer::SetNumberOfFrames

(

int

val

)

Forwarded to vtkSequenceAnimationPlayer

void vtkCompositeAnimationPlayer::SetDuration

(

int

val

)

Forwarded to vtkRealtimeAnimationPlayer.

void vtkCompositeAnimationPlayer::AddTimeStep

(

double

val

)

Forwarded to vtkTimestepsAnimationPlayer.

void vtkCompositeAnimationPlayer::RemoveAllTimeSteps

(

)

Forwarded to vtkTimestepsAnimationPlayer.

void vtkCompositeAnimationPlayer::SetFramesPerTimestep

(

int

val

)

Forwarded to vtkTimestepsAnimationPlayer.

virtual void vtkCompositeAnimationPlayer::StartLoop	(	double	starttime,
		double	endtime,
		double	currenttime
	)		[protected, virtual]

Delegated to the active animation player.

Implements vtkAnimationPlayer.

virtual void vtkCompositeAnimationPlayer::EndLoop

(

)

[protected, virtual]

Delegated to the active animation player.

Implements vtkAnimationPlayer.

virtual double vtkCompositeAnimationPlayer::GetNextTime

(

double

currentime

)

[protected, virtual]

Delegated to the active animation player.

Implements vtkAnimationPlayer.

virtual double vtkCompositeAnimationPlayer::GoToNext	(	double	start,
		double	end,
		double	currenttime
	)		[protected, virtual]

Implements vtkAnimationPlayer.

virtual double vtkCompositeAnimationPlayer::GoToPrevious	(	double	start,
		double	end,
		double	currenttime
	)		[protected, virtual]

Implements vtkAnimationPlayer.

vtkAnimationPlayer* vtkCompositeAnimationPlayer::GetActivePlayer

(

)

[protected]

---

Member Data Documentation

vtkSequenceAnimationPlayer* vtkCompositeAnimationPlayer::SequenceAnimationPlayer [protected]

Definition at line 81 of file vtkCompositeAnimationPlayer.h.

vtkRealtimeAnimationPlayer* vtkCompositeAnimationPlayer::RealtimeAnimationPlayer [protected]

Definition at line 82 of file vtkCompositeAnimationPlayer.h.

vtkTimestepsAnimationPlayer* vtkCompositeAnimationPlayer::TimestepsAnimationPlayer [protected]

Definition at line 83 of file vtkCompositeAnimationPlayer.h.

int vtkCompositeAnimationPlayer::PlayMode [protected]

Definition at line 85 of file vtkCompositeAnimationPlayer.h.

---

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

• dox/ParaViewCore/VTKExtensions/vtkCompositeAnimationPlayer.h