Animation player that plays in real time. More...

#include <vtkRealtimeAnimationPlayer.h>

Inheritance diagram for vtkRealtimeAnimationPlayer:

Collaboration diagram for vtkRealtimeAnimationPlayer:

[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 unsigned long	GetDuration ()
	Get/Set the duration for playing the animation in seconds. More...

virtual void	SetDuration (unsigned long)
	Get/Set the duration for playing the animation in seconds. More...


void	SetStride (int) final
	Setter is noop, getter return 1. More...

int	GetStride () final
	Setter is noop, getter return 1. 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...

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

static int	IsTypeOf (const char *type)

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

	~vtkRealtimeAnimationPlayer () override

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

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

double	GetNextTime (double currentime) override
	Return the next time given the current time. More...

double	GetPreviousTime (double currenttime) override
	Return the previous time given the current time. More...

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

double	GoToPrevious (double start, double end, double currenttime) override
	Return next/previous time knowing start, end and current. 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
unsigned long	Duration

double	StartTime

double	EndTime

double	ShiftTime

double	Factor

vtkTimerLog *	Timer

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Animation player that plays in real time.

Definition at line 19 of file vtkRealtimeAnimationPlayer.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAnimationPlayer vtkRealtimeAnimationPlayer::Superclass

Definition at line 25 of file vtkRealtimeAnimationPlayer.h.

Constructor & Destructor Documentation

◆ vtkRealtimeAnimationPlayer()

vtkRealtimeAnimationPlayer::vtkRealtimeAnimationPlayer ( )

protected

◆ ~vtkRealtimeAnimationPlayer()

vtkRealtimeAnimationPlayer::~vtkRealtimeAnimationPlayer ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkRealtimeAnimationPlayer* vtkRealtimeAnimationPlayer::New ( )

static

◆ GetClassName()

virtual const char* vtkRealtimeAnimationPlayer::GetClassName ( )

virtual

Reimplemented from vtkAnimationPlayer.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkAnimationPlayer.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkAnimationPlayer.

◆ GetDuration()

virtual unsigned long vtkRealtimeAnimationPlayer::GetDuration ( )

virtual

Get/Set the duration for playing the animation in seconds.

◆ SetDuration()

virtual void vtkRealtimeAnimationPlayer::SetDuration ( unsigned long )

virtual

Get/Set the duration for playing the animation in seconds.

◆ SetStride()

void vtkRealtimeAnimationPlayer::SetStride ( int )

inlinefinalvirtual

Setter is noop, getter return 1.

Stride is not relevant for realtime animation so let it be always 1.

Reimplemented from vtkAnimationPlayer.

Definition at line 42 of file vtkRealtimeAnimationPlayer.h.

◆ GetStride()

int vtkRealtimeAnimationPlayer::GetStride ( )

inlinefinalvirtual

Setter is noop, getter return 1.

Stride is not relevant for realtime animation so let it be always 1.

Reimplemented from vtkAnimationPlayer.

Definition at line 43 of file vtkRealtimeAnimationPlayer.h.

◆ StartLoop()

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

overrideprotectedvirtual

Manage loop inside playbackwindow.

Implements vtkAnimationPlayer.

◆ EndLoop()

void vtkRealtimeAnimationPlayer::EndLoop ( )

inlineoverrideprotectedvirtual

Manage loop inside playbackwindow.

Implements vtkAnimationPlayer.

Definition at line 51 of file vtkRealtimeAnimationPlayer.h.

◆ GetNextTime()

double vtkRealtimeAnimationPlayer::GetNextTime ( double currentime )

overrideprotectedvirtual

Return the next time given the current time.

Implements vtkAnimationPlayer.

◆ GetPreviousTime()

double vtkRealtimeAnimationPlayer::GetPreviousTime ( double currenttime )

overrideprotectedvirtual

Return the previous time given the current time.

Implements vtkAnimationPlayer.

◆ GoToNext()

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

overrideprotectedvirtual

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

Implements vtkAnimationPlayer.

◆ GoToPrevious()

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

overrideprotectedvirtual

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

Implements vtkAnimationPlayer.

Member Data Documentation

◆ Duration

unsigned long vtkRealtimeAnimationPlayer::Duration

protected

Definition at line 66 of file vtkRealtimeAnimationPlayer.h.

◆ StartTime

double vtkRealtimeAnimationPlayer::StartTime

protected

Definition at line 67 of file vtkRealtimeAnimationPlayer.h.

◆ EndTime

double vtkRealtimeAnimationPlayer::EndTime

protected

Definition at line 68 of file vtkRealtimeAnimationPlayer.h.

◆ ShiftTime

double vtkRealtimeAnimationPlayer::ShiftTime

protected

Definition at line 69 of file vtkRealtimeAnimationPlayer.h.

◆ Factor

double vtkRealtimeAnimationPlayer::Factor

protected

Definition at line 70 of file vtkRealtimeAnimationPlayer.h.

◆ Timer

vtkTimerLog* vtkRealtimeAnimationPlayer::Timer

protected

Definition at line 71 of file vtkRealtimeAnimationPlayer.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkRealtimeAnimationPlayer()

◆ ~vtkRealtimeAnimationPlayer()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ GetDuration()

◆ SetDuration()

◆ SetStride()

◆ GetStride()

◆ StartLoop()

◆ EndLoop()

◆ GetNextTime()

◆ GetPreviousTime()

◆ GoToNext()

◆ GoToPrevious()

Member Data Documentation

◆ Duration

◆ StartTime

◆ EndTime

◆ ShiftTime

◆ Factor

◆ Timer