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
|
/*=========================================================================
Program: ParaView
Module: vtkSMTimeKeeper.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 vtkSMTimeKeeper
* @brief a time keeper is used to keep track of the
* pipeline time.
*
* TimeKeeper can be thought of as a application wide clock. In ParaView, all
* views are registered with the TimeKeeper (using AddView()) so that all the
* views render data at the same global time.
*
* TimeKeeper also keeps track of time steps and continuous time ranges provided
* by sources/readers/filters. This expects that the readers have a
* "TimestepValues" and/or "TimeRange" properties from which the time steps and
* time ranges provided by the reader can be obtained. All sources whose
* time steps/time ranges must be noted by the time keeper need to be registered
* with the time keeper using AddTimeSource(). ParaView automatically registers
* all created sources/filters/readers with the time keeper. The time steps and
* time ranges are made accessible by two information properties
* "TimestepValues" and "TimeRange" on the TimeKeeper proxy.
*
* To change the time shown by all the views, simply change the "Time" property
* on the time keeper proxy (don't directly call SetTime() since otherwise
* undo/redo, state etc. will not work as expected).
*
* This proxy has no VTK objects that it creates on the server.
*/
#ifndef vtkSMTimeKeeper_h
#define vtkSMTimeKeeper_h
#include "vtkObject.h"
#include "vtkPVServerManagerCoreModule.h" //needed for exports
class vtkSMProperty;
class vtkSMSourceProxy;
class vtkSMProxy;
class VTKPVSERVERMANAGERCORE_EXPORT vtkSMTimeKeeper : public vtkObject
{
public:
static vtkSMTimeKeeper* New();
vtkTypeMacro(vtkSMTimeKeeper, vtkObject);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
//@{
/**
* Get/Set the pipeline time.
*/
void SetTime(double time);
vtkGetMacro(Time, double);
//@}
//@{
/**
* Add/Remove view proxy linked to this time keeper.
*/
void AddView(vtkSMProxy*);
void RemoveView(vtkSMProxy*);
void RemoveAllViews();
//@}
//@{
/**
* List of proxies that provide time. TimestepValues property has a set of
* timesteps provided by all the sources added to this property alone.
*/
void AddTimeSource(vtkSMSourceProxy*);
void RemoveTimeSource(vtkSMSourceProxy*);
void RemoveAllTimeSources();
//@}
//@{
/**
* List of proxies that provide time. TimestepValues property has a set of
* timesteps provided by all the sources added to this property alone.
*/
void AddSuppressedTimeSource(vtkSMSourceProxy*);
void RemoveSuppressedTimeSource(vtkSMSourceProxy*);
//@}
protected:
vtkSMTimeKeeper();
~vtkSMTimeKeeper();
friend class vtkSMTimeKeeperProxy;
void SetTimestepValuesProperty(vtkSMProperty*);
void SetTimeRangeProperty(vtkSMProperty*);
void SetTimeLabelProperty(vtkSMProperty*);
void UpdateTimeSteps();
vtkSMProperty* TimeLabelProperty;
vtkSMProperty* TimeRangeProperty;
vtkSMProperty* TimestepValuesProperty;
double Time;
private:
vtkSMTimeKeeper(const vtkSMTimeKeeper&) VTK_DELETE_FUNCTION;
void operator=(const vtkSMTimeKeeper&) VTK_DELETE_FUNCTION;
class vtkInternal;
vtkInternal* Internal;
};
#endif
|