1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
/*=========================================================================
Program: ParaView
Module: vtkPVCacheKeeper.h
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkPVCacheKeeper
* @brief 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().
* @sa
* vtkPVCacheKeeperPipeline
*/
#ifndef vtkPVCacheKeeper_h
#define vtkPVCacheKeeper_h
#include "vtkDataObjectAlgorithm.h"
#include "vtkPVClientServerCoreRenderingModule.h" //needed for exports
class vtkCacheSizeKeeper;
class VTKPVCLIENTSERVERCORERENDERING_EXPORT vtkPVCacheKeeper : public vtkDataObjectAlgorithm
{
public:
static vtkPVCacheKeeper* New();
vtkTypeMacro(vtkPVCacheKeeper, vtkDataObjectAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
/**
* Methods for saving, clearing and updating flip books.
* This removes all saved cache.
*/
virtual void RemoveAllCaches();
//@{
/**
* Set/Get the current cache time.
*/
vtkSetMacro(CacheTime, double);
vtkGetMacro(CacheTime, double);
//@}
/**
* Returns if the given \c cacheTime is available in the cache.
* Does not cause any updates.
*/
virtual bool IsCached(double cacheTime);
virtual bool IsCached() { return this->IsCached(this->CacheTime); }
//@{
/**
* Get/Set if caching is enabled. Default is true.
*/
vtkSetMacro(CachingEnabled, bool);
vtkGetMacro(CachingEnabled, bool);
vtkBooleanMacro(CachingEnabled, bool);
//@}
//@{
/**
* These methods are used for testing. Using this global state we can add
* checks to ensure that cache was used or not used for a particular sequence
* of actions.
*/
static void ClearCacheStateFlags();
static int GetCacheHits();
static int GetCacheMisses();
static int GetCacheSkips();
//@}
protected:
vtkPVCacheKeeper();
~vtkPVCacheKeeper();
//@{
/**
* Get/Set the cache size keeper. The cacher
* reports its cache size to this keeper, if any.
*/
void SetCacheSizeKeeper(vtkCacheSizeKeeper*);
vtkGetObjectMacro(CacheSizeKeeper, vtkCacheSizeKeeper);
//@}
int RequestDataObject(vtkInformation* request, vtkInformationVector** inputVector,
vtkInformationVector* outputVector) VTK_OVERRIDE;
int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
vtkInformationVector* outputVector) VTK_OVERRIDE;
virtual vtkExecutive* CreateDefaultExecutive() VTK_OVERRIDE;
/**
* Called to save the data in cache. Returns true if data is saved otherwise
* false.
*/
virtual bool SaveData(vtkDataObject*);
bool CachingEnabled;
double CacheTime;
vtkCacheSizeKeeper* CacheSizeKeeper;
private:
vtkPVCacheKeeper(const vtkPVCacheKeeper&) VTK_DELETE_FUNCTION;
void operator=(const vtkPVCacheKeeper&) VTK_DELETE_FUNCTION;
class vtkCacheMap;
vtkCacheMap* Cache;
static int CacheHit;
static int CacheMiss;
static int CacheSkips;
};
#endif
|
