File: vtkPythonAnimationCue.h

package info (click to toggle)
paraview 5.1.2%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 221,108 kB
  • ctags: 236,092
  • sloc: cpp: 2,416,026; ansic: 190,891; python: 99,856; xml: 81,001; tcl: 46,915; yacc: 5,039; java: 4,413; perl: 3,108; sh: 1,974; lex: 1,926; f90: 748; asm: 471; pascal: 228; makefile: 198; objc: 83; fortran: 31
file content (71 lines) | stat: -rw-r--r-- 2,123 bytes parent folder | download
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
/*=========================================================================

  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.

=========================================================================*/
// .NAME vtkPythonAnimationCue
// .SECTION Description
// vtkPythonAnimationCue is an animation cue that can execute arbitrary Python
// scripts.

#ifndef vtkPythonAnimationCue_h
#define vtkPythonAnimationCue_h

#include "vtkPVAnimationModule.h" //needed for exports
#include "vtkAnimationCue.h"

class VTKPVANIMATION_EXPORT vtkPythonAnimationCue : public vtkAnimationCue
{
public:
  static vtkPythonAnimationCue* New();
  vtkTypeMacro(vtkPythonAnimationCue, vtkAnimationCue);
  void PrintSelf(ostream& os, vtkIndent indent);

  // Description:
  // Enable/Disable this cue.
  vtkSetMacro(Enabled, bool);
  vtkGetMacro(Enabled, bool);
  vtkBooleanMacro(Enabled, bool);

  // Description:
  // 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();

  // Description:
  // Callbacks that forward the call to corresponding Python function.
  virtual void HandleStartCueEvent();
  virtual void HandleTickEvent();
  virtual void HandleEndCueEvent();

  // Description:
  // Cleans the interpretor.
  void DeleteInterpretor();

  bool Enabled;
  char* Script;

private:
  vtkPythonAnimationCue(const vtkPythonAnimationCue&); // Not implemented
  void operator=(const vtkPythonAnimationCue&); // Not implemented

};

#endif