Base class for key frames. More...

#include <vtkPVKeyFrame.h>

Inheritance diagram for vtkPVKeyFrame:

[legend]

Collaboration diagram for vtkPVKeyFrame:

[legend]

Public Types
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	RemoveAllKeyValues ()
	Removes all key values. More...

virtual void	UpdateValue (double currenttime, vtkPVAnimationCue cue, vtkPVKeyFrame next)
	This method will do the actual interpolation. More...


virtual void	SetKeyTime (double)
	Key time is the time at which this key frame is associated. More...

virtual double	GetKeyTime ()
	Key time is the time at which this key frame is associated. More...


virtual void	SetKeyValue (double val)
	Get/Set the animated value at this key frame. More...

virtual void	SetKeyValue (unsigned int index, double val)
	Get/Set the animated value at this key frame. More...

double	GetKeyValue ()
	Get/Set the animated value at this key frame. More...

double	GetKeyValue (unsigned int index)
	Get/Set the animated value at this key frame. More...


unsigned int	GetNumberOfKeyValues ()
	Set/Get the number of key values this key frame currently stores. More...

virtual void	SetNumberOfKeyValues (unsigned int num)
	Set/Get the number of key values this key frame currently stores. More...

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 vtkPVKeyFrame *	SafeDownCast (vtkObject *o)

static vtkPVKeyFrame *	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
	vtkPVKeyFrame ()

	~vtkPVKeyFrame () 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 &)

Protected Attributes
double	KeyTime

vtkPVKeyFrameInternals *	Internals

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Base class for key frames.

A key frame is responsible to interpolate the curve between it self and a consequent key frame. A new subclass is needed for each type of interpolation available between two key frames. This class can be instantiated to create a no-action key frame.

Definition at line 24 of file vtkPVKeyFrame.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPVKeyFrame::Superclass

Definition at line 27 of file vtkPVKeyFrame.h.

Constructor & Destructor Documentation

◆ vtkPVKeyFrame()

vtkPVKeyFrame::vtkPVKeyFrame ( )

protected

◆ ~vtkPVKeyFrame()

vtkPVKeyFrame::~vtkPVKeyFrame ( )

overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPVKeyFrame::GetClassName ( )

virtual

Reimplemented in vtkPVCompositeKeyFrame, vtkPVCameraKeyFrame, vtkPVSinusoidKeyFrame, vtkPVRampKeyFrame, vtkPVBooleanKeyFrame, and vtkPVExponentialKeyFrame.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

Reimplemented in vtkPVCompositeKeyFrame, vtkPVCameraKeyFrame, vtkPVSinusoidKeyFrame, vtkPVRampKeyFrame, vtkPVBooleanKeyFrame, and vtkPVExponentialKeyFrame.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

Reimplemented in vtkPVSinusoidKeyFrame, and vtkPVRampKeyFrame.

◆ New()

static vtkPVKeyFrame* vtkPVKeyFrame::New ( )

static

◆ SetKeyTime()

virtual void vtkPVKeyFrame::SetKeyTime ( double )

virtual

Key time is the time at which this key frame is associated.

KeyTime ranges from [0,1], where 0 is the start time of the cue for which this is a key frame and 1 is that cue's end time.

Reimplemented in vtkPVCompositeKeyFrame.

◆ GetKeyTime()

virtual double vtkPVKeyFrame::GetKeyTime ( )

virtual

Key time is the time at which this key frame is associated.

KeyTime ranges from [0,1], where 0 is the start time of the cue for which this is a key frame and 1 is that cue's end time.

◆ SetKeyValue() [1/2]

virtual void vtkPVKeyFrame::SetKeyValue ( double val )

inlinevirtual

Get/Set the animated value at this key frame.

Note that is the number of values is adjusted to fit the index specified in SetKeyValue.

Reimplemented in vtkPVCompositeKeyFrame, and vtkPVCameraKeyFrame.

Definition at line 48 of file vtkPVKeyFrame.h.

◆ SetKeyValue() [2/2]

virtual void vtkPVKeyFrame::SetKeyValue	(	unsigned int	index,
		double	val
	)

virtual

Get/Set the animated value at this key frame.

Note that is the number of values is adjusted to fit the index specified in SetKeyValue.

Reimplemented in vtkPVCompositeKeyFrame, and vtkPVCameraKeyFrame.

◆ GetKeyValue() [1/2]

double vtkPVKeyFrame::GetKeyValue ( )

inline

Get/Set the animated value at this key frame.

Note that is the number of values is adjusted to fit the index specified in SetKeyValue.

Definition at line 50 of file vtkPVKeyFrame.h.

◆ GetKeyValue() [2/2]

double vtkPVKeyFrame::GetKeyValue ( unsigned int index )

Get/Set the animated value at this key frame.

Note that is the number of values is adjusted to fit the index specified in SetKeyValue.

◆ RemoveAllKeyValues()

virtual void vtkPVKeyFrame::RemoveAllKeyValues ( )

virtual

Removes all key values.

Reimplemented in vtkPVCompositeKeyFrame.

◆ GetNumberOfKeyValues()

unsigned int vtkPVKeyFrame::GetNumberOfKeyValues ( )

Set/Get the number of key values this key frame currently stores.

◆ SetNumberOfKeyValues()

virtual void vtkPVKeyFrame::SetNumberOfKeyValues ( unsigned int num )

virtual

Set/Get the number of key values this key frame currently stores.

Reimplemented in vtkPVCompositeKeyFrame.

◆ UpdateValue()

virtual void vtkPVKeyFrame::UpdateValue	(	double	currenttime,
		vtkPVAnimationCue *	cue,
		vtkPVKeyFrame *	next
	)

virtual

This method will do the actual interpolation.

currenttime is normalized to the time range between this key frame and the next key frame.

Reimplemented in vtkPVCompositeKeyFrame, vtkPVCameraKeyFrame, vtkPVSinusoidKeyFrame, vtkPVBooleanKeyFrame, vtkPVExponentialKeyFrame, and vtkPVRampKeyFrame.

Member Data Documentation

◆ KeyTime

double vtkPVKeyFrame::KeyTime

protected

Definition at line 78 of file vtkPVKeyFrame.h.

◆ Internals

vtkPVKeyFrameInternals* vtkPVKeyFrame::Internals

protected

Definition at line 79 of file vtkPVKeyFrame.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPVKeyFrame()

◆ ~vtkPVKeyFrame()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ New()

◆ SetKeyTime()

◆ GetKeyTime()

◆ SetKeyValue() [1/2]

◆ SetKeyValue() [2/2]

◆ GetKeyValue() [1/2]

◆ GetKeyValue() [2/2]

◆ RemoveAllKeyValues()

◆ GetNumberOfKeyValues()

◆ SetNumberOfKeyValues()

◆ UpdateValue()

Member Data Documentation

◆ KeyTime

◆ Internals