Abstract superclass for an animation player. More...

#include <vtkAnimationPlayer.h>

Inheritance diagram for vtkAnimationPlayer:

[legend]

Collaboration diagram for vtkAnimationPlayer:

[legend]

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

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

virtual void	SetStride (int)
	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 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
	vtkAnimationPlayer ()

	~vtkAnimationPlayer () override


virtual void	StartLoop (double starttime, double endtime, double curtime, double *playbackWindow)=0
	Manage loop inside playbackwindow. More...

virtual void	EndLoop ()=0
	Manage loop inside playbackwindow. More...

virtual double	GetNextTime (double currentime)=0
	Manage loop inside playbackwindow. More...

virtual double	GetPreviousTime (double currenttime)=0
	Manage loop inside playbackwindow. More...


virtual double	GoToNext (double start, double end, double currenttime)=0
	Return next/previous time knowing start, end and current. More...

virtual double	GoToPrevious (double start, double end, double currenttime)=0
	Return next/previous time knowing start, end and current. More...

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

Friends
class	vtkCompositeAnimationPlayer

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Abstract superclass for an animation player.

Definition at line 17 of file vtkAnimationPlayer.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkAnimationPlayer::Superclass

Definition at line 20 of file vtkAnimationPlayer.h.

Constructor & Destructor Documentation

◆ vtkAnimationPlayer()

vtkAnimationPlayer::vtkAnimationPlayer ( )

protected

◆ ~vtkAnimationPlayer()

vtkAnimationPlayer::~vtkAnimationPlayer ( )

overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkAnimationPlayer::GetClassName ( )

virtual

Reimplemented in vtkCompositeAnimationPlayer, vtkRealtimeAnimationPlayer, vtkTimestepsAnimationPlayer, and vtkSequenceAnimationPlayer.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

Reimplemented in vtkCompositeAnimationPlayer, vtkRealtimeAnimationPlayer, vtkTimestepsAnimationPlayer, and vtkSequenceAnimationPlayer.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

Reimplemented in vtkCompositeAnimationPlayer, vtkRealtimeAnimationPlayer, vtkTimestepsAnimationPlayer, and vtkSequenceAnimationPlayer.

◆ SetAnimationScene()

virtual void vtkAnimationPlayer::SetAnimationScene ( vtkSMAnimationScene * )

virtual

Set the animation scene that is to be played by this player.

Note that the animation scene is not reference counted to avoid loops.

◆ GetAnimationScene()

vtkSMAnimationScene* vtkAnimationPlayer::GetAnimationScene ( )

Set the animation scene that is to be played by this player.

Note that the animation scene is not reference counted to avoid loops.

◆ Play()

void vtkAnimationPlayer::Play ( int dir = 1 )

Start playing the animation.

Fires StartEvent when play begins and EndEvent when play stops. If dir = 0, play the animation in reverse back to the beginning, else play it in the forward direction.

◆ Stop()

void vtkAnimationPlayer::Stop ( )

Stop playing the animation.

◆ IsInPlay()

int vtkAnimationPlayer::IsInPlay ( )

inline

Returns if the animation is currently playing.

Definition at line 48 of file vtkAnimationPlayer.h.

◆ GetInPlay()

virtual bool vtkAnimationPlayer::GetInPlay ( )

virtual

◆ SetLoop()

virtual void vtkAnimationPlayer::SetLoop ( bool )

virtual

Set to true to play the animation in a loop.

◆ GetLoop()

virtual bool vtkAnimationPlayer::GetLoop ( )

virtual

Set to true to play the animation in a loop.

◆ GoToNext() [1/2]

void vtkAnimationPlayer::GoToNext ( )

Take the animation scene to next frame.

◆ GoToPrevious() [1/2]

void vtkAnimationPlayer::GoToPrevious ( )

Take animation scene to previous frame.

◆ GoToFirst()

void vtkAnimationPlayer::GoToFirst ( )

Take animation scene to first frame.

◆ GoToLast()

void vtkAnimationPlayer::GoToLast ( )

Take animation scene to last frame.

◆ GetStride()

virtual int vtkAnimationPlayer::GetStride ( )

virtual

Get/Set the stride value fot the animation player.

This will cause the player to skip (n - 1) when GetNextTime, GoToNext and GoToPrevious are previous are called.

Stride is clamped between 1 and the number of frames of the current animation scene.

Reimplemented in vtkRealtimeAnimationPlayer.

◆ SetStride()

virtual void vtkAnimationPlayer::SetStride ( int )

virtual

Get/Set the stride value fot the animation player.

This will cause the player to skip (n - 1) when GetNextTime, GoToNext and GoToPrevious are previous are called.

Stride is clamped between 1 and the number of frames of the current animation scene.

Reimplemented in vtkCompositeAnimationPlayer, and vtkRealtimeAnimationPlayer.

◆ StartLoop()

virtual void vtkAnimationPlayer::StartLoop	(	double	starttime,
		double	endtime,
		double	curtime,
		double *	playbackWindow
	)

protectedpure virtual

Manage loop inside playbackwindow.

Implemented in vtkCompositeAnimationPlayer, vtkTimestepsAnimationPlayer, vtkRealtimeAnimationPlayer, and vtkSequenceAnimationPlayer.

◆ EndLoop()

virtual void vtkAnimationPlayer::EndLoop ( )

protectedpure virtual

Manage loop inside playbackwindow.

Implemented in vtkCompositeAnimationPlayer, vtkTimestepsAnimationPlayer, vtkRealtimeAnimationPlayer, and vtkSequenceAnimationPlayer.

◆ GetNextTime()

virtual double vtkAnimationPlayer::GetNextTime ( double currentime )

protectedpure virtual

Manage loop inside playbackwindow.

Implemented in vtkCompositeAnimationPlayer, vtkTimestepsAnimationPlayer, vtkRealtimeAnimationPlayer, and vtkSequenceAnimationPlayer.

◆ GetPreviousTime()

virtual double vtkAnimationPlayer::GetPreviousTime ( double currenttime )

protectedpure virtual

Manage loop inside playbackwindow.

Implemented in vtkCompositeAnimationPlayer, vtkTimestepsAnimationPlayer, vtkRealtimeAnimationPlayer, and vtkSequenceAnimationPlayer.

◆ GoToNext() [2/2]

virtual double vtkAnimationPlayer::GoToNext	(	double	start,
		double	end,
		double	currenttime
	)

protectedpure virtual

Return next/previous time knowing start, end and current.

Implemented in vtkTimestepsAnimationPlayer, vtkCompositeAnimationPlayer, vtkRealtimeAnimationPlayer, and vtkSequenceAnimationPlayer.

◆ GoToPrevious() [2/2]

virtual double vtkAnimationPlayer::GoToPrevious	(	double	start,
		double	end,
		double	currenttime
	)

protectedpure virtual

Return next/previous time knowing start, end and current.

Implemented in vtkTimestepsAnimationPlayer, vtkCompositeAnimationPlayer, vtkRealtimeAnimationPlayer, and vtkSequenceAnimationPlayer.

Friends And Related Function Documentation

◆ vtkCompositeAnimationPlayer

friend class vtkCompositeAnimationPlayer

friend

Definition at line 94 of file vtkAnimationPlayer.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Animation/vtkAnimationPlayer.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkAnimationPlayer()

◆ ~vtkAnimationPlayer()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetAnimationScene()

◆ GetAnimationScene()

◆ Play()

◆ Stop()

◆ IsInPlay()

◆ GetInPlay()

◆ SetLoop()

◆ GetLoop()

◆ GoToNext() [1/2]

◆ GoToPrevious() [1/2]

◆ GoToFirst()

◆ GoToLast()

◆ GetStride()

◆ SetStride()

◆ StartLoop()

◆ EndLoop()

◆ GetNextTime()

◆ GetPreviousTime()

◆ GoToNext() [2/2]

◆ GoToPrevious() [2/2]

Friends And Related Function Documentation

◆ vtkCompositeAnimationPlayer