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

This is composite animation player that can me made to play an animation using the active player. More...

#include <vtkCompositeAnimationPlayer.h>

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

Public Types

enum  Modes { SEQUENCE = 0, REAL_TIME = 1, SNAP_TO_TIMESTEPS = 2 }
 
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 SetNumberOfFrames (int val)
 Forwarded to vtkSequenceAnimationPlayer. More...
 
void SetDuration (int val)
 Forwarded to vtkRealtimeAnimationPlayer. More...
 
virtual void SetPlayMode (int)
 Get/Set the play mode. More...
 
virtual int GetPlayMode ()
 Get/Set the play mode. More...
 
void AddTimeStep (double val)
 Forwarded to vtkTimestepsAnimationPlayer. More...
 
void RemoveAllTimeSteps ()
 Forwarded to vtkTimestepsAnimationPlayer. More...
 
void SetFramesPerTimestep (int val)
 Forwarded to vtkTimestepsAnimationPlayer. 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 vtkCompositeAnimationPlayerNew ()
 
static int IsTypeOf (const char *type)
 
static vtkCompositeAnimationPlayerSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkAnimationPlayer
static int IsTypeOf (const char *type)
 
static vtkAnimationPlayerSafeDownCast (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)
 
vtkAnimationPlayerGetActivePlayer ()
 
virtual void StartLoop (double starttime, double endtime, double *playbackWindow)
 Delegated to the active animation player. More...
 
virtual void EndLoop ()
 Delegated to the active animation player. More...
 
virtual double GetNextTime (double currentime)
 Delegated to the active animation player. More...
 
- Protected Member Functions inherited from vtkAnimationPlayer
 vtkAnimationPlayer ()
 
 ~vtkAnimationPlayer ()
 

Protected Attributes

vtkSequenceAnimationPlayerSequenceAnimationPlayer
 
vtkRealtimeAnimationPlayerRealtimeAnimationPlayer
 
vtkTimestepsAnimationPlayerTimestepsAnimationPlayer
 
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 33 of file vtkCompositeAnimationPlayer.h.

Member Typedef Documentation

◆ Superclass

Definition at line 37 of file vtkCompositeAnimationPlayer.h.

Member Enumeration Documentation

◆ Modes

Enumerator
SEQUENCE 
REAL_TIME 
SNAP_TO_TIMESTEPS 

Definition at line 40 of file vtkCompositeAnimationPlayer.h.

Constructor & Destructor Documentation

◆ vtkCompositeAnimationPlayer()

vtkCompositeAnimationPlayer::vtkCompositeAnimationPlayer ( )
protected

◆ ~vtkCompositeAnimationPlayer()

vtkCompositeAnimationPlayer::~vtkCompositeAnimationPlayer ( )
protected

Member Function Documentation

◆ New()

static vtkCompositeAnimationPlayer* vtkCompositeAnimationPlayer::New ( )
static

◆ GetClassName()

virtual const char* vtkCompositeAnimationPlayer::GetClassName ( )
virtual

Reimplemented from vtkAnimationPlayer.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkAnimationPlayer.

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ SetPlayMode()

virtual void vtkCompositeAnimationPlayer::SetPlayMode ( int  )
virtual

Get/Set the play mode.

◆ GetPlayMode()

virtual int vtkCompositeAnimationPlayer::GetPlayMode ( )
virtual

Get/Set the play mode.

◆ SetNumberOfFrames()

void vtkCompositeAnimationPlayer::SetNumberOfFrames ( int  val)

◆ SetDuration()

void vtkCompositeAnimationPlayer::SetDuration ( int  val)

◆ AddTimeStep()

void vtkCompositeAnimationPlayer::AddTimeStep ( double  val)

◆ RemoveAllTimeSteps()

void vtkCompositeAnimationPlayer::RemoveAllTimeSteps ( )

◆ SetFramesPerTimestep()

void vtkCompositeAnimationPlayer::SetFramesPerTimestep ( int  val)

◆ StartLoop()

virtual void vtkCompositeAnimationPlayer::StartLoop ( double  starttime,
double  endtime,
double *  playbackWindow 
)
protectedvirtual

Delegated to the active animation player.

Implements vtkAnimationPlayer.

◆ EndLoop()

virtual void vtkCompositeAnimationPlayer::EndLoop ( )
protectedvirtual

Delegated to the active animation player.

Implements vtkAnimationPlayer.

◆ GetNextTime()

virtual double vtkCompositeAnimationPlayer::GetNextTime ( double  currentime)
protectedvirtual

Delegated to the active animation player.

Implements vtkAnimationPlayer.

◆ GoToNext()

virtual double vtkCompositeAnimationPlayer::GoToNext ( double  start,
double  end,
double  currenttime 
)
protectedvirtual

Implements vtkAnimationPlayer.

◆ GoToPrevious()

virtual double vtkCompositeAnimationPlayer::GoToPrevious ( double  start,
double  end,
double  currenttime 
)
protectedvirtual

Implements vtkAnimationPlayer.

◆ GetActivePlayer()

vtkAnimationPlayer* vtkCompositeAnimationPlayer::GetActivePlayer ( )
protected

Member Data Documentation

◆ SequenceAnimationPlayer

vtkSequenceAnimationPlayer* vtkCompositeAnimationPlayer::SequenceAnimationPlayer
protected

Definition at line 92 of file vtkCompositeAnimationPlayer.h.

◆ RealtimeAnimationPlayer

vtkRealtimeAnimationPlayer* vtkCompositeAnimationPlayer::RealtimeAnimationPlayer
protected

Definition at line 93 of file vtkCompositeAnimationPlayer.h.

◆ TimestepsAnimationPlayer

vtkTimestepsAnimationPlayer* vtkCompositeAnimationPlayer::TimestepsAnimationPlayer
protected

Definition at line 94 of file vtkCompositeAnimationPlayer.h.

◆ PlayMode

int vtkCompositeAnimationPlayer::PlayMode
protected

Definition at line 96 of file vtkCompositeAnimationPlayer.h.


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