pqAnimationScene is a representation for a vtkSMAnimationScene proxy. More...

#include <pqAnimationScene.h>

Inheritance diagram for pqAnimationScene:

Collaboration diagram for pqAnimationScene:

Public Slots
void	play ()
	Play animation.
void	pause ()
	Pause animation.
void	setAnimationTime (double time)
	Set the animation time.
void	updateApplicationSettings ()
	Refreshes state of the scene to the current application settings.
Signals
void	preAddedCue (pqAnimationCue *)
	Fired before a new cue is added to the scene.
void	addedCue (pqAnimationCue *)
	Fired after a new cue has been added to the scene.
void	preRemovedCue (pqAnimationCue *)
	Fired before a cue is removed from the scene.
void	removedCue (pqAnimationCue *)
	Fired after a cue has been removed from the scene.
void	cuesChanged ()
	Fired after cues have been added/removed.
void	playModeChanged ()
	Emitted when the play mode changes.
void	loopChanged ()
	Emitted when the looping state changes on the underlying proxy.
void	clockTimeRangesChanged ()
	Emitted when the clock time ranges change.
void	beginPlay ()
	Emitted when animation starts playing.
void	endPlay ()
	Emitted when animation ends playing.
void	tick (int percentCompleted)
	Emitted when playing animation.
void	animationTime (double time)
	Emitted when playing (or when animation time for the scene is set).
void	frameCountChanged ()
	Emitted when the number of frames changes.
void	timeStepsChanged ()
	Emitted when the number of timesteps changes.
Public Member Functions
	pqAnimationScene (const QString &group, const QString &name, vtkSMProxy proxy, pqServer server, QObject *parent=NULL)
virtual	~pqAnimationScene ()
pqAnimationCue *	getCue (vtkSMProxy proxy, const char propertyname, int index) const
	Returns the cue that animates the given `index` of the given `property` on the given `proxy`, in this scene, if any.
pqAnimationCue *	createCue (vtkSMProxy proxy, const char propertyname, int index)
	Creates and initializes a new cue that can animate the `index` of the `property` on the given `proxy` in this scene.
pqAnimationCue *	createCue (vtkSMProxy proxy, const char propertyname, int index, const QString &cuetype)
pqAnimationCue *	createCue (const QString &cuetype)
void	removeCues (vtkSMProxy *proxy)
	Removes all cues which animate the indicated proxy, if any.
void	removeCue (pqAnimationCue *cue)
	Removes cue.
bool	contains (pqAnimationCue *) const
	returns true is the cue is present in this scene.
QPair< double, double >	getClockTimeRange () const
	Get the clock time range set on the animation scene proxy.
QSet< pqAnimationCue * >	getCues () const
	Get all the cues in this scene.
virtual void	setDefaultPropertyValues ()
	set default property values.
double	getAnimationTime () const
	Returns the current animation time.
QList< double >	getTimeSteps () const
	Returns the timesteps from the timekeeper for the animation scene.
Static Public Member Functions
static void	setCacheGeometrySetting (bool flag)
	Application settings for caching.
static bool	getCacheGeometrySetting ()
static void	setCacheLimitSetting (int kilobytes)
static int	getCacheLimitSetting ()
Protected Member Functions
void	initializeCue (vtkSMProxy proxy, const char propertyname, int index, pqAnimationCue *cue)
	Initializes the newly create animation cue with default keyframes.

Detailed Description

pqAnimationScene is a representation for a vtkSMAnimationScene proxy.

It provides API to access AnimationCues in the scene.

Definition at line 45 of file pqAnimationScene.h.

Constructor & Destructor Documentation

pqAnimationScene::pqAnimationScene	(	const QString &	group,
		const QString &	name,
		vtkSMProxy *	proxy,
		pqServer *	server,
		QObject *	parent = `NULL`
	)

virtual pqAnimationScene::~pqAnimationScene ( ) [virtual]

Member Function Documentation

pqAnimationCue* pqAnimationScene::getCue	(	vtkSMProxy *	proxy,
		const char *	propertyname,
		int	index
	)		const

Returns the cue that animates the given index of the given property on the given proxy, in this scene, if any.

pqAnimationCue* pqAnimationScene::createCue	(	vtkSMProxy *	proxy,
		const char *	propertyname,
		int	index
	)

Creates and initializes a new cue that can animate the index of the property on the given proxy in this scene.

This method does not check is such a cue already exists, use getCue() before calling this to avoid duplicates.

pqAnimationCue* pqAnimationScene::createCue	(	vtkSMProxy *	proxy,
		const char *	propertyname,
		int	index,
		const QString &	cuetype
	)

pqAnimationCue* pqAnimationScene::createCue ( const QString & cuetype )

void pqAnimationScene::removeCues ( vtkSMProxy * proxy )

Removes all cues which animate the indicated proxy, if any.

void pqAnimationScene::removeCue ( pqAnimationCue * cue )

Removes cue.

bool pqAnimationScene::contains ( pqAnimationCue * ) const

returns true is the cue is present in this scene.

QPair<double, double> pqAnimationScene::getClockTimeRange ( ) const

Get the clock time range set on the animation scene proxy.

QSet<pqAnimationCue*> pqAnimationScene::getCues ( ) const

Get all the cues in this scene.

virtual void pqAnimationScene::setDefaultPropertyValues ( ) [virtual]

set default property values.

Overridden to create the default pipeline time animation cue.

Reimplemented from pqProxy.

double pqAnimationScene::getAnimationTime ( ) const

Returns the current animation time.

QList<double> pqAnimationScene::getTimeSteps ( ) const

Returns the timesteps from the timekeeper for the animation scene.

static void pqAnimationScene::setCacheGeometrySetting ( bool flag ) [static]

Application settings for caching.

When caching is on, polygonal geometry will be saved at every time step up to the given limit. The limit is given in kilobytes.

static bool pqAnimationScene::getCacheGeometrySetting ( ) [static]

static void pqAnimationScene::setCacheLimitSetting ( int kilobytes ) [static]

static int pqAnimationScene::getCacheLimitSetting ( ) [static]

void pqAnimationScene::preAddedCue ( pqAnimationCue * ) [signal]

Fired before a new cue is added to the scene.

void pqAnimationScene::addedCue ( pqAnimationCue * ) [signal]

Fired after a new cue has been added to the scene.

void pqAnimationScene::preRemovedCue ( pqAnimationCue * ) [signal]

Fired before a cue is removed from the scene.

void pqAnimationScene::removedCue ( pqAnimationCue * ) [signal]

Fired after a cue has been removed from the scene.

void pqAnimationScene::cuesChanged ( ) [signal]

Fired after cues have been added/removed.

void pqAnimationScene::playModeChanged ( ) [signal]

Emitted when the play mode changes.

void pqAnimationScene::loopChanged ( ) [signal]

Emitted when the looping state changes on the underlying proxy.

void pqAnimationScene::clockTimeRangesChanged ( ) [signal]

Emitted when the clock time ranges change.

void pqAnimationScene::beginPlay ( ) [signal]

Emitted when animation starts playing.

void pqAnimationScene::endPlay ( ) [signal]

Emitted when animation ends playing.

void pqAnimationScene::tick ( int percentCompleted ) [signal]

Emitted when playing animation.

Argument is the percent of play completed.

void pqAnimationScene::animationTime ( double time ) [signal]

Emitted when playing (or when animation time for the scene is set).

time is the animation clock time.

void pqAnimationScene::frameCountChanged ( ) [signal]

Emitted when the number of frames changes.

void pqAnimationScene::timeStepsChanged ( ) [signal]

Emitted when the number of timesteps changes.

void pqAnimationScene::play ( ) [slot]

Play animation.

void pqAnimationScene::pause ( ) [slot]

Pause animation.

void pqAnimationScene::setAnimationTime ( double time ) [slot]

Set the animation time.

void pqAnimationScene::updateApplicationSettings ( ) [slot]

Refreshes state of the scene to the current application settings.

Should be called when the application settings change.

void pqAnimationScene::initializeCue	(	vtkSMProxy *	proxy,
		const char *	propertyname,
		int	index,
		pqAnimationCue *	cue
	)		`[protected]`

Initializes the newly create animation cue with default keyframes.

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

/home/kitware/Dashboards/My Tests/ParaView/Qt/Core/pqAnimationScene.h

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation