ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPVKeyFrame Class Reference

Base class for key frames. More...

#include <vtkPVKeyFrame.h>

Inheritance diagram for vtkPVKeyFrame:
Inheritance graph
[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)
 
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...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPVKeyFrameSafeDownCast (vtkObject *o)
 
static vtkPVKeyFrameNew ()
 

Protected Member Functions

 vtkPVKeyFrame ()
 
 ~vtkPVKeyFrame ()
 

Protected Attributes

double KeyTime
 
vtkPVKeyFrameInternals * Internals
 

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 36 of file vtkPVKeyFrame.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPVKeyFrame::Superclass

Definition at line 39 of file vtkPVKeyFrame.h.

Constructor & Destructor Documentation

◆ vtkPVKeyFrame()

vtkPVKeyFrame::vtkPVKeyFrame ( )
protected

◆ ~vtkPVKeyFrame()

vtkPVKeyFrame::~vtkPVKeyFrame ( )
protected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPVKeyFrame::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ 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 60 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 62 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 90 of file vtkPVKeyFrame.h.

◆ Internals

vtkPVKeyFrameInternals* vtkPVKeyFrame::Internals
protected

Definition at line 91 of file vtkPVKeyFrame.h.


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