pqAnimationCue Class Reference

#include <pqAnimationCue.h>

Inheritance diagram for pqAnimationCue:

Collaboration diagram for pqAnimationCue:

Signals
void	keyframesModified ()
void	modified ()
void	enabled (bool)
	Fired when the enabled-state of the cue changes. 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
	pqAnimationCue (const QString &group, const QString &name, vtkSMProxy *proxy, pqServer *server, QObject *parent=NULL)
	~pqAnimationCue () override
int	getNumberOfKeyFrames () const
QList< vtkSMProxy * >	getKeyFrames () const
vtkSMProxy *	insertKeyFrame (int index)
void	deleteKeyFrame (int index)
vtkSMProxy *	getKeyFrame (int index) const
vtkSMProxy *	getAnimatedProxy () const
vtkSMProperty *	getAnimatedProperty () const
int	getAnimatedPropertyIndex () const
void	setKeyFrameType (const QString &type)
	Set the type of the keyframe created by default. More...
void	triggerKeyFramesModified ()
	Used by editors to trigger keyframesModified() signal after bulk of modifications have been made to the cue/key frames. More...
void	setEnabled (bool enable)
	Get/Set the enabled state for the cue. More...
bool	isEnabled () const
Public Member Functions inherited from pqProxy
	pqProxy (const QString &group, const QString &name, vtkSMProxy *proxy, pqServer *server, QObject *parent=NULL)
	~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=NULL)
	~pqServerManagerModelItem () override

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 *)
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...

Detailed Description

Definition at line 40 of file pqAnimationCue.h.

Constructor & Destructor Documentation

pqAnimationCue()

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

~pqAnimationCue()

pqAnimationCue::~pqAnimationCue ( )

override

Member Function Documentation

getNumberOfKeyFrames()

int pqAnimationCue::getNumberOfKeyFrames

(

)

const

getKeyFrames()

QList<vtkSMProxy*> pqAnimationCue::getKeyFrames

(

)

const

insertKeyFrame()

vtkSMProxy* pqAnimationCue::insertKeyFrame

(

int

index

)

deleteKeyFrame()

void pqAnimationCue::deleteKeyFrame

(

int

index

)

getKeyFrame()

vtkSMProxy* pqAnimationCue::getKeyFrame

(

int

index

)

const

getAnimatedProxy()

vtkSMProxy* pqAnimationCue::getAnimatedProxy

(

)

const

getAnimatedProperty()

vtkSMProperty* pqAnimationCue::getAnimatedProperty

(

)

const

getAnimatedPropertyIndex()

int pqAnimationCue::getAnimatedPropertyIndex

(

)

const

setKeyFrameType()

void pqAnimationCue::setKeyFrameType ( const QString &  type )

inline

Set the type of the keyframe created by default.

default is CompositeKeyFrame.

Definition at line 84 of file pqAnimationCue.h.

triggerKeyFramesModified()

void pqAnimationCue::triggerKeyFramesModified ( )

inline

Used by editors to trigger keyframesModified() signal after bulk of modifications have been made to the cue/key frames.

Definition at line 90 of file pqAnimationCue.h.

setEnabled()

void pqAnimationCue::setEnabled

(

bool

enable

)

Get/Set the enabled state for the cue.

isEnabled()

bool pqAnimationCue::isEnabled

(

)

const

keyframesModified

void pqAnimationCue::keyframesModified ( )

signal

modified

void pqAnimationCue::modified ( )

signal

enabled

void pqAnimationCue::enabled ( bool  )

signal

Fired when the enabled-state of the cue changes.

---

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

• /home/paraview/Qt/Core/pqAnimationCue.h