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

#include <vtkPythonAnimationCue.h>

Inheritance diagram for vtkPythonAnimationCue:

Collaboration diagram for vtkPythonAnimationCue:

[legend]

Public Types
typedef vtkAnimationCue	Superclass

Public Types inherited from vtkAnimationCue
enum	TimeCodes

typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override


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


void	SetScript (const std::string &)
	Get/Set the python script to execute. More...

std::string	GetScript () const
	Get/Set the python script to execute. More...

Public Member Functions inherited from vtkAnimationCue
vtkAnimationCue *	NewInstance () const

virtual void	Tick (double currenttime, double deltatime, double clocktime)

virtual void	Initialize ()

virtual void	Finalize ()

virtual void	SetTimeMode (int mode)

virtual int	GetTimeMode ()

void	SetTimeModeToRelative ()

void	SetTimeModeToNormalized ()

virtual void	SetStartTime (double)

virtual double	GetStartTime ()

virtual void	SetEndTime (double)

virtual double	GetEndTime ()

virtual double	GetAnimationTime ()

virtual double	GetDeltaTime ()

virtual double	GetClockTime ()

virtual void	SetTimeMode (int mode)

virtual int	GetTimeMode ()

void	SetTimeModeToRelative ()

void	SetTimeModeToNormalized ()

virtual void	SetStartTime (double)

virtual double	GetStartTime ()

virtual void	SetEndTime (double)

virtual double	GetEndTime ()

virtual double	GetAnimationTime ()

virtual double	GetDeltaTime ()

virtual double	GetClockTime ()

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkPythonAnimationCue *	New ()

static int	IsTypeOf (const char *type)

static vtkPythonAnimationCue *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkAnimationCue
static int	IsTypeOf (const char *type)

static vtkAnimationCue *	SafeDownCast (vtkObjectBase *o)

static vtkAnimationCue *	New ()

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkPythonAnimationCue ()

	~vtkPythonAnimationCue () override

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 Member Functions inherited from vtkAnimationCue
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAnimationCue ()

	~vtkAnimationCue ()

virtual void	StartCueInternal ()

virtual void	TickInternal (double currenttime, double deltatime, double clocktime)

virtual void	EndCueInternal ()

virtual void	StartCueInternal ()

virtual void	TickInternal (double currenttime, double deltatime, double clocktime)

virtual void	EndCueInternal ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
bool	Enabled

std::string	Script

Protected Attributes inherited from vtkAnimationCue
	UNINITIALIZED

	INACTIVE

	ACTIVE

double	StartTime

double	EndTime

int	TimeMode

double	AnimationTime

double	DeltaTime

double	ClockTime

int	CueState

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAnimationCue
	TIMEMODE_NORMALIZED

	TIMEMODE_RELATIVE

Detailed Description

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

Definition at line 19 of file vtkPythonAnimationCue.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAnimationCue vtkPythonAnimationCue::Superclass

Definition at line 23 of file vtkPythonAnimationCue.h.

Constructor & Destructor Documentation

◆ vtkPythonAnimationCue()

vtkPythonAnimationCue::vtkPythonAnimationCue ( )

protected

◆ ~vtkPythonAnimationCue()

vtkPythonAnimationCue::~vtkPythonAnimationCue ( )

overrideprotected

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

Reimplemented from vtkAnimationCue.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkAnimationCue.

◆ 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()

void vtkPythonAnimationCue::SetScript ( const std::string & )

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()

std::string vtkPythonAnimationCue::GetScript ( ) const

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 65 of file vtkPythonAnimationCue.h.

◆ Script

std::string vtkPythonAnimationCue::Script

protected

Definition at line 66 of file vtkPythonAnimationCue.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Animation/vtkPythonAnimationCue.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPythonAnimationCue()

◆ ~vtkPythonAnimationCue()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetEnabled()

◆ GetEnabled()

◆ EnabledOn()

◆ EnabledOff()

◆ SetScript()

◆ GetScript()

◆ HandleStartCueEvent()

◆ HandleTickEvent()

◆ HandleEndCueEvent()

◆ DeleteInterpretor()

Member Data Documentation

◆ Enabled

◆ Script