ParaView
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends
vtkSMAnimationScene Class Reference

extends vtkPVAnimationScene to add awareness about view proxies. More...

#include <vtkSMAnimationScene.h>

Inheritance diagram for vtkSMAnimationScene:
Inheritance graph
[legend]
Collaboration diagram for vtkSMAnimationScene:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetCacheLimit (unsigned long kbs)
void AddViewProxy (vtkSMViewProxy *proxy)
void RemoveViewProxy (vtkSMViewProxy *proxy)
void RemoveAllViewProxies ()
unsigned int GetNumberOfViewProxies ()
vtkSMViewProxyGetViewProxy (unsigned int cc)
virtual void SetCaching (bool)
virtual bool GetCaching ()
void SetTimeKeeper (vtkSMProxy *)
virtual vtkSMProxyGetTimeKeeper ()
virtual void SetLockStartTime (bool)
virtual bool GetLockStartTime ()
virtual void LockStartTimeOn ()
virtual void LockStartTimeOff ()
virtual void SetLockEndTime (bool)
virtual bool GetLockEndTime ()
virtual void LockEndTimeOn ()
virtual void LockEndTimeOff ()
void SetLoop (int val)
int GetLoop ()
void Play ()
void Stop ()
void GoToNext ()
void GoToPrevious ()
void GoToFirst ()
void GoToLast ()
void SetPlayMode (int val)
void SetNumberOfFrames (int val)
void SetDuration (int val)
void SetFramesPerTimestep (int val)

Static Public Member Functions

static vtkSMAnimationSceneNew ()
static int IsTypeOf (const char *type)
static vtkSMAnimationSceneSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkSMAnimationScene ()
 ~vtkSMAnimationScene ()
virtual void SetOverrideStillRender (bool)
virtual void TickInternal (double currenttime, double deltatime, double clocktime)
void TimeKeeperTimeRangeChanged ()
void TimeKeeperTimestepsChanged ()

Protected Attributes

bool Caching
bool LockStartTime
bool LockEndTime
vtkSMProxyTimeKeeper
vtkCompositeAnimationPlayerAnimationPlayer
vtkEventForwarderCommandForwarder
bool OverrideStillRender

Friends

class vtkSMAnimationSceneImageWriter

Detailed Description

extends vtkPVAnimationScene to add awareness about view proxies.

vtkSMAnimationScene subclasses vtkPVAnimationScene to add awareness about view proxies so that the scene can update view proxies using properties. vtkSMAnimationScene forwards the vtkCommand::StartEvent and vtkCommand::EndEvent from vtkCompositeAnimationPlayer to mark the start and end of animation playback.

Definition at line 36 of file vtkSMAnimationScene.h.


Constructor & Destructor Documentation

vtkSMAnimationScene::vtkSMAnimationScene ( ) [protected]
vtkSMAnimationScene::~vtkSMAnimationScene ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkPVAnimationScene.

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

Reimplemented from vtkPVAnimationScene.

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

Reimplemented from vtkPVAnimationScene.

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

Reimplemented from vtkPVAnimationScene.

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

Reimplemented from vtkPVAnimationScene.

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

Reimplemented from vtkPVAnimationScene.

void vtkSMAnimationScene::AddViewProxy ( vtkSMViewProxy proxy)

Add view proxies that are involved in the animation generated by this scene. When playing the animation, the scene will call StillRender() on the view proxies it is aware of, also updating any caching parameters.

void vtkSMAnimationScene::RemoveViewProxy ( vtkSMViewProxy proxy)

Add view proxies that are involved in the animation generated by this scene. When playing the animation, the scene will call StillRender() on the view proxies it is aware of, also updating any caching parameters.

void vtkSMAnimationScene::RemoveAllViewProxies ( )

Add view proxies that are involved in the animation generated by this scene. When playing the animation, the scene will call StillRender() on the view proxies it is aware of, also updating any caching parameters.

unsigned int vtkSMAnimationScene::GetNumberOfViewProxies ( )

Access the view proxies.

vtkSMViewProxy* vtkSMAnimationScene::GetViewProxy ( unsigned int  cc)

Access the view proxies.

virtual void vtkSMAnimationScene::SetCaching ( bool  ) [virtual]

Set if caching is enabled. If Caching is true, then on every time-step, this will update the UseCache and CacheKey properties on each of the views.

virtual bool vtkSMAnimationScene::GetCaching ( ) [virtual]

Set if caching is enabled. If Caching is true, then on every time-step, this will update the UseCache and CacheKey properties on each of the views.

void vtkSMAnimationScene::SetCacheLimit ( unsigned long  kbs)

Set the cache limit in KBs.

void vtkSMAnimationScene::SetTimeKeeper ( vtkSMProxy )

Set the time keeper. Time keeper is used to obtain the information about timesteps. This is required to play animation in "Snap To Timesteps" mode.

virtual vtkSMProxy* vtkSMAnimationScene::GetTimeKeeper ( ) [virtual]

Set the time keeper. Time keeper is used to obtain the information about timesteps. This is required to play animation in "Snap To Timesteps" mode.

virtual void vtkSMAnimationScene::SetLockStartTime ( bool  ) [virtual]

Lock the start time. When locked, the StartTime won't be automatically updated when data time changes.

virtual bool vtkSMAnimationScene::GetLockStartTime ( ) [virtual]

Lock the start time. When locked, the StartTime won't be automatically updated when data time changes.

virtual void vtkSMAnimationScene::LockStartTimeOn ( ) [virtual]

Lock the start time. When locked, the StartTime won't be automatically updated when data time changes.

virtual void vtkSMAnimationScene::LockStartTimeOff ( ) [virtual]

Lock the start time. When locked, the StartTime won't be automatically updated when data time changes.

virtual void vtkSMAnimationScene::SetLockEndTime ( bool  ) [virtual]

Lock the end time. When locked, the EndTime won't be automatically updated when the data time changes.

virtual bool vtkSMAnimationScene::GetLockEndTime ( ) [virtual]

Lock the end time. When locked, the EndTime won't be automatically updated when the data time changes.

virtual void vtkSMAnimationScene::LockEndTimeOn ( ) [virtual]

Lock the end time. When locked, the EndTime won't be automatically updated when the data time changes.

virtual void vtkSMAnimationScene::LockEndTimeOff ( ) [virtual]

Lock the end time. When locked, the EndTime won't be automatically updated when the data time changes.

void vtkSMAnimationScene::SetLoop ( int  val)
int vtkSMAnimationScene::GetLoop ( )
void vtkSMAnimationScene::Play ( )
void vtkSMAnimationScene::Stop ( )
void vtkSMAnimationScene::GoToNext ( )
void vtkSMAnimationScene::GoToPrevious ( )
void vtkSMAnimationScene::GoToFirst ( )
void vtkSMAnimationScene::GoToLast ( )
void vtkSMAnimationScene::SetPlayMode ( int  val)
void vtkSMAnimationScene::SetNumberOfFrames ( int  val)
void vtkSMAnimationScene::SetDuration ( int  val)
void vtkSMAnimationScene::SetFramesPerTimestep ( int  val)
virtual void vtkSMAnimationScene::TickInternal ( double  currenttime,
double  deltatime,
double  clocktime 
) [protected, virtual]

Overridden to ensure that caching parameters are passed to the view correctly.

Reimplemented from vtkPVAnimationScene.

void vtkSMAnimationScene::TimeKeeperTimeRangeChanged ( ) [protected]

Called when the timekeeper's time range changes.

void vtkSMAnimationScene::TimeKeeperTimestepsChanged ( ) [protected]

Called when the timekeeper's time range changes.

virtual void vtkSMAnimationScene::SetOverrideStillRender ( bool  ) [protected, virtual]

Friends And Related Function Documentation

friend class vtkSMAnimationSceneImageWriter [friend]

Definition at line 135 of file vtkSMAnimationScene.h.


Member Data Documentation

bool vtkSMAnimationScene::Caching [protected]

Definition at line 128 of file vtkSMAnimationScene.h.

Definition at line 129 of file vtkSMAnimationScene.h.

Definition at line 130 of file vtkSMAnimationScene.h.

Definition at line 131 of file vtkSMAnimationScene.h.

Definition at line 132 of file vtkSMAnimationScene.h.

Definition at line 133 of file vtkSMAnimationScene.h.

Definition at line 136 of file vtkSMAnimationScene.h.


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