Signals | Public Member Functions | Static Public Member Functions | List of all members
pqAnimationCue Class Reference

pqAnimationCue is the pqProxy wrapping an animation proxy. More...

#include <pqAnimationCue.h>

Inheritance diagram for pqAnimationCue:
Inheritance graph
[legend]
Collaboration diagram for pqAnimationCue:
Collaboration graph
[legend]

Signals

void keyframesModified ()
 emitted when something about the keyframes changes. More...
 
void modified ()
 Fired when the animated proxy/property/index changes. More...
 
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=nullptr)
 
 ~pqAnimationCue () override
 
int getNumberOfKeyFrames () const
 Returns the number of keyframes in this cue. More...
 
QList< vtkSMProxy * > getKeyFrames () const
 Returns a list of the keyframes. More...
 
vtkSMProxyinsertKeyFrame (int index)
 Insert a new keyframe at the given index. More...
 
void deleteKeyFrame (int index)
 Deletes the keyframe at the given index. More...
 
vtkSMProxygetKeyFrame (int index) const
 Returns keyframe at a given index, if one exists, nullptr otherwise. More...
 
vtkSMProxygetAnimatedProxy () const
 Returns the animated proxy, if any. More...
 
vtkSMPropertygetAnimatedProperty () const
 Returns the property that is animated by this cue, if any. More...
 
QString getAnimatedPropertyName () const
 Returns the property name that is animated. More...
 
int getAnimatedPropertyIndex () const
 Returns the index of the property being animated. More...
 
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...
 
QString getDisplayName ()
 Return a string formatted from proxy registration name, property name and index. More...
 
bool isCameraCue ()
 Return true if underlying proxy is of type CameraAnimationCue. More...
 
bool isPythonCue ()
 Return true if underlying proxy is of type PythonAnimationCue. More...
 
bool isTimekeeperCue ()
 Return true if underlying proxy is of type TimeAnimationCue. More...
 
void setEnabled (bool enable)
 Get/Set the enabled state for the cue. More...
 
bool isEnabled () const
 Get/Set the enabled state for the cue. More...
 
- Public Member Functions inherited from pqProxy
 pqProxy (const QString &group, const QString &name, vtkSMProxy *proxy, pqServer *server, QObject *parent=nullptr)
 
 ~pqProxy () override
 
pqServergetServer () 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 ()
 
vtkSMProxygetProxy () 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...
 
vtkPVXMLElementgetHints () 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...
 
vtkSMSessionProxyManagerproxyManager () 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
 

Static Public Member Functions

static QString getCameraModeName (int mode)
 Returns the string version of the camera mode. More...
 
- Static Public Member Functions inherited from pqProxy
static pqProxyfindProxyWithHelper (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...
 

Additional Inherited Members

- Public Types inherited from pqProxy
enum  ModifiedState { UNINITIALIZED, MODIFIED, UNMODIFIED }
 The modification state of this proxy. 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
vtkEventQtSlotConnectgetConnector ()
 All subclasses generally need some vtkEventQtSlotConnect instance to connect to VTK events. More...
 

Detailed Description

pqAnimationCue is the pqProxy wrapping an animation proxy.

It offers a proper API to get informations about the animated vtkSMProxy and to manipulate the cue keyframes. ! Note the difference between the cue proxy (used as constructor parameter) and the animated proxy (the concrete object that will be animated) !

Supported cue vtkSMProxy are mainly CameraAnimationCue, PythonAnimationCue, TimeAnimationCue and KeyFrameAnimationCue.

Definition at line 35 of file pqAnimationCue.h.

Constructor & Destructor Documentation

◆ pqAnimationCue()

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

◆ ~pqAnimationCue()

pqAnimationCue::~pqAnimationCue ( )
override

Member Function Documentation

◆ getNumberOfKeyFrames()

int pqAnimationCue::getNumberOfKeyFrames ( ) const

Returns the number of keyframes in this cue.

◆ getKeyFrames()

QList<vtkSMProxy*> pqAnimationCue::getKeyFrames ( ) const

Returns a list of the keyframes.

◆ insertKeyFrame()

vtkSMProxy* pqAnimationCue::insertKeyFrame ( int  index)

Insert a new keyframe at the given index.

The time for the key frame is computed using the times for the neighbouring keyframes if any. Returns the newly created keyframe proxy on success, nullptr otherwise.

◆ deleteKeyFrame()

void pqAnimationCue::deleteKeyFrame ( int  index)

Deletes the keyframe at the given index.

Consequently, the keyframesModified() signal will get fired.

◆ getKeyFrame()

vtkSMProxy* pqAnimationCue::getKeyFrame ( int  index) const

Returns keyframe at a given index, if one exists, nullptr otherwise.

◆ getAnimatedProxy()

vtkSMProxy* pqAnimationCue::getAnimatedProxy ( ) const

Returns the animated proxy, if any.

◆ getAnimatedProperty()

vtkSMProperty* pqAnimationCue::getAnimatedProperty ( ) const

Returns the property that is animated by this cue, if any.

◆ getAnimatedPropertyName()

QString pqAnimationCue::getAnimatedPropertyName ( ) const

Returns the property name that is animated.

◆ getCameraModeName()

static QString pqAnimationCue::getCameraModeName ( int  mode)
static

Returns the string version of the camera mode.

◆ getAnimatedPropertyIndex()

int pqAnimationCue::getAnimatedPropertyIndex ( ) const

Returns the index of the property being animated.

◆ setKeyFrameType()

void pqAnimationCue::setKeyFrameType ( const QString &  type)
inline

Set the type of the keyframe created by default.

default is CompositeKeyFrame.

Definition at line 104 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 110 of file pqAnimationCue.h.

◆ setEnabled()

void pqAnimationCue::setEnabled ( bool  enable)

Get/Set the enabled state for the cue.

◆ isEnabled()

bool pqAnimationCue::isEnabled ( ) const

Get/Set the enabled state for the cue.

◆ getDisplayName()

QString pqAnimationCue::getDisplayName ( )

Return a string formatted from proxy registration name, property name and index.

◆ isCameraCue()

bool pqAnimationCue::isCameraCue ( )

Return true if underlying proxy is of type CameraAnimationCue.

◆ isPythonCue()

bool pqAnimationCue::isPythonCue ( )

Return true if underlying proxy is of type PythonAnimationCue.

◆ isTimekeeperCue()

bool pqAnimationCue::isTimekeeperCue ( )

Return true if underlying proxy is of type TimeAnimationCue.

◆ keyframesModified

void pqAnimationCue::keyframesModified ( )
signal

emitted when something about the keyframes changes.

◆ modified

void pqAnimationCue::modified ( )
signal

Fired when the animated proxy/property/index changes.

◆ 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: