vtkPVAnimationScene Class Reference

the animation scene manager. More...

#include <vtkPVAnimationScene.h>

Inheritance diagram for vtkPVAnimationScene:

Collaboration diagram for vtkPVAnimationScene:

List of all members.

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual double	GetSceneTime ()
void	AddCue (vtkAnimationCue *cue)
void	RemoveCue (vtkAnimationCue *cue)
void	RemoveAllCues ()
int	GetNumberOfCues ()
void	SetSceneTime (double time)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkPVAnimationScene *	SafeDownCast (vtkObject *o)
static vtkPVAnimationScene *	New ()
Protected Member Functions
	vtkPVAnimationScene ()
	~vtkPVAnimationScene ()
void	InitializeChildren ()
void	FinalizeChildren ()
virtual void	StartCueInternal ()
virtual void	TickInternal (double currenttime, double deltatime, double clocktime)
virtual void	EndCueInternal ()
Protected Attributes
vtkCollection *	AnimationCues
vtkCollectionIterator *	AnimationCuesIterator
bool	InTick
double	SceneTime

---

Detailed Description

the animation scene manager.

vtkAnimationCue and vtkPVAnimationScene provide the framework to support animations in VTK. vtkAnimationCue represents an entity that changes/ animates with time, while vtkPVAnimationScene represents scene or setup for the animation, which consists of individual cues or other scenes.

The main difference between vtkAnimationScene and vtkPVAnimationScene is that vtkPVAnimationScene does not include any of the scene playing logic. All that has been moved to the vtkAnimationPlayer (and subclasses).

See also:

vtkAnimationCue

Definition at line 40 of file vtkPVAnimationScene.h.

---

Constructor & Destructor Documentation

vtkPVAnimationScene::vtkPVAnimationScene

(

)

[protected]

vtkPVAnimationScene::~vtkPVAnimationScene

(

)

[protected]

---

Member Function Documentation

virtual const char* vtkPVAnimationScene::GetClassName

(

)

[virtual]

Reimplemented from vtkAnimationCue.

Reimplemented in vtkSMAnimationScene.

static int vtkPVAnimationScene::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkAnimationCue.

Reimplemented in vtkSMAnimationScene.

virtual int vtkPVAnimationScene::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkAnimationCue.

Reimplemented in vtkSMAnimationScene.

static vtkPVAnimationScene* vtkPVAnimationScene::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkAnimationCue.

Reimplemented in vtkSMAnimationScene.

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

Reimplemented from vtkAnimationCue.

Reimplemented in vtkSMAnimationScene.

static vtkPVAnimationScene* vtkPVAnimationScene::New

(

)

[static]

Reimplemented from vtkAnimationCue.

Reimplemented in vtkSMAnimationScene.

void vtkPVAnimationScene::AddCue

(

vtkAnimationCue *

cue

)

Add/Remove an AnimationCue to/from the Scene. It's an error to add a cue twice to the Scene.

void vtkPVAnimationScene::RemoveCue

(

vtkAnimationCue *

cue

)

Add/Remove an AnimationCue to/from the Scene. It's an error to add a cue twice to the Scene.

void vtkPVAnimationScene::RemoveAllCues

(

)

Add/Remove an AnimationCue to/from the Scene. It's an error to add a cue twice to the Scene.

int vtkPVAnimationScene::GetNumberOfCues

(

)

Add/Remove an AnimationCue to/from the Scene. It's an error to add a cue twice to the Scene.

void vtkPVAnimationScene::SetSceneTime

(

double

time

)

[inline]

Sets the current animation time.

Definition at line 58 of file vtkPVAnimationScene.h.

virtual double vtkPVAnimationScene::GetSceneTime

(

)

[virtual]

virtual void vtkPVAnimationScene::StartCueInternal

(

)

[protected, virtual]

Called on every valid tick. Calls ticks on all the contained cues.

Reimplemented from vtkAnimationCue.

virtual void vtkPVAnimationScene::TickInternal	(	double	currenttime,
		double	deltatime,
		double	clocktime
	)		[protected, virtual]

Called on every valid tick. Calls ticks on all the contained cues.

Reimplemented from vtkAnimationCue.

Reimplemented in vtkSMAnimationScene.

virtual void vtkPVAnimationScene::EndCueInternal

(

)

[protected, virtual]

Called on every valid tick. Calls ticks on all the contained cues.

Reimplemented from vtkAnimationCue.

void vtkPVAnimationScene::InitializeChildren

(

)

[protected]

void vtkPVAnimationScene::FinalizeChildren

(

)

[protected]

---

Member Data Documentation

vtkCollection* vtkPVAnimationScene::AnimationCues [protected]

Definition at line 90 of file vtkPVAnimationScene.h.

vtkCollectionIterator* vtkPVAnimationScene::AnimationCuesIterator [protected]

Definition at line 91 of file vtkPVAnimationScene.h.

bool vtkPVAnimationScene::InTick [protected]

Definition at line 93 of file vtkPVAnimationScene.h.

double vtkPVAnimationScene::SceneTime [protected]

Definition at line 94 of file vtkPVAnimationScene.h.

---

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

• dox/ParaViewCore/VTKExtensions/vtkPVAnimationScene.h