manages data cache for flip book animations. More...

#include <vtkPVCacheKeeper.h>

Inheritance diagram for vtkPVCacheKeeper:

Collaboration diagram for vtkPVCacheKeeper:

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	RemoveAllCaches ()

virtual void	SetCacheTime (double)
virtual double	GetCacheTime ()

bool	IsCached (double cacheTime)
bool	IsCached ()

virtual void	SetCachingEnabled (bool)
virtual bool	GetCachingEnabled ()
virtual void	CachingEnabledOn ()
virtual void	CachingEnabledOff ()
Static Public Member Functions
static vtkPVCacheKeeper *	New ()
static int	IsTypeOf (const char *type)
static vtkPVCacheKeeper *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkPVCacheKeeper ()
	~vtkPVCacheKeeper ()
int	RequestDataObject (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
virtual vtkExecutive *	CreateDefaultExecutive ()
bool	SaveData (vtkDataObject *)

void	SetCacheSizeKeeper (vtkCacheSizeKeeper *)
virtual vtkCacheSizeKeeper *	GetCacheSizeKeeper ()
Protected Attributes
bool	CachingEnabled
double	CacheTime
vtkCacheSizeKeeper *	CacheSizeKeeper

Detailed Description

manages data cache for flip book animations.

vtkPVCacheKeeper manages data cache for flip book animations. When caching is disabled, this simply acts as a pass through filter. When caching is enabled, is the current time step has been previously cached then this filter shuts the update request, otherwise propagates the update and then cache the result for later use. The current time step is set using SetCacheTime().

See also:: vtkPVCacheKeeperPipeline

Definition at line 35 of file vtkPVCacheKeeper.h.

Constructor & Destructor Documentation

vtkPVCacheKeeper::vtkPVCacheKeeper ( ) [protected]

vtkPVCacheKeeper::~vtkPVCacheKeeper ( ) [protected]

Member Function Documentation

static vtkPVCacheKeeper* vtkPVCacheKeeper::New ( ) [static]

Reimplemented from vtkDataObjectAlgorithm.

virtual const char* vtkPVCacheKeeper::GetClassName ( ) [virtual]

Reimplemented from vtkDataObjectAlgorithm.

static int vtkPVCacheKeeper::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkDataObjectAlgorithm.

virtual int vtkPVCacheKeeper::IsA ( const char * type ) [virtual]

Reimplemented from vtkDataObjectAlgorithm.

static vtkPVCacheKeeper* vtkPVCacheKeeper::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkDataObjectAlgorithm.

void vtkPVCacheKeeper::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Reimplemented from vtkDataObjectAlgorithm.

void vtkPVCacheKeeper::RemoveAllCaches ( )

Methods for saving, clearing and updating flip books. This removes all saved cache.

virtual void vtkPVCacheKeeper::SetCacheTime ( double ) [virtual]

Set/Get the current cache time.

virtual double vtkPVCacheKeeper::GetCacheTime ( ) [virtual]

Set/Get the current cache time.

bool vtkPVCacheKeeper::IsCached ( double cacheTime )

Returns if the given cacheTime is available in the cache. Does not cause any updates.

bool vtkPVCacheKeeper::IsCached ( ) [inline]

Returns if the given cacheTime is available in the cache. Does not cause any updates.

Definition at line 56 of file vtkPVCacheKeeper.h.

virtual void vtkPVCacheKeeper::SetCachingEnabled ( bool ) [virtual]

Get/Set if caching is enabled. Default is true.

virtual bool vtkPVCacheKeeper::GetCachingEnabled ( ) [virtual]

Get/Set if caching is enabled. Default is true.

virtual void vtkPVCacheKeeper::CachingEnabledOn ( ) [virtual]

Get/Set if caching is enabled. Default is true.

virtual void vtkPVCacheKeeper::CachingEnabledOff ( ) [virtual]

Get/Set if caching is enabled. Default is true.

void vtkPVCacheKeeper::SetCacheSizeKeeper ( vtkCacheSizeKeeper * ) [protected]

Get/Set the cache size keeper. The cacher reports its cache size to this keeper, if any.

virtual vtkCacheSizeKeeper* vtkPVCacheKeeper::GetCacheSizeKeeper ( ) [protected, virtual]

Get/Set the cache size keeper. The cacher reports its cache size to this keeper, if any.

int vtkPVCacheKeeper::RequestDataObject	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)		`[protected, virtual]`

Reimplemented from vtkDataObjectAlgorithm.

int vtkPVCacheKeeper::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)		`[protected, virtual]`