vtkPVCompositeKeyFrame Class Reference

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 }
typedef vtkPVKeyFrame	Superclass
Public Types inherited from vtkPVKeyFrame
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
void	UpdateValue (double currenttime, vtkPVAnimationCue *cue, vtkPVKeyFrame *next) override
	This method will do the actual interpolation. More...
void	RemoveAllKeyValues () override
	Overridden to pass on to the internal keyframe proxies. More...
void	SetKeyTime (double time) override
	Overridden to pass on to the internal keyframe proxies. More...
void	SetKeyValue (double val) override
	Overridden to pass on to the internal keyframe proxies. More...
void	SetKeyValue (unsigned int index, double val) override
	Overridden to pass on to the internal keyframe proxies. More...
void	SetNumberOfKeyValues (unsigned int num) override
	Overridden to pass on to the internal keyframe proxies. More...
void	SetBase (double val)
	Passed on to the ExponentialKeyFrame. More...
void	SetStartPower (double val)
	Passed on to the ExponentialKeyFrame. More...
void	SetEndPower (double val)
	Passed on to the ExponentialKeyFrame. More...
void	SetPhase (double val)
	Passed on to the SinusoidKeyFrame. More...
void	SetFrequency (double val)
	Passed on to the SinusoidKeyFrame. More...
void	SetOffset (double val)
	Passed on to the SinusoidKeyFrame. More...
Public Member Functions inherited from vtkPVKeyFrame
void	PrintSelf (ostream &os, vtkIndent indent) override
virtual double	GetKeyTime ()
	Key time is the time at which this key frame is associated. 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...
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 vtkPVCompositeKeyFrame *	New ()
static int	IsTypeOf (const char *type)
static vtkPVCompositeKeyFrame *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkPVKeyFrame
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
	vtkPVCompositeKeyFrame ()
	~vtkPVCompositeKeyFrame () override
Protected Member Functions inherited from vtkPVKeyFrame
	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
int	Type
vtkPVBooleanKeyFrame *	BooleanKeyFrame
vtkPVRampKeyFrame *	RampKeyFrame
vtkPVExponentialKeyFrame *	ExponentialKeyFrame
vtkPVSinusoidKeyFrame *	SinusoidKeyFrame
Protected Attributes inherited from vtkPVKeyFrame
double	KeyTime
vtkPVKeyFrameInternals *	Internals
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers
static const char *	GetTypeAsString (int)
	Get/Set the type of keyframe to be used as the active type. More...
static int	GetTypeFromString (const char *string)
	Get/Set the type of keyframe to be used as the active type. More...
virtual void	SetType (int)
	Get/Set the type of keyframe to be used as the active type. More...
virtual int	GetType ()
	Get/Set the type of keyframe to be used as the active type. More...
const char *	GetTypeAsString ()
	Get/Set the type of keyframe to be used as the active type. More...

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 25 of file vtkPVCompositeKeyFrame.h.

Member Typedef Documentation

Superclass

typedef vtkPVKeyFrame vtkPVCompositeKeyFrame::Superclass

Definition at line 29 of file vtkPVCompositeKeyFrame.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
NONE
BOOLEAN
RAMP
EXPONENTIAL
SINUSOID

Definition at line 32 of file vtkPVCompositeKeyFrame.h.

Constructor & Destructor Documentation

vtkPVCompositeKeyFrame()

vtkPVCompositeKeyFrame::vtkPVCompositeKeyFrame ( )

protected

~vtkPVCompositeKeyFrame()

vtkPVCompositeKeyFrame::~vtkPVCompositeKeyFrame ( )

overrideprotected

Member Function Documentation

New()

static vtkPVCompositeKeyFrame* vtkPVCompositeKeyFrame::New ( )

static

GetClassName()

virtual const char* vtkPVCompositeKeyFrame::GetClassName ( )

virtual

Reimplemented from vtkPVKeyFrame.

IsTypeOf()

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

static

IsA()

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

virtual

Reimplemented from vtkPVKeyFrame.

SafeDownCast()

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

static

PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

RemoveAllKeyValues()

void vtkPVCompositeKeyFrame::RemoveAllKeyValues ( )

overridevirtual

Overridden to pass on to the internal keyframe proxies.

Reimplemented from vtkPVKeyFrame.

SetKeyTime()

void vtkPVCompositeKeyFrame::SetKeyTime ( double  time )

overridevirtual

Overridden to pass on to the internal keyframe proxies.

Reimplemented from vtkPVKeyFrame.

SetKeyValue() [1/2]

void vtkPVCompositeKeyFrame::SetKeyValue ( double  val )

inlineoverridevirtual

Overridden to pass on to the internal keyframe proxies.

Reimplemented from vtkPVKeyFrame.

Definition at line 47 of file vtkPVCompositeKeyFrame.h.

SetKeyValue() [2/2]

void vtkPVCompositeKeyFrame::SetKeyValue ( unsigned int  index, double  val  )

overridevirtual

Overridden to pass on to the internal keyframe proxies.

Reimplemented from vtkPVKeyFrame.

SetNumberOfKeyValues()

void vtkPVCompositeKeyFrame::SetNumberOfKeyValues ( unsigned int  num )

overridevirtual

Overridden to pass on to the internal keyframe proxies.

Reimplemented from vtkPVKeyFrame.

SetBase()

void vtkPVCompositeKeyFrame::SetBase

(

double

val

)

Passed on to the ExponentialKeyFrame.

SetStartPower()

void vtkPVCompositeKeyFrame::SetStartPower

(

double

val

)

Passed on to the ExponentialKeyFrame.

SetEndPower()

void vtkPVCompositeKeyFrame::SetEndPower

(

double

val

)

Passed on to the ExponentialKeyFrame.

SetPhase()

void vtkPVCompositeKeyFrame::SetPhase

(

double

val

)

Passed on to the SinusoidKeyFrame.

SetFrequency()

void vtkPVCompositeKeyFrame::SetFrequency

(

double

val

)

Passed on to the SinusoidKeyFrame.

SetOffset()

void vtkPVCompositeKeyFrame::SetOffset

(

double

val

)

Passed on to the SinusoidKeyFrame.

SetType()

virtual void vtkPVCompositeKeyFrame::SetType ( int  )

virtual

Get/Set the type of keyframe to be used as the active type.

Default is RAMP.

GetType()

virtual int vtkPVCompositeKeyFrame::GetType ( )

virtual

Get/Set the type of keyframe to be used as the active type.

Default is RAMP.

GetTypeAsString() [1/2]

const char* vtkPVCompositeKeyFrame::GetTypeAsString ( )

inline

Get/Set the type of keyframe to be used as the active type.

Default is RAMP.

Definition at line 77 of file vtkPVCompositeKeyFrame.h.

GetTypeAsString() [2/2]

static const char* vtkPVCompositeKeyFrame::GetTypeAsString ( int  )

static

Get/Set the type of keyframe to be used as the active type.

Default is RAMP.

GetTypeFromString()

static int vtkPVCompositeKeyFrame::GetTypeFromString ( const char *  string )

static

Get/Set the type of keyframe to be used as the active type.

Default is RAMP.

UpdateValue()

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

overridevirtual

This method will do the actual interpolation.

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

Reimplemented from vtkPVKeyFrame.

Member Data Documentation

Type

int vtkPVCompositeKeyFrame::Type

protected

Definition at line 93 of file vtkPVCompositeKeyFrame.h.

BooleanKeyFrame

vtkPVBooleanKeyFrame* vtkPVCompositeKeyFrame::BooleanKeyFrame

protected

Definition at line 95 of file vtkPVCompositeKeyFrame.h.

RampKeyFrame

vtkPVRampKeyFrame* vtkPVCompositeKeyFrame::RampKeyFrame

protected

Definition at line 96 of file vtkPVCompositeKeyFrame.h.

ExponentialKeyFrame

vtkPVExponentialKeyFrame* vtkPVCompositeKeyFrame::ExponentialKeyFrame

protected

Definition at line 97 of file vtkPVCompositeKeyFrame.h.

SinusoidKeyFrame

vtkPVSinusoidKeyFrame* vtkPVCompositeKeyFrame::SinusoidKeyFrame

protected

Definition at line 98 of file vtkPVCompositeKeyFrame.h.

---

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

• /builds/gitlab-kitware-sciviz-ci/Remoting/Animation/vtkPVCompositeKeyFrame.h