a time keeper is used to keep track of the pipeline time. More...
#include <vtkSMTimeKeeper.h>
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| void | SetTime (double time) |
| virtual double | GetTime () |
| void | AddView (vtkSMViewProxy *) |
| void | RemoveView (vtkSMViewProxy *) |
| void | RemoveAllViews () |
| void | AddTimeSource (vtkSMSourceProxy *) |
| void | RemoveTimeSource (vtkSMSourceProxy *) |
| void | RemoveAllTimeSources () |
Static Public Member Functions | |
| static vtkSMTimeKeeper * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkSMTimeKeeper * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkSMTimeKeeper () | |
| ~vtkSMTimeKeeper () | |
| void | SetTimestepValuesProperty (vtkSMProperty *) |
| void | SetTimeRangeProperty (vtkSMProperty *) |
| void | UpdateTimeSteps () |
Protected Attributes | |
| vtkSMProperty * | TimeRangeProperty |
| vtkSMProperty * | TimestepValuesProperty |
| double | Time |
Friends | |
| class | vtkSMTimeKeeperProxy |
Detailed Description
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.
Definition at line 49 of file vtkSMTimeKeeper.h.
Constructor & Destructor Documentation
| vtkSMTimeKeeper::vtkSMTimeKeeper | ( | ) | [protected] |
| vtkSMTimeKeeper::~vtkSMTimeKeeper | ( | ) | [protected] |
Member Function Documentation
| static vtkSMTimeKeeper* vtkSMTimeKeeper::New | ( | ) | [static] |
Reimplemented from vtkObject.
| virtual const char* vtkSMTimeKeeper::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkObject.
| static vtkSMTimeKeeper* vtkSMTimeKeeper::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkObject.
| void vtkSMTimeKeeper::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkObject.
| void vtkSMTimeKeeper::SetTime | ( | double | time | ) |
Get/Set the pipeline time.
| virtual double vtkSMTimeKeeper::GetTime | ( | ) | [virtual] |
Get/Set the pipeline time.
| void vtkSMTimeKeeper::AddView | ( | vtkSMViewProxy * | ) |
Add/Remove view proxy linked to this time keeper.
| void vtkSMTimeKeeper::RemoveView | ( | vtkSMViewProxy * | ) |
Add/Remove view proxy linked to this time keeper.
| void vtkSMTimeKeeper::RemoveAllViews | ( | ) |
Add/Remove view proxy linked to this time keeper.
| void vtkSMTimeKeeper::AddTimeSource | ( | vtkSMSourceProxy * | ) |
List of proxies that provide time. TimestepValues property has a set of timesteps provided by all the sources added to this property alone.
| void vtkSMTimeKeeper::RemoveTimeSource | ( | vtkSMSourceProxy * | ) |
List of proxies that provide time. TimestepValues property has a set of timesteps provided by all the sources added to this property alone.
| void vtkSMTimeKeeper::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 vtkSMTimeKeeper::SetTimestepValuesProperty | ( | vtkSMProperty * | ) | [protected] |
| void vtkSMTimeKeeper::SetTimeRangeProperty | ( | vtkSMProperty * | ) | [protected] |
| void vtkSMTimeKeeper::UpdateTimeSteps | ( | ) | [protected] |
Friends And Related Function Documentation
friend class vtkSMTimeKeeperProxy [friend] |
Definition at line 83 of file vtkSMTimeKeeper.h.
Member Data Documentation
vtkSMProperty* vtkSMTimeKeeper::TimeRangeProperty [protected] |
Definition at line 89 of file vtkSMTimeKeeper.h.
vtkSMProperty* vtkSMTimeKeeper::TimestepValuesProperty [protected] |
Definition at line 90 of file vtkSMTimeKeeper.h.
double vtkSMTimeKeeper::Time [protected] |
Definition at line 91 of file vtkSMTimeKeeper.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/ServerManager/vtkSMTimeKeeper.h
