#include <vtkSequenceAnimationPlayer.h>

Inheritance diagram for vtkSequenceAnimationPlayer:

Collaboration diagram for vtkSequenceAnimationPlayer:

[legend]

Public Types
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

virtual void	SetNumberOfFrames (int)

virtual int	GetNumberOfFrames ()

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

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 vtkSequenceAnimationPlayer *	New ()

static int	IsTypeOf (const char *type)

static vtkSequenceAnimationPlayer *	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
	vtkSequenceAnimationPlayer ()

	~vtkSequenceAnimationPlayer () override

int	GetTimestep (double start, double end, double current)
	Return timestep associated to "current" time. More...

double	GetTimeFromTimestep (double start, double end, int timestep)
	Compute time value from timestep, start and end. More...


void	StartLoop (double start, double end, double, double *playbackwindow) override
	Manage loop inside playbackwindow. More...

void	EndLoop () override
	Manage loop inside playbackwindow. More...

double	GetNextTime (double currentime) override
	Manage loop inside playbackwindow. More...

double	GetPreviousTime (double currenttime) override
	Manage loop inside playbackwindow. More...


double	GoToNext (double start, double end, double currenttime) override
	Return previous / next time, using Stride. More...

double	GoToPrevious (double start, double end, double currenttime) override
	Return previous / next time, using Stride. 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
int	NumberOfFrames

int	MaxFrameWindow

double	StartTime

double	EndTime

int	FrameNo

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Definition at line 15 of file vtkSequenceAnimationPlayer.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAnimationPlayer vtkSequenceAnimationPlayer::Superclass

Definition at line 19 of file vtkSequenceAnimationPlayer.h.

Constructor & Destructor Documentation

◆ vtkSequenceAnimationPlayer()

vtkSequenceAnimationPlayer::vtkSequenceAnimationPlayer ( )

protected

◆ ~vtkSequenceAnimationPlayer()

vtkSequenceAnimationPlayer::~vtkSequenceAnimationPlayer ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSequenceAnimationPlayer* vtkSequenceAnimationPlayer::New ( )

static

◆ GetClassName()

virtual const char* vtkSequenceAnimationPlayer::GetClassName ( )

virtual

Reimplemented from vtkAnimationPlayer.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkAnimationPlayer.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkAnimationPlayer.

◆ SetNumberOfFrames()

virtual void vtkSequenceAnimationPlayer::SetNumberOfFrames ( int )

virtual

◆ GetNumberOfFrames()

virtual int vtkSequenceAnimationPlayer::GetNumberOfFrames ( )

virtual

◆ StartLoop()

void vtkSequenceAnimationPlayer::StartLoop	(	double	start,
		double	end,
		double	,
		double *	playbackwindow
	)

overrideprotectedvirtual

Manage loop inside playbackwindow.

Implements vtkAnimationPlayer.

◆ EndLoop()

void vtkSequenceAnimationPlayer::EndLoop ( )

inlineoverrideprotectedvirtual

Manage loop inside playbackwindow.

Implements vtkAnimationPlayer.

Definition at line 35 of file vtkSequenceAnimationPlayer.h.

◆ GetNextTime()

double vtkSequenceAnimationPlayer::GetNextTime ( double currentime )

overrideprotectedvirtual

Manage loop inside playbackwindow.

Implements vtkAnimationPlayer.

◆ GetPreviousTime()

double vtkSequenceAnimationPlayer::GetPreviousTime ( double currenttime )

overrideprotectedvirtual

Manage loop inside playbackwindow.

Implements vtkAnimationPlayer.

◆ GoToNext()

double vtkSequenceAnimationPlayer::GoToNext	(	double	start,
		double	end,
		double	currenttime
	)

overrideprotectedvirtual

Return previous / next time, using Stride.

Always compute it from start + newTimestep * deltaTime to avoid numerical errors that can be occured if we just do deltaTime + currenttime

Implements vtkAnimationPlayer.

◆ GoToPrevious()

double vtkSequenceAnimationPlayer::GoToPrevious	(	double	start,
		double	end,
		double	currenttime
	)

overrideprotectedvirtual

Return previous / next time, using Stride.

Always compute it from start + newTimestep * deltaTime to avoid numerical errors that can be occured if we just do deltaTime + currenttime

Implements vtkAnimationPlayer.

◆ GetTimestep()

int vtkSequenceAnimationPlayer::GetTimestep	(	double	start,
		double	end,
		double	current
	)

protected

Return timestep associated to "current" time.

Compute the duration of a timestep so it cuts [start, end] interval into NumberOfFrames element. Divide (current-start) length by this duration, to get the timestep.

◆ GetTimeFromTimestep()

double vtkSequenceAnimationPlayer::GetTimeFromTimestep	(	double	start,
		double	end,
		int	timestep
	)

protected

Compute time value from timestep, start and end.

Use NumberOfFrames.

Member Data Documentation

◆ NumberOfFrames

int vtkSequenceAnimationPlayer::NumberOfFrames

protected

Definition at line 66 of file vtkSequenceAnimationPlayer.h.

◆ MaxFrameWindow

int vtkSequenceAnimationPlayer::MaxFrameWindow

protected

Definition at line 67 of file vtkSequenceAnimationPlayer.h.

◆ StartTime

double vtkSequenceAnimationPlayer::StartTime

protected

Definition at line 68 of file vtkSequenceAnimationPlayer.h.

◆ EndTime

double vtkSequenceAnimationPlayer::EndTime

protected

Definition at line 69 of file vtkSequenceAnimationPlayer.h.

◆ FrameNo

int vtkSequenceAnimationPlayer::FrameNo

protected

Definition at line 70 of file vtkSequenceAnimationPlayer.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSequenceAnimationPlayer()

◆ ~vtkSequenceAnimationPlayer()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetNumberOfFrames()

◆ GetNumberOfFrames()

◆ StartLoop()

◆ EndLoop()

◆ GetNextTime()

◆ GetPreviousTime()

◆ GoToNext()

◆ GoToPrevious()

◆ GetTimestep()

◆ GetTimeFromTimestep()

Member Data Documentation

◆ NumberOfFrames

◆ MaxFrameWindow

◆ StartTime

◆ EndTime

◆ FrameNo