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:

Collaboration diagram for vtkCompositeAnimationPlayer:

[legend]

Public Types
enum	Modes { SEQUENCE = 0, 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) override

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...


void	SetStride (int _val) override
	Forwarded to vtkTimestepsAnimationPlayer.and vtkSequenceAnimationPlayer. More...

Public Member Functions inherited from vtkAnimationPlayer
void	Play (int dir=1)
	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...

vtkSMAnimationScene *	GetAnimationScene ()
	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...

virtual int	GetStride ()
	Get/Set the stride value fot the animation player. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkCompositeAnimationPlayer *	New ()

static int	IsTypeOf (const char *type)

static vtkCompositeAnimationPlayer *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkAnimationPlayer
static int	IsTypeOf (const char *type)

static vtkAnimationPlayer *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkCompositeAnimationPlayer ()

	~vtkCompositeAnimationPlayer () override

vtkAnimationPlayer *	GetActivePlayer ()


void	StartLoop (double starttime, double endtime, double curtime, double *playbackWindow) override
	Delegated to the active animation player. More...

void	EndLoop () override
	Delegated to the active animation player. More...

double	GetNextTime (double currentime) override
	Delegated to the active animation player. More...

double	GetPreviousTime (double currenttime) override
	Delegated to the active animation player. More...

double	GoToNext (double start, double end, double currenttime) override
	Delegated to the active animation player. More...

double	GoToPrevious (double start, double end, double currenttime) override
	Delegated to the active animation player. More...

Protected Member Functions inherited from vtkAnimationPlayer
	vtkAnimationPlayer ()

	~vtkAnimationPlayer () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkSequenceAnimationPlayer *	SequenceAnimationPlayer

vtkTimestepsAnimationPlayer *	TimestepsAnimationPlayer

int	PlayMode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 22 of file vtkCompositeAnimationPlayer.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAnimationPlayer vtkCompositeAnimationPlayer::Superclass

Definition at line 26 of file vtkCompositeAnimationPlayer.h.

Member Enumeration Documentation

◆ Modes

enum vtkCompositeAnimationPlayer::Modes

Enumerator
SEQUENCE
SNAP_TO_TIMESTEPS

Definition at line 29 of file vtkCompositeAnimationPlayer.h.

Constructor & Destructor Documentation

◆ vtkCompositeAnimationPlayer()

vtkCompositeAnimationPlayer::vtkCompositeAnimationPlayer ( )

protected

◆ ~vtkCompositeAnimationPlayer()

vtkCompositeAnimationPlayer::~vtkCompositeAnimationPlayer ( )

overrideprotected

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
	)

overridevirtual

Reimplemented from vtkAnimationPlayer.

◆ 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 )

Forwarded to vtkSequenceAnimationPlayer.

◆ SetDuration()

void vtkCompositeAnimationPlayer::SetDuration ( int val )

Forwarded to vtkRealtimeAnimationPlayer.

◆ AddTimeStep()

void vtkCompositeAnimationPlayer::AddTimeStep ( double val )

Forwarded to vtkTimestepsAnimationPlayer.

◆ RemoveAllTimeSteps()

void vtkCompositeAnimationPlayer::RemoveAllTimeSteps ( )

Forwarded to vtkTimestepsAnimationPlayer.

◆ SetFramesPerTimestep()

void vtkCompositeAnimationPlayer::SetFramesPerTimestep ( int val )

Forwarded to vtkTimestepsAnimationPlayer.

◆ SetStride()

void vtkCompositeAnimationPlayer::SetStride ( int _val )

overridevirtual

Forwarded to vtkTimestepsAnimationPlayer.and vtkSequenceAnimationPlayer.

Reimplemented from vtkAnimationPlayer.