abstract proxy for manipulators used in animation. More...

#include <vtkPVCueManipulator.h>

Inheritance diagram for vtkPVCueManipulator:

[legend]

Collaboration diagram for vtkPVCueManipulator:

[legend]

Public Types
enum	{ StateModifiedEvent = 2000 }
	StateModifiedEvent - This event is fired when the manipulator modifies the animated proxy. More...

typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

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 int	IsTypeOf (const char *type)

static vtkPVCueManipulator *	SafeDownCast (vtkObject *o)

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
virtual void	Initialize (vtkPVAnimationCue *)
	This method is called when the AnimationCue's StartAnimationCueEvent is triggered, to let the animation manipulator know that the cue has been restarted. More...

virtual void	Finalize (vtkPVAnimationCue *)
	This method is called when the AnimationCue's EndAnimationCueEvent is triggered. More...

virtual void	UpdateValue (double currenttime, vtkPVAnimationCue *cueproxy)=0
	This updates the values based on currenttime. More...

	vtkPVCueManipulator ()

	~vtkPVCueManipulator () override

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

Friends
class	vtkPVAnimationCue

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

abstract proxy for manipulators used in animation.

An animation cue proxy delegates the operation of modifying the property on the proxy being animated to a Manipulator. An example of a manipulator is a vtkPVKeyFrameCueManipulator. Subclasses must override UpdateValue to perform the actual property manipulation. Just like all proxies involved in Animation, this is a client side proxy, with no VTK objects created on the server. A manipulator fires two kinds of events:

vtkPVCueManipulator::StateModifiedEvent is fired when the manipulator modifies the animated proxy.
vtkCommand::Modified is fired when properties of the manipulator are changed which affects the way the animation is generated e.g in case of vtkPVKeyFrameCueManipulator, this event is fired when the key frames are changed i.e. added/removed/modified.
See also
vtkPVAnimationCue vtkAnimationCue

Definition at line 33 of file vtkPVCueManipulator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPVCueManipulator::Superclass

Definition at line 36 of file vtkPVCueManipulator.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

StateModifiedEvent - This event is fired when the manipulator modifies the animated proxy.

vtkCommand::Modified - is fired when the keyframes are changed i.e. added/removed/modified.

Enumerator
StateModifiedEvent

Definition at line 43 of file vtkPVCueManipulator.h.

Constructor & Destructor Documentation

◆ vtkPVCueManipulator()

vtkPVCueManipulator::vtkPVCueManipulator ( )

protected

◆ ~vtkPVCueManipulator()

vtkPVCueManipulator::~vtkPVCueManipulator ( )

overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPVCueManipulator::GetClassName ( )

virtual

Reimplemented in vtkPVKeyFrameCueManipulator, and vtkPVCameraCueManipulator.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

Reimplemented in vtkPVKeyFrameCueManipulator, and vtkPVCameraCueManipulator.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

Reimplemented in vtkPVKeyFrameCueManipulator.

◆ Initialize()

virtual void vtkPVCueManipulator::Initialize ( vtkPVAnimationCue * )

inlineprotectedvirtual

This method is called when the AnimationCue's StartAnimationCueEvent is triggered, to let the animation manipulator know that the cue has been restarted.

This is here for one major reason: after the last key frame, the state of the scene must be as it was left a the the last key frame. This does not happened automatically, since if while animating the currentime never coincides with the last key frame's key time, then it never gets a chance to update the properties value. Hence, we note when the cue begins. Then, if the currentime is beyond that of the last key frame we pretend that the current time coincides with that of the last key frame and let it update the properties. This is done only once per Animation cycle. The Initialize method is used to indicate that a new animation cycle has begun.

Reimplemented in vtkPVKeyFrameCueManipulator, and vtkPVCameraCueManipulator.

Definition at line 61 of file vtkPVCueManipulator.h.

◆ Finalize()

virtual void vtkPVCueManipulator::Finalize ( vtkPVAnimationCue * )

inlineprotectedvirtual

This method is called when the AnimationCue's EndAnimationCueEvent is triggered.

Typically, the Manipulator will set the state of the Cue to that at the end of the cue.

Reimplemented in vtkPVKeyFrameCueManipulator, and vtkPVCameraCueManipulator.

Definition at line 68 of file vtkPVCueManipulator.h.

◆ UpdateValue()

virtual void vtkPVCueManipulator::UpdateValue	(	double	currenttime,
		vtkPVAnimationCue *	cueproxy
	)

protectedpure virtual

This updates the values based on currenttime.

currenttime is normalized to the time range of the Cue.

Implemented in vtkPVKeyFrameCueManipulator, and vtkPVCameraCueManipulator.

Friends And Related Function Documentation

◆ vtkPVAnimationCue

friend class vtkPVAnimationCue

friend

Definition at line 78 of file vtkPVCueManipulator.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkPVCueManipulator()

◆ ~vtkPVCueManipulator()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ Initialize()

◆ Finalize()

◆ UpdateValue()

Friends And Related Function Documentation

◆ vtkPVAnimationCue