ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPythonAnimationCue Class Reference

vtkPythonAnimationCue is an animation cue that can execute arbitrary Python scripts. More...

#include <vtkPythonAnimationCue.h>

Inherits vtkAnimationCue.

Public Types

typedef vtkAnimationCue Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetEnabled (bool)
 Enable/Disable this cue. More...
 
virtual bool GetEnabled ()
 Enable/Disable this cue. More...
 
virtual void EnabledOn ()
 Enable/Disable this cue. More...
 
virtual void EnabledOff ()
 Enable/Disable this cue. More...
 
virtual void SetScript (const char *)
 Get/Set the python script to execute. More...
 
virtual char * GetScript ()
 Get/Set the python script to execute. More...
 

Static Public Member Functions

static vtkPythonAnimationCueNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPythonAnimationCueSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPythonAnimationCue ()
 
 ~vtkPythonAnimationCue ()
 
void DeleteInterpretor ()
 Cleans the interpretor. More...
 
virtual void HandleStartCueEvent ()
 Callbacks that forward the call to corresponding Python function. More...
 
virtual void HandleTickEvent ()
 Callbacks that forward the call to corresponding Python function. More...
 
virtual void HandleEndCueEvent ()
 Callbacks that forward the call to corresponding Python function. More...
 

Protected Attributes

bool Enabled
 
char * Script
 

Detailed Description

vtkPythonAnimationCue is an animation cue that can execute arbitrary Python scripts.

Definition at line 28 of file vtkPythonAnimationCue.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAnimationCue vtkPythonAnimationCue::Superclass

Definition at line 32 of file vtkPythonAnimationCue.h.

Constructor & Destructor Documentation

◆ vtkPythonAnimationCue()

vtkPythonAnimationCue::vtkPythonAnimationCue ( )
protected

◆ ~vtkPythonAnimationCue()

vtkPythonAnimationCue::~vtkPythonAnimationCue ( )
protected

Member Function Documentation

◆ New()

static vtkPythonAnimationCue* vtkPythonAnimationCue::New ( )
static

◆ GetClassName()

virtual const char* vtkPythonAnimationCue::GetClassName ( )
virtual

◆ IsTypeOf()

static int vtkPythonAnimationCue::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkPythonAnimationCue::IsA ( const char *  type)
virtual

◆ SafeDownCast()

static vtkPythonAnimationCue* vtkPythonAnimationCue::SafeDownCast ( vtkObject *  o)
static

◆ PrintSelf()

void vtkPythonAnimationCue::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

◆ SetEnabled()

virtual void vtkPythonAnimationCue::SetEnabled ( bool  )
virtual

Enable/Disable this cue.

◆ GetEnabled()

virtual bool vtkPythonAnimationCue::GetEnabled ( )
virtual

Enable/Disable this cue.

◆ EnabledOn()

virtual void vtkPythonAnimationCue::EnabledOn ( )
virtual

Enable/Disable this cue.

◆ EnabledOff()

virtual void vtkPythonAnimationCue::EnabledOff ( )
virtual

Enable/Disable this cue.

◆ SetScript()

virtual void vtkPythonAnimationCue::SetScript ( const char *  )
virtual

Get/Set the python script to execute.

The script must have the following functions:

  • start_cue(cue): (optional) if present, called when the cue starts.
  • tick(cue) : (required) called on every tick.
  • end_cue(cue): (optional) if present, called when the cue ends.

◆ GetScript()

virtual char* vtkPythonAnimationCue::GetScript ( )
virtual

Get/Set the python script to execute.

The script must have the following functions:

  • start_cue(cue): (optional) if present, called when the cue starts.
  • tick(cue) : (required) called on every tick.
  • end_cue(cue): (optional) if present, called when the cue ends.

◆ HandleStartCueEvent()

virtual void vtkPythonAnimationCue::HandleStartCueEvent ( )
protectedvirtual

Callbacks that forward the call to corresponding Python function.

◆ HandleTickEvent()

virtual void vtkPythonAnimationCue::HandleTickEvent ( )
protectedvirtual

Callbacks that forward the call to corresponding Python function.

◆ HandleEndCueEvent()

virtual void vtkPythonAnimationCue::HandleEndCueEvent ( )
protectedvirtual

Callbacks that forward the call to corresponding Python function.

◆ DeleteInterpretor()

void vtkPythonAnimationCue::DeleteInterpretor ( )
protected

Cleans the interpretor.

Member Data Documentation

◆ Enabled

bool vtkPythonAnimationCue::Enabled
protected

Definition at line 74 of file vtkPythonAnimationCue.h.

◆ Script

char* vtkPythonAnimationCue::Script
protected

Definition at line 75 of file vtkPythonAnimationCue.h.


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