composite keyframe. More...

#include <vtkPVCompositeKeyFrame.h>

Inheritance diagram for vtkPVCompositeKeyFrame:

Collaboration diagram for vtkPVCompositeKeyFrame:

Public Types
enum	{ NONE = 0, BOOLEAN = 1, RAMP = 2, EXPONENTIAL = 3, SINUSOID = 4 }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	RemoveAllKeyValues ()
virtual void	SetKeyTime (double time)
virtual void	SetKeyValue (double val)
virtual void	SetKeyValue (unsigned int index, double val)
virtual void	SetNumberOfKeyValues (unsigned int num)

void	SetBase (double val)
void	SetStartPower (double val)
void	SetEndPower (double val)

void	SetPhase (double val)
void	SetFrequency (double val)
void	SetOffset (double val)

virtual void	UpdateValue (double currenttime, vtkPVAnimationCue cue, vtkPVKeyFrame next)
Static Public Member Functions
static vtkPVCompositeKeyFrame *	New ()
static int	IsTypeOf (const char *type)
static vtkPVCompositeKeyFrame *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkPVCompositeKeyFrame ()
	~vtkPVCompositeKeyFrame ()
Protected Attributes
int	Type
vtkPVBooleanKeyFrame *	BooleanKeyFrame
vtkPVRampKeyFrame *	RampKeyFrame
vtkPVExponentialKeyFrame *	ExponentialKeyFrame
vtkPVSinusoidKeyFrame *	SinusoidKeyFrame
static const char *	GetTypeAsString (int)
static int	GetTypeFromString (const char *string)
virtual void	SetType (int)
virtual int	GetType ()
const char *	GetTypeAsString ()

Detailed Description

composite keyframe.

There are many different types of keyframes such as vtkPVSinusoidKeyFrame, vtkPVRampKeyFrame etc. This is keyframe that has all different types of keyframes as internal objects and provides API to choose one of them as the active type. This is helpful in GUIs that allow for switching the type of keyframe on the fly without much effort from the GUI.

Definition at line 36 of file vtkPVCompositeKeyFrame.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

NONE
BOOLEAN
RAMP
EXPONENTIAL
SINUSOID

Definition at line 43 of file vtkPVCompositeKeyFrame.h.

Constructor & Destructor Documentation

vtkPVCompositeKeyFrame::vtkPVCompositeKeyFrame ( ) [protected]

vtkPVCompositeKeyFrame::~vtkPVCompositeKeyFrame ( ) [protected]

Member Function Documentation

static vtkPVCompositeKeyFrame* vtkPVCompositeKeyFrame::New ( ) [static]

Reimplemented from vtkPVKeyFrame.

virtual const char* vtkPVCompositeKeyFrame::GetClassName ( ) [virtual]

Reimplemented from vtkPVKeyFrame.

static int vtkPVCompositeKeyFrame::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkPVKeyFrame.

virtual int vtkPVCompositeKeyFrame::IsA ( const char * type ) [virtual]

Reimplemented from vtkPVKeyFrame.

static vtkPVCompositeKeyFrame* vtkPVCompositeKeyFrame::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkPVKeyFrame.

void vtkPVCompositeKeyFrame::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Reimplemented from vtkPVKeyFrame.

virtual void vtkPVCompositeKeyFrame::RemoveAllKeyValues ( ) [virtual]

Overridden to pass on to the internal keyframe proxies.

Reimplemented from vtkPVKeyFrame.

virtual void vtkPVCompositeKeyFrame::SetKeyTime ( double time ) [virtual]

Overridden to pass on to the internal keyframe proxies.

Reimplemented from vtkPVKeyFrame.

virtual void vtkPVCompositeKeyFrame::SetKeyValue ( double val ) [inline, virtual]

Overridden to pass on to the internal keyframe proxies.

Reimplemented from vtkPVKeyFrame.

Definition at line 57 of file vtkPVCompositeKeyFrame.h.

virtual void vtkPVCompositeKeyFrame::SetKeyValue	(	unsigned int	index,
		double	val
	)		`[virtual]`

Overridden to pass on to the internal keyframe proxies.

Reimplemented from vtkPVKeyFrame.

virtual void vtkPVCompositeKeyFrame::SetNumberOfKeyValues ( unsigned int num ) [virtual]

Overridden to pass on to the internal keyframe proxies.

Reimplemented from vtkPVKeyFrame.

void vtkPVCompositeKeyFrame::SetBase ( double val )

Passed on to the ExponentialKeyFrame.

void vtkPVCompositeKeyFrame::SetStartPower ( double val )

Passed on to the ExponentialKeyFrame.

void vtkPVCompositeKeyFrame::SetEndPower ( double val )

Passed on to the ExponentialKeyFrame.

void vtkPVCompositeKeyFrame::SetPhase ( double val )

Passed on to the SinusoidKeyFrame.

void vtkPVCompositeKeyFrame::SetFrequency ( double val )

Passed on to the SinusoidKeyFrame.

void vtkPVCompositeKeyFrame::SetOffset ( double val )

Passed on to the SinusoidKeyFrame.

virtual void vtkPVCompositeKeyFrame::SetType ( int ) [virtual]