vtkSMTimeKeeper Class Reference

a time keeper is used to keep track of the pipeline time. More...

#include <vtkSMTimeKeeper.h>

Inheritance diagram for vtkSMTimeKeeper:

Collaboration diagram for vtkSMTimeKeeper:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
void	SetTime (double time)
	Get/Set the pipeline time. More...
virtual double	GetTime ()
	Get/Set the pipeline time. More...
void	AddView (vtkSMProxy *)
	Add/Remove view proxy linked to this time keeper. More...
void	RemoveView (vtkSMProxy *)
	Add/Remove view proxy linked to this time keeper. More...
void	RemoveAllViews ()
	Add/Remove view proxy linked to this time keeper. More...
void	AddTimeSource (vtkSMSourceProxy *)
	List of proxies that provide time. More...
void	RemoveTimeSource (vtkSMSourceProxy *)
	List of proxies that provide time. More...
void	RemoveAllTimeSources ()
	List of proxies that provide time. More...
void	AddSuppressedTimeSource (vtkSMSourceProxy *)
	List of proxies that provide time. More...
void	RemoveSuppressedTimeSource (vtkSMSourceProxy *)
	List of proxies that provide time. More...
void	UpdateTimeInformation ()
	Iterates over all sources providing time and calls vtkSMSourceProxy::UpdatePipelineInformation on them. More...
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 vtkSMTimeKeeper *	New ()
static int	IsTypeOf (const char *type)
static vtkSMTimeKeeper *	SafeDownCast (vtkObject *o)
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
	vtkSMTimeKeeper ()
	~vtkSMTimeKeeper () override
void	SetTimestepValuesProperty (vtkSMProperty *)
void	SetTimeRangeProperty (vtkSMProperty *)
void	SetTimeLabelProperty (vtkSMProperty *)
void	UpdateTimeSteps ()
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
vtkSMProperty *	TimeLabelProperty
vtkSMProperty *	TimeRangeProperty
vtkSMProperty *	TimestepValuesProperty
double	Time
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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 39 of file vtkSMTimeKeeper.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkSMTimeKeeper::Superclass

Definition at line 43 of file vtkSMTimeKeeper.h.

Constructor & Destructor Documentation

vtkSMTimeKeeper()

vtkSMTimeKeeper::vtkSMTimeKeeper ( )

protected

~vtkSMTimeKeeper()

vtkSMTimeKeeper::~vtkSMTimeKeeper ( )

overrideprotected

Member Function Documentation

New()

static vtkSMTimeKeeper* vtkSMTimeKeeper::New ( )

static

GetClassName()

virtual const char* vtkSMTimeKeeper::GetClassName ( )

virtual

IsTypeOf()

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

static

IsA()

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

virtual

Reimplemented from vtkObjectBase.

SafeDownCast()

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

static

PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

SetTime()

void vtkSMTimeKeeper::SetTime

(

double

time

)

Get/Set the pipeline time.

GetTime()

virtual double vtkSMTimeKeeper::GetTime ( )

virtual

Get/Set the pipeline time.

AddView()

void vtkSMTimeKeeper::AddView

(

vtkSMProxy *

)

Add/Remove view proxy linked to this time keeper.

RemoveView()

void vtkSMTimeKeeper::RemoveView

(

vtkSMProxy *

)

Add/Remove view proxy linked to this time keeper.

RemoveAllViews()

void vtkSMTimeKeeper::RemoveAllViews

(

)

Add/Remove view proxy linked to this time keeper.

AddTimeSource()

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.

RemoveTimeSource()

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.

RemoveAllTimeSources()

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.

AddSuppressedTimeSource()

void vtkSMTimeKeeper::AddSuppressedTimeSource

(

vtkSMSourceProxy *

)

List of proxies that provide time.

TimestepValues property has a set of timesteps provided by all the sources added to this property alone.

RemoveSuppressedTimeSource()

void vtkSMTimeKeeper::RemoveSuppressedTimeSource

(

vtkSMSourceProxy *

)

List of proxies that provide time.

TimestepValues property has a set of timesteps provided by all the sources added to this property alone.

UpdateTimeInformation()

void vtkSMTimeKeeper::UpdateTimeInformation

(

)

Iterates over all sources providing time and calls vtkSMSourceProxy::UpdatePipelineInformation on them.

That ensures that timekeeper is using the latest time information available to it.

SetTimestepValuesProperty()

void vtkSMTimeKeeper::SetTimestepValuesProperty ( vtkSMProperty *  )

protected

SetTimeRangeProperty()

void vtkSMTimeKeeper::SetTimeRangeProperty ( vtkSMProperty *  )

protected

SetTimeLabelProperty()

void vtkSMTimeKeeper::SetTimeLabelProperty ( vtkSMProperty *  )

protected

UpdateTimeSteps()

void vtkSMTimeKeeper::UpdateTimeSteps ( )

protected

Friends And Related Function Documentation

vtkSMTimeKeeperProxy

friend class vtkSMTimeKeeperProxy

friend

Definition at line 95 of file vtkSMTimeKeeper.h.

Member Data Documentation

TimeLabelProperty

vtkSMProperty* vtkSMTimeKeeper::TimeLabelProperty

protected

Definition at line 102 of file vtkSMTimeKeeper.h.

TimeRangeProperty

vtkSMProperty* vtkSMTimeKeeper::TimeRangeProperty

protected

Definition at line 103 of file vtkSMTimeKeeper.h.

TimestepValuesProperty

vtkSMProperty* vtkSMTimeKeeper::TimestepValuesProperty

protected

Definition at line 104 of file vtkSMTimeKeeper.h.

Time

double vtkSMTimeKeeper::Time

protected

Definition at line 105 of file vtkSMTimeKeeper.h.

---

The documentation for this class was generated from the following file:

• /builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSMTimeKeeper.h