vtkAnimationPlayer subclass that plays through a discrete set of time values. More...

#include <vtkTimestepsAnimationPlayer.h>

Inheritance diagram for vtkTimestepsAnimationPlayer:

Collaboration diagram for vtkTimestepsAnimationPlayer:

[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

void	RemoveAllTimeSteps ()
	Remove all timesteps. More...

unsigned int	GetNumberOfTimeSteps ()
	Get number of timesteps. More...

double	GetNextTimeStep (double time)
	Returns the timestep value after the given timestep. More...


void	AddTimeStep (double time)
	Add/Remove timesteps. More...

void	RemoveTimeStep (double time)
	Add/Remove timesteps. More...


virtual void	SetFramesPerTimestep (unsigned long)
	Get/Set the number of frames per timstep. More...

virtual unsigned long	GetFramesPerTimestep ()
	Get/Set the number of frames per timstep. 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...

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

static int	IsTypeOf (const char *type)

static vtkTimestepsAnimationPlayer *	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
double	GoToNext (double, double, double currenttime) override
	Return next/previous time knowing start, end and current. More...

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


void	StartLoop (double, double, 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...

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
double	PlaybackWindow [2]

unsigned long	FramesPerTimestep

unsigned long	Count

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

double	GetPreviousTimeStep (double time)
	Returns the timestep value before the given timestep. More...

	vtkTimestepsAnimationPlayer ()
	Returns the timestep value before the given timestep. More...

	~vtkTimestepsAnimationPlayer () override
	Returns the timestep value before the given timestep. More...

Detailed Description

vtkAnimationPlayer subclass that plays through a discrete set of time values.

Player to play an animation scene through a discrete set of time values. FramesPerTimestep controls how many frames are generated for each time value.

Definition at line 20 of file vtkTimestepsAnimationPlayer.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAnimationPlayer vtkTimestepsAnimationPlayer::Superclass

Definition at line 24 of file vtkTimestepsAnimationPlayer.h.

Constructor & Destructor Documentation

◆ vtkTimestepsAnimationPlayer()

vtkTimestepsAnimationPlayer::vtkTimestepsAnimationPlayer ( )

protected

Returns the timestep value before the given timestep.

If no value exists, returns the argument time itself.

◆ ~vtkTimestepsAnimationPlayer()

vtkTimestepsAnimationPlayer::~vtkTimestepsAnimationPlayer ( )

overrideprotected

Returns the timestep value before the given timestep.

If no value exists, returns the argument time itself.

Member Function Documentation

◆ New()

static vtkTimestepsAnimationPlayer* vtkTimestepsAnimationPlayer::New ( )

static

◆ GetClassName()

virtual const char* vtkTimestepsAnimationPlayer::GetClassName ( )

virtual

Reimplemented from vtkAnimationPlayer.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkAnimationPlayer.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkAnimationPlayer.

◆ AddTimeStep()

void vtkTimestepsAnimationPlayer::AddTimeStep ( double time )

Add/Remove timesteps.

◆ RemoveTimeStep()

void vtkTimestepsAnimationPlayer::RemoveTimeStep ( double time )

Add/Remove timesteps.

◆ RemoveAllTimeSteps()

void vtkTimestepsAnimationPlayer::RemoveAllTimeSteps ( )

Remove all timesteps.

◆ GetNumberOfTimeSteps()

unsigned int vtkTimestepsAnimationPlayer::GetNumberOfTimeSteps ( )

Get number of timesteps.

◆ SetFramesPerTimestep()

virtual void vtkTimestepsAnimationPlayer::SetFramesPerTimestep ( unsigned long )

virtual

Get/Set the number of frames per timstep.

◆ GetFramesPerTimestep()

virtual unsigned long vtkTimestepsAnimationPlayer::GetFramesPerTimestep ( )

virtual

Get/Set the number of frames per timstep.

◆ GetNextTimeStep()

double vtkTimestepsAnimationPlayer::GetNextTimeStep ( double time )

Returns the timestep value after the given timestep.

If no value exists, returns the argument time itself.

◆ GetPreviousTimeStep()

double vtkTimestepsAnimationPlayer::GetPreviousTimeStep ( double time )

Returns the timestep value before the given timestep.

If no value exists, returns the argument time itself.

◆ StartLoop()

void vtkTimestepsAnimationPlayer::StartLoop	(	double	,
		double	,
		double	,
		double *	playbackWindow
	)

overrideprotectedvirtual

Manage loop inside playbackwindow.

Implements vtkAnimationPlayer.

◆ EndLoop()

void vtkTimestepsAnimationPlayer::EndLoop ( )

inlineoverrideprotectedvirtual

Manage loop inside playbackwindow.

Implements vtkAnimationPlayer.

Definition at line 77 of file vtkTimestepsAnimationPlayer.h.

◆ GetNextTime()

double vtkTimestepsAnimationPlayer::GetNextTime ( double currentime )

overrideprotectedvirtual

Manage loop inside playbackwindow.

Implements vtkAnimationPlayer.

◆ GetPreviousTime()

double vtkTimestepsAnimationPlayer::GetPreviousTime ( double currenttime )

overrideprotectedvirtual

Manage loop inside playbackwindow.

Implements vtkAnimationPlayer.

◆ GoToNext()

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

inlineoverrideprotectedvirtual

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

Implements vtkAnimationPlayer.

Definition at line 84 of file vtkTimestepsAnimationPlayer.h.

◆ GoToPrevious()

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

inlineoverrideprotectedvirtual

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

Implements vtkAnimationPlayer.

Definition at line 89 of file vtkTimestepsAnimationPlayer.h.

Member Data Documentation

◆ PlaybackWindow

double vtkTimestepsAnimationPlayer::PlaybackWindow[2]

protected

Definition at line 94 of file vtkTimestepsAnimationPlayer.h.

◆ FramesPerTimestep

unsigned long vtkTimestepsAnimationPlayer::FramesPerTimestep

protected

Definition at line 95 of file vtkTimestepsAnimationPlayer.h.

◆ Count

unsigned long vtkTimestepsAnimationPlayer::Count

protected

Definition at line 96 of file vtkTimestepsAnimationPlayer.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkTimestepsAnimationPlayer()

◆ ~vtkTimestepsAnimationPlayer()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ AddTimeStep()

◆ RemoveTimeStep()

◆ RemoveAllTimeSteps()

◆ GetNumberOfTimeSteps()

◆ SetFramesPerTimestep()

◆ GetFramesPerTimestep()

◆ GetNextTimeStep()

◆ GetPreviousTimeStep()

◆ StartLoop()

◆ EndLoop()

◆ GetNextTime()

◆ GetPreviousTime()

◆ GoToNext()

◆ GoToPrevious()

Member Data Documentation

◆ PlaybackWindow

◆ FramesPerTimestep

◆ Count