1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
|
/*=========================================================================
Program: ParaView
Module: $RCSfile$
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkPythonAnimationCue
*
* vtkPythonAnimationCue is an animation cue that can execute arbitrary Python
* scripts.
*/
#ifndef vtkPythonAnimationCue_h
#define vtkPythonAnimationCue_h
#include "vtkAnimationCue.h"
#include "vtkPVAnimationModule.h" //needed for exports
class VTKPVANIMATION_EXPORT vtkPythonAnimationCue : public vtkAnimationCue
{
public:
static vtkPythonAnimationCue* New();
vtkTypeMacro(vtkPythonAnimationCue, vtkAnimationCue);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
//@{
/**
* Enable/Disable this cue.
*/
vtkSetMacro(Enabled, bool);
vtkGetMacro(Enabled, bool);
vtkBooleanMacro(Enabled, bool);
//@}
//@{
/**
* Get/Set the python script to execute. The script must have the following
* functions:
* \li start_cue(cue): (optional) if present, called when the cue starts.
* \li tick(cue) : (required) called on every tick.
* \li end_cue(cue): (optional) if present, called when the cue ends.
*/
vtkSetStringMacro(Script);
vtkGetStringMacro(Script);
//@}
protected:
vtkPythonAnimationCue();
~vtkPythonAnimationCue();
//@{
/**
* Callbacks that forward the call to corresponding Python function.
*/
virtual void HandleStartCueEvent();
virtual void HandleTickEvent();
virtual void HandleEndCueEvent();
//@}
/**
* Cleans the interpretor.
*/
void DeleteInterpretor();
bool Enabled;
char* Script;
private:
vtkPythonAnimationCue(const vtkPythonAnimationCue&) VTK_DELETE_FUNCTION;
void operator=(const vtkPythonAnimationCue&) VTK_DELETE_FUNCTION;
};
#endif
|