animation scene for ParaView. More...

#include <vtkSMAnimationScene.h>

Inheritance diagram for vtkSMAnimationScene:

Collaboration diagram for vtkSMAnimationScene:

[legend]

Public Types
enum	{ UpdateStartEndTimesEvent = vtkCommand::UserEvent }

typedef vtkAnimationCue	Superclass

Public Types inherited from vtkAnimationCue
enum	TimeCodes

typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual double	GetSceneTime ()

virtual void	SetOverrideStillRender (bool)
	When set, we skip calling still render to render each frame. More...

virtual bool	GetOverrideStillRender ()


void	AddCue (vtkAnimationCue *cue)
	Add/Remove an AnimationCue to/from the Scene. More...

void	RemoveCue (vtkAnimationCue *cue)
	Add/Remove an AnimationCue to/from the Scene. More...

void	RemoveAllCues ()
	Add/Remove an AnimationCue to/from the Scene. More...

int	GetNumberOfCues ()
	Add/Remove an AnimationCue to/from the Scene. More...


void	AddViewProxy (vtkSMViewProxy *proxy)
	Add view proxies that are involved in the animation generated by this scene. More...

void	RemoveViewProxy (vtkSMViewProxy *proxy)
	Add view proxies that are involved in the animation generated by this scene. More...

void	RemoveAllViewProxies ()
	Add view proxies that are involved in the animation generated by this scene. More...


unsigned int	GetNumberOfViewProxies ()
	Access the view proxies. More...

vtkSMViewProxy *	GetViewProxy (unsigned int cc)
	Access the view proxies. More...


void	SetTimeKeeper (vtkSMProxy *)
	Set the time keeper. More...

virtual vtkSMProxy *	GetTimeKeeper ()
	Set the time keeper. More...


virtual void	SetLockStartTime (bool)
	Lock the start time. More...

virtual bool	GetLockStartTime ()
	Lock the start time. More...

virtual void	LockStartTimeOn ()
	Lock the start time. More...

virtual void	LockStartTimeOff ()
	Lock the start time. More...


virtual void	SetLockEndTime (bool)
	Lock the end time. More...

virtual bool	GetLockEndTime ()
	Lock the end time. More...

virtual void	LockEndTimeOn ()
	Lock the end time. More...

virtual void	LockEndTimeOff ()
	Lock the end time. More...


void	SetSceneTime (double time)
	Sets the current animation time. More...


virtual void	SetPlaybackTimeWindow (double, double)
	Get/Set the Playback Window for this cue. More...

void	SetPlaybackTimeWindow (double [2])
	Get/Set the Playback Window for this cue. More...

virtual double *	GetPlaybackTimeWindow ()
	Get/Set the Playback Window for this cue. More...

virtual void	GetPlaybackTimeWindow (double &, double &)
	Get/Set the Playback Window for this cue. More...

virtual void	GetPlaybackTimeWindow (double [2])
	Get/Set the Playback Window for this cue. More...


void	SetLoop (int val)
	Forwarded to vtkCompositeAnimationPlayer. More...

int	GetLoop ()
	Forwarded to vtkCompositeAnimationPlayer. More...

void	Play ()
	Forwarded to vtkCompositeAnimationPlayer. More...

void	Reverse ()
	Forwarded to vtkCompositeAnimationPlayer. More...

void	Stop ()
	Forwarded to vtkCompositeAnimationPlayer. More...

void	GoToNext ()
	Forwarded to vtkCompositeAnimationPlayer. More...

void	GoToPrevious ()
	Forwarded to vtkCompositeAnimationPlayer. More...

void	GoToFirst ()
	Forwarded to vtkCompositeAnimationPlayer. More...

void	GoToLast ()
	Forwarded to vtkCompositeAnimationPlayer. More...

void	SetPlayMode (int val)
	Forwarded to vtkCompositeAnimationPlayer. More...

int	GetPlayMode ()
	Forwarded to vtkCompositeAnimationPlayer. More...

void	SetNumberOfFrames (int val)
	Forwarded to vtkCompositeAnimationPlayer. More...

void	SetDuration (int vtkNotUsed(val))
	Forwarded to vtkCompositeAnimationPlayer. More...

void	SetFramesPerTimestep (int val)
	Forwarded to vtkCompositeAnimationPlayer. More...

void	SetStride (int val)
	Forwarded to vtkCompositeAnimationPlayer. More...


virtual void	SetForceDisableCaching (bool)
	Set to true to force caching to be disabled. More...

virtual bool	GetForceDisableCaching ()
	Set to true to force caching to be disabled. More...

Public Member Functions inherited from vtkAnimationCue
vtkAnimationCue *	NewInstance () const

virtual void	Tick (double currenttime, double deltatime, double clocktime)

virtual void	Initialize ()

virtual void	Finalize ()

virtual void	SetTimeMode (int mode)

virtual int	GetTimeMode ()

void	SetTimeModeToRelative ()

void	SetTimeModeToNormalized ()

virtual void	SetStartTime (double)

virtual double	GetStartTime ()

virtual void	SetEndTime (double)

virtual double	GetEndTime ()

virtual double	GetAnimationTime ()

virtual double	GetDeltaTime ()

virtual double	GetClockTime ()

virtual void	SetTimeMode (int mode)

virtual int	GetTimeMode ()

void	SetTimeModeToRelative ()

void	SetTimeModeToNormalized ()

virtual void	SetStartTime (double)

virtual double	GetStartTime ()

virtual void	SetEndTime (double)

virtual double	GetEndTime ()

virtual double	GetAnimationTime ()

virtual double	GetDeltaTime ()

virtual double	GetClockTime ()

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

static int	IsTypeOf (const char *type)

static vtkSMAnimationScene *	SafeDownCast (vtkObject *o)


static void	SetGlobalUseGeometryCache (bool)
	Turn caching on/off globally. More...

static bool	GetGlobalUseGeometryCache ()
	Turn caching on/off globally. More...

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

static vtkAnimationCue *	SafeDownCast (vtkObjectBase *o)

static vtkAnimationCue *	New ()

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
	vtkSMAnimationScene ()

	~vtkSMAnimationScene () override


void	StartCueInternal () override
	Overridden to ensure that caching parameters are passed to the view correctly. More...

void	TickInternal (double currenttime, double deltatime, double clocktime) override
	Overridden to ensure that caching parameters are passed to the view correctly. More...

void	EndCueInternal () override
	Overridden to ensure that caching parameters are passed to the view correctly. More...


void	TimeKeeperTimeRangeChanged ()
	Called when the timekeeper's time range changes. More...

void	TimeKeeperTimestepsChanged ()
	Called when the timekeeper's time range changes. More...

Protected Member Functions inherited from vtkAnimationCue
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAnimationCue ()

	~vtkAnimationCue ()

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
bool	LockStartTime

bool	LockEndTime

bool	InTick

double	SceneTime

double	PlaybackTimeWindow [2]

bool	ForceDisableCaching

vtkSMProxy *	TimeKeeper

vtkCompositeAnimationPlayer *	AnimationPlayer

vtkEventForwarderCommand *	Forwarder

bool	OverrideStillRender

Protected Attributes inherited from vtkAnimationCue
	UNINITIALIZED

	INACTIVE

	ACTIVE

double	StartTime

double	EndTime

int	TimeMode

double	AnimationTime

double	DeltaTime

double	ClockTime

int	CueState

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAnimationCue
	TIMEMODE_NORMALIZED

	TIMEMODE_RELATIVE

Detailed Description

animation scene for ParaView.

vtkSMAnimationScene extends vtkAnimationCue to add support for a scene in ParaView.

We don't use vtkAnimationScene since ParaView has more elaborate playback requirements. To support that, this class delegates playback responsibility to vtkAnimationPlayer and subclasses.

vtkSMAnimationScene also is proxy-aware and hence can work with proxies and views proxies for updating property values, rendering, etc.

vtkSMAnimationScene forwards the vtkCommand::StartEvent and vtkCommand::EndEvent from vtkCompositeAnimationPlayer to mark the start and end of animation playback.

Definition at line 36 of file vtkSMAnimationScene.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAnimationCue vtkSMAnimationScene::Superclass

Definition at line 40 of file vtkSMAnimationScene.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
UpdateStartEndTimesEvent

Definition at line 163 of file vtkSMAnimationScene.h.

Constructor & Destructor Documentation

◆ vtkSMAnimationScene()

vtkSMAnimationScene::vtkSMAnimationScene ( )

protected

◆ ~vtkSMAnimationScene()

vtkSMAnimationScene::~vtkSMAnimationScene ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMAnimationScene* vtkSMAnimationScene::New ( )

static

◆ GetClassName()

virtual const char* vtkSMAnimationScene::GetClassName ( )

virtual

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkAnimationCue.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkAnimationCue.

◆ AddCue()

void vtkSMAnimationScene::AddCue ( vtkAnimationCue * cue )

Add/Remove an AnimationCue to/from the Scene.

It's an error to add a cue twice to the Scene.

◆ RemoveCue()

void vtkSMAnimationScene::RemoveCue ( vtkAnimationCue * cue )

Add/Remove an AnimationCue to/from the Scene.

It's an error to add a cue twice to the Scene.

◆ RemoveAllCues()

void vtkSMAnimationScene::RemoveAllCues ( )

Add/Remove an AnimationCue to/from the Scene.

It's an error to add a cue twice to the Scene.

◆ GetNumberOfCues()

int vtkSMAnimationScene::GetNumberOfCues ( )

Add/Remove an AnimationCue to/from the Scene.

It's an error to add a cue twice to the Scene.

◆ AddViewProxy()

void vtkSMAnimationScene::AddViewProxy ( vtkSMViewProxy * proxy )

Add view proxies that are involved in the animation generated by this scene.

When playing the animation, the scene will call StillRender() on the view proxies it is aware of, also updating any caching parameters.

◆ RemoveViewProxy()

void vtkSMAnimationScene::RemoveViewProxy ( vtkSMViewProxy * proxy )

Add view proxies that are involved in the animation generated by this scene.

When playing the animation, the scene will call StillRender() on the view proxies it is aware of, also updating any caching parameters.

◆ RemoveAllViewProxies()

void vtkSMAnimationScene::RemoveAllViewProxies ( )

Add view proxies that are involved in the animation generated by this scene.

When playing the animation, the scene will call StillRender() on the view proxies it is aware of, also updating any caching parameters.

◆ GetNumberOfViewProxies()

unsigned int vtkSMAnimationScene::GetNumberOfViewProxies ( )

Access the view proxies.

◆ GetViewProxy()

vtkSMViewProxy* vtkSMAnimationScene::GetViewProxy ( unsigned int cc )

Access the view proxies.

◆ SetTimeKeeper()

void vtkSMAnimationScene::SetTimeKeeper ( vtkSMProxy * )

Set the time keeper.

Time keeper is used to obtain the information about timesteps. This is required to play animation in "Snap To Timesteps" mode.

◆ GetTimeKeeper()

virtual vtkSMProxy* vtkSMAnimationScene::GetTimeKeeper ( )

virtual

Set the time keeper.

Time keeper is used to obtain the information about timesteps. This is required to play animation in "Snap To Timesteps" mode.

◆ SetLockStartTime()

virtual void vtkSMAnimationScene::SetLockStartTime ( bool )

virtual

Lock the start time.

When locked, the StartTime won't be automatically updated when data time changes.

◆ GetLockStartTime()

virtual bool vtkSMAnimationScene::GetLockStartTime ( )

virtual

Lock the start time.

When locked, the StartTime won't be automatically updated when data time changes.

◆ LockStartTimeOn()

virtual void vtkSMAnimationScene::LockStartTimeOn ( )

virtual

Lock the start time.

When locked, the StartTime won't be automatically updated when data time changes.

◆ LockStartTimeOff()

virtual void vtkSMAnimationScene::LockStartTimeOff ( )

virtual

Lock the start time.

When locked, the StartTime won't be automatically updated when data time changes.

◆ SetLockEndTime()

virtual void vtkSMAnimationScene::SetLockEndTime ( bool )

virtual

Lock the end time.

When locked, the EndTime won't be automatically updated when the data time changes.

◆ GetLockEndTime()

virtual bool vtkSMAnimationScene::GetLockEndTime ( )

virtual

Lock the end time.

When locked, the EndTime won't be automatically updated when the data time changes.

◆ LockEndTimeOn()

virtual void vtkSMAnimationScene::LockEndTimeOn ( )

virtual

Lock the end time.

When locked, the EndTime won't be automatically updated when the data time changes.

◆ LockEndTimeOff()

virtual void vtkSMAnimationScene::LockEndTimeOff ( )

virtual

Lock the end time.

When locked, the EndTime won't be automatically updated when the data time changes.

◆ SetSceneTime()

void vtkSMAnimationScene::SetSceneTime ( double time )

inline

Sets the current animation time.

Definition at line 106 of file vtkSMAnimationScene.h.

◆ GetSceneTime()

virtual double vtkSMAnimationScene::GetSceneTime ( )

virtual