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. More...

void	pause ()
	Pause animation. More...

void	setAnimationTime (double time)
	Set the animation time. More...

Signals
void	preAddedCue (pqAnimationCue *)
	Fired before a new cue is added to the scene. More...

void	addedCue (pqAnimationCue *)
	Fired after a new cue has been added to the scene. More...

void	preRemovedCue (pqAnimationCue *)
	Fired before a cue is removed from the scene. More...

void	removedCue (pqAnimationCue *)
	Fired after a cue has been removed from the scene. More...

void	cuesChanged ()
	Fired after cues have been added/removed. More...

void	playModeChanged ()
	Emitted when the play mode changes. More...

void	loopChanged ()
	Emitted when the looping state changes on the underlying proxy. More...

void	clockTimeRangesChanged ()
	Emitted when the clock time ranges change. More...

void	beginPlay (vtkObject caller, unsigned long, void , void *reversed)
	Emitted when animation starts playing. More...

void	endPlay (vtkObject caller, unsigned long, void , void *reversed)
	Emitted when animation ends playing. More...

void	tick (int percentCompleted)
	Emitted when playing animation. More...

void	animationTime (double time)
	Emitted when playing (or when animation time for the scene is set). More...

void	frameCountChanged ()
	Emitted when the number of frames changes. More...

void	timeStepsChanged ()
	Emitted when the number of timesteps changes. More...

void	timeLabelChanged ()
	Emitted when a source is changing the label that should be use for time. More...

Signals inherited from pqProxy
void	nameChanged (pqServerManagerModelItem *)
	Fired when the name of the proxy is changed. More...

void	modifiedStateChanged (pqServerManagerModelItem *)
	Fired when the modified status changes for the proxy. More...

Public Member Functions
	pqAnimationScene (const QString &group, const QString &name, vtkSMProxy proxy, pqServer server, QObject *parent=nullptr)

	~pqAnimationScene () override

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. More...

void	removeCues (vtkSMProxy *proxy)
	Removes all cues which animate the indicated proxy, if any. More...

void	removeCue (pqAnimationCue *cue)
	Removes cue. More...

bool	contains (pqAnimationCue *) const
	returns true is the cue is present in this scene. More...

QPair< double, double >	getClockTimeRange () const
	Get the clock time range set on the animation scene proxy. More...

QSet< pqAnimationCue * >	getCues () const
	Get all the cues in this scene. More...

double	getAnimationTime () const
	Returns the current animation time. More...

QList< double >	getTimeSteps () const
	Returns the timesteps from the timekeeper for the animation scene. More...


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. More...

pqAnimationCue *	createCue (vtkSMProxy proxy, const char propertyname, int index, const QString &cuetype)
	Creates and initializes a new cue that can animate the `index` of the `property` on the given `proxy` in this scene. More...

pqAnimationCue *	createCue (const QString &cuetype)
	Creates and initializes a new cue that can animate the `index` of the `property` on the given `proxy` in this scene. More...

pqAnimationCue *	createCue (const pqAnimatedPropertyInfo &propInfo)
	Creates and initializes a new cue that can animate the `index` of the `property` on the given `proxy` in this scene. More...

Public Member Functions inherited from pqProxy
	pqProxy (const QString &group, const QString &name, vtkSMProxy proxy, pqServer server, QObject *parent=nullptr)

	~pqProxy () override

pqServer *	getServer () const
	Get the server on which this proxy exists. More...

void	rename (const QString &newname)
	This is a convenience method. More...

const QString &	getSMName ()
	Get the name with which this proxy is registered on the server manager. More...

const QString &	getSMGroup ()

vtkSMProxy *	getProxy () const
	Get the vtkSMProxy this object stands for. More...

ModifiedState	modifiedState () const
	Gets whether or not the source has been modified. More...

void	setModifiedState (ModifiedState modified)
	Sets whether or not the source has been modified. More...

vtkPVXMLElement *	getHints () const
	Returns the hints for this proxy, if any. More...

QList< vtkSMProxy * >	getHelperProxies () const
	Returns a list of all helper proxies. More...

QList< vtkSMProxy * >	getHelperProxies (const QString &key) const
	Returns a list of all the helper proxies added with a given key. More...

QList< QString >	getHelperKeys () const
	Returns the keys for helper proxies. More...

virtual void	addHelperProxy (const QString &key, vtkSMProxy *)
	Concept of helper proxies: A pqProxy is created for every important vtkSMProxy registered. More...

void	removeHelperProxy (const QString &key, vtkSMProxy *)

void	updateHelperProxies () const
	Updates the internal datastructures using the proxies currently registered under the group that would be used for helper proxies. More...

vtkSMSessionProxyManager *	proxyManager () const
	Returns the proxy manager by calling this->getProxy()->GetProxyManager();. More...

bool	userModifiedSMName ()
	Return whether or not the user has modified the GUI name of the source. More...

Public Member Functions inherited from pqServerManagerModelItem
	pqServerManagerModelItem (QObject *parent=nullptr)

	~pqServerManagerModelItem () override

Protected Member Functions
void	initializeCue (vtkSMProxy proxy, const char propertyname, int index, pqAnimationCue *cue)
	Initializes the newly create animation cue with default keyframes. More...

Protected Member Functions inherited from pqProxy
void	setSMName (const QString &new_name)
	Make this pqProxy take on a new identity. More...

virtual void	initialize ()

virtual void	addInternalHelperProxy (const QString &key, vtkSMProxy *) const

virtual void	removeInternalHelperProxy (const QString &key, vtkSMProxy *) const

Protected Member Functions inherited from pqServerManagerModelItem
vtkEventQtSlotConnect *	getConnector ()
	All subclasses generally need some vtkEventQtSlotConnect instance to connect to VTK events. More...

Additional Inherited Members
Public Types inherited from pqProxy
enum	ModifiedState { UNINITIALIZED, MODIFIED, UNMODIFIED }
	The modification state of this proxy. More...

Static Public Member Functions inherited from pqProxy
static pqProxy *	findProxyWithHelper (vtkSMProxy *aproxy, QString &key)
	Returns a pqProxy instance, of any, whose helper proxy is the aproxy. More...

static std::string	rstToHtml (const char *rstStr)
	convert proxy documentation from RST to HTML (so that it can be used in Qt) More...

static QString	rstToHtml (const QString &rstStr)
	convert proxy documentation from RST to HTML (so that it can be used in Qt) More...

Protected Slots inherited from pqProxy
void	onProxyRegistered (const QString &, const QString &, vtkSMProxy *)

void	onProxyUnRegistered (const QString &, const QString &, vtkSMProxy *)

Detailed Description

pqAnimationScene is a representation for a vtkSMAnimationScene proxy.

It provides API to access AnimationCues in the scene and to the scene times.

Definition at line 21 of file pqAnimationScene.h.

Constructor & Destructor Documentation

◆ pqAnimationScene()

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

◆ ~pqAnimationScene()

pqAnimationScene::~pqAnimationScene ( )

override

Member Function Documentation

◆ getCue()

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.

◆ createCue() [1/4]

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.

◆ createCue() [2/4]

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

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.

◆ createCue() [3/4]

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

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.

◆ createCue() [4/4]

pqAnimationCue* pqAnimationScene::createCue ( const pqAnimatedPropertyInfo & propInfo )

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.

◆ removeCues()

void pqAnimationScene::removeCues ( vtkSMProxy * proxy )

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

◆ removeCue()

void pqAnimationScene::removeCue ( pqAnimationCue * cue )

Removes cue.

◆ contains()

bool pqAnimationScene::contains ( pqAnimationCue * ) const

returns true is the cue is present in this scene.

◆ getClockTimeRange()

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

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

◆ getCues()

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

Get all the cues in this scene.

◆ getAnimationTime()

double pqAnimationScene::getAnimationTime ( ) const

Returns the current animation time.

◆ getTimeSteps()

QList<double> pqAnimationScene::getTimeSteps ( ) const

Returns the timesteps from the timekeeper for the animation scene.

◆ preAddedCue

void pqAnimationScene::preAddedCue ( pqAnimationCue * )

signal

Fired before a new cue is added to the scene.

◆ addedCue

void pqAnimationScene::addedCue ( pqAnimationCue * )

signal

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

◆ preRemovedCue

void pqAnimationScene::preRemovedCue ( pqAnimationCue * )

signal

Fired before a cue is removed from the scene.

◆ removedCue

void pqAnimationScene::removedCue ( pqAnimationCue * )

signal

Fired after a cue has been removed from the scene.

◆ cuesChanged

void pqAnimationScene::cuesChanged ( )

signal

Fired after cues have been added/removed.

◆ playModeChanged

void pqAnimationScene::playModeChanged ( )

signal

Emitted when the play mode changes.

◆ loopChanged

void pqAnimationScene::loopChanged ( )

signal

Emitted when the looping state changes on the underlying proxy.

◆ clockTimeRangesChanged

void pqAnimationScene::clockTimeRangesChanged ( )

signal

Emitted when the clock time ranges change.

◆ beginPlay

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

signal

Emitted when animation starts playing.

reversed is a pointer to boolean that indicates if the playback direction is backward

◆ endPlay

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

signal

Emitted when animation ends playing.

reversed is a pointer to boolean that indicates if the playback direction is backward

◆ tick

void pqAnimationScene::tick ( int percentCompleted )

signal

Emitted when playing animation.

Argument is the percent of play completed.

◆ animationTime

void pqAnimationScene::animationTime ( double time )

signal

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

time is the animation clock time.

◆ frameCountChanged

void pqAnimationScene::frameCountChanged ( )

signal

Emitted when the number of frames changes.

◆ timeStepsChanged

void pqAnimationScene::timeStepsChanged ( )

signal

Emitted when the number of timesteps changes.

◆ timeLabelChanged

void pqAnimationScene::timeLabelChanged ( )

signal

Emitted when a source is changing the label that should be use for time.

◆ play

void pqAnimationScene::play ( )

slot

Play animation.

◆ pause

void pqAnimationScene::pause ( )

slot

Pause animation.

◆ setAnimationTime

void pqAnimationScene::setAnimationTime ( double time )

slot

Set the animation time.

◆ initializeCue()

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:

/builds/gitlab-kitware-sciviz-ci/Qt/Core/pqAnimationScene.h

Public Slots

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pqAnimationScene()

◆ ~pqAnimationScene()

Member Function Documentation

◆ getCue()

◆ createCue() [1/4]

◆ createCue() [2/4]

◆ createCue() [3/4]

◆ createCue() [4/4]

◆ removeCues()

◆ removeCue()

◆ contains()

◆ getClockTimeRange()

◆ getCues()

◆ getAnimationTime()

◆ getTimeSteps()

◆ preAddedCue

◆ addedCue

◆ preRemovedCue

◆ removedCue

◆ cuesChanged

◆ playModeChanged

◆ loopChanged

◆ clockTimeRangesChanged

◆ beginPlay

◆ endPlay

◆ tick

◆ animationTime

◆ frameCountChanged

◆ timeStepsChanged

◆ timeLabelChanged

◆ play

◆ pause

◆ setAnimationTime

◆ initializeCue()