pqAnimationManager Class Reference

pqAnimationManager manages the Animation sub-system. More...

#include <pqAnimationManager.h>

Inherits QObject.

Public Slots
void	onActiveServerChanged (pqServer *)

Signals
void	activeSceneChanged (pqAnimationScene *scene)
	emitted when the active scene changes (scene may be nullptr). More...
void	activeServerChanged (pqServer *scene)
	emitted when the active server changes and updated active scene. More...
void	saveProgress (const QString &, int)
	emitted with the current save progress. More...
void	beginNonUndoableChanges ()
	emitted when the manager begins changes that should not get recorded on the undo stack. More...
void	endNonUndoableChanges ()
	emitted when the manager is done with changes that should not get recorded on the undo stack. More...
void	writeAnimation (const QString &filename, int magnification, double frameRate)
	emitted to indicate an animation is being written out to a file. More...
void	beginPlay (vtkObject *caller, unsigned long, void *, void *reversed)
	Emitted when the active animation scene begins playing. More...
void	endPlay (vtkObject *caller, unsigned long, void *, void *reversed)
	Emitted when the active animation scene finishes playing. More...

Public Member Functions
	pqAnimationManager (QObject *parent=nullptr)
	~pqAnimationManager () override
pqAnimationScene *	getActiveScene () const
	Returns the scene for the active server connection, if any. More...
pqAnimationScene *	getScene (pqServer *server) const
	Returns the scene on the server connection, if any. More...
pqAnimationCue *	getCue (pqAnimationScene *scene, vtkSMProxy *proxy, const char *propertyname, int index) const
	In the given scene, returns the cue that animates the given index of the given property on the proxy. More...
bool	saveGeometry (const QString &filename, pqView *view)
	Saves the animation geometry from the active scene as visible in the given view. More...
bool	animationPlaying () const
	Query whether or not an animation is currently playing. More...

Protected Slots
void	onProxyAdded (pqProxy *)
void	onProxyRemoved (pqProxy *)
void	onTick (int)
	Called on every tick while saving animation. More...
void	onBeginPlay (vtkObject *caller, unsigned long, void *, void *reversed)
	Called to demarcate the start and end of an animation. More...
void	onEndPlay (vtkObject *caller, unsigned long, void *, void *reversed)

Detailed Description

pqAnimationManager manages the Animation sub-system.

It encapsulates the initialization of animation scene per server connection i.e. this class basically keeps track of the active animation scene.

Definition at line 27 of file pqAnimationManager.h.

Constructor & Destructor Documentation

pqAnimationManager()

pqAnimationManager::pqAnimationManager

(

QObject *

parent = nullptr

)

~pqAnimationManager()

pqAnimationManager::~pqAnimationManager ( )

override

Member Function Documentation

getActiveScene()

pqAnimationScene* pqAnimationManager::getActiveScene

(

)

const

Returns the scene for the active server connection, if any.

getScene()

pqAnimationScene* pqAnimationManager::getScene

(

pqServer *

server

)

const

Returns the scene on the server connection, if any.

getCue()

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

In the given scene, returns the cue that animates the given index of the given property on the proxy.

This method simply calls getCue() on the pqAnimationScene instance.

saveGeometry()

bool pqAnimationManager::saveGeometry	(	const QString &	filename,
		pqView *	view
	)

Saves the animation geometry from the active scene as visible in the given view.

animationPlaying()

bool pqAnimationManager::animationPlaying

(

)

const

Query whether or not an animation is currently playing.

activeSceneChanged

void pqAnimationManager::activeSceneChanged ( pqAnimationScene *  scene )

signal

emitted when the active scene changes (scene may be nullptr).

activeServerChanged

void pqAnimationManager::activeServerChanged ( pqServer *  scene )

signal

emitted when the active server changes and updated active scene.

saveProgress

void pqAnimationManager::saveProgress ( const QString &  , int    )

signal

emitted with the current save progress.

beginNonUndoableChanges

void pqAnimationManager::beginNonUndoableChanges ( )

signal

emitted when the manager begins changes that should not get recorded on the undo stack.

endNonUndoableChanges

void pqAnimationManager::endNonUndoableChanges ( )

signal

emitted when the manager is done with changes that should not get recorded on the undo stack.

writeAnimation

void pqAnimationManager::writeAnimation ( const QString &  filename, int  magnification, double  frameRate  )

signal

emitted to indicate an animation is being written out to a file.

beginPlay

void pqAnimationManager::beginPlay ( vtkObject *  caller, unsigned  long, void *  , void *  reversed  )

signal

Emitted when the active animation scene begins playing.

endPlay

void pqAnimationManager::endPlay ( vtkObject *  caller, unsigned  long, void *  , void *  reversed  )

signal

Emitted when the active animation scene finishes playing.

onActiveServerChanged

void pqAnimationManager::onActiveServerChanged ( pqServer *  )

slot

onProxyAdded

void pqAnimationManager::onProxyAdded ( pqProxy *  )

protectedslot

onProxyRemoved

void pqAnimationManager::onProxyRemoved ( pqProxy *  )

protectedslot

onTick

void pqAnimationManager::onTick ( int  )

protectedslot

Called on every tick while saving animation.

onBeginPlay

void pqAnimationManager::onBeginPlay ( vtkObject *  caller, unsigned  long, void *  , void *  reversed  )

protectedslot

Called to demarcate the start and end of an animation.

onEndPlay

void pqAnimationManager::onEndPlay ( vtkObject *  caller, unsigned  long, void *  , void *  reversed  )

protectedslot

---

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

• /builds/gitlab-kitware-sciviz-ci/Qt/Components/pqAnimationManager.h