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

composite keyframe. More...

#include <vtkPVCompositeKeyFrame.h>

Inheritance diagram for vtkPVCompositeKeyFrame:
Inheritance graph
[legend]
Collaboration diagram for vtkPVCompositeKeyFrame:
Collaboration graph
[legend]

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)
 
virtual void UpdateValue (double currenttime, vtkPVAnimationCue *cue, vtkPVKeyFrame *next)
 This method will do the actual interpolation. More...
 
virtual void RemoveAllKeyValues ()
 Overridden to pass on to the internal keyframe proxies. More...
 
virtual void SetKeyTime (double time)
 Overridden to pass on to the internal keyframe proxies. More...
 
virtual void SetKeyValue (double val)
 Overridden to pass on to the internal keyframe proxies. More...
 
virtual void SetKeyValue (unsigned int index, double val)
 Overridden to pass on to the internal keyframe proxies. More...
 
virtual void SetNumberOfKeyValues (unsigned int num)
 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)
 
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...
 

Static Public Member Functions

static vtkPVCompositeKeyFrameNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVCompositeKeyFrameSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVKeyFrame
static int IsTypeOf (const char *type)
 
static vtkPVKeyFrameSafeDownCast (vtkObject *o)
 
static vtkPVKeyFrameNew ()
 

Protected Member Functions

 vtkPVCompositeKeyFrame ()
 
 ~vtkPVCompositeKeyFrame ()
 
- Protected Member Functions inherited from vtkPVKeyFrame
 vtkPVKeyFrame ()
 
 ~vtkPVKeyFrame ()
 

Protected Attributes

int Type
 
vtkPVBooleanKeyFrameBooleanKeyFrame
 
vtkPVRampKeyFrameRampKeyFrame
 
vtkPVExponentialKeyFrameExponentialKeyFrame
 
vtkPVSinusoidKeyFrameSinusoidKeyFrame
 
- Protected Attributes inherited from vtkPVKeyFrame
double KeyTime
 
vtkPVKeyFrameInternals * Internals
 
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 37 of file vtkPVCompositeKeyFrame.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkPVCompositeKeyFrame.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
NONE 
BOOLEAN 
RAMP 
EXPONENTIAL 
SINUSOID 

Definition at line 44 of file vtkPVCompositeKeyFrame.h.

Constructor & Destructor Documentation

◆ vtkPVCompositeKeyFrame()

vtkPVCompositeKeyFrame::vtkPVCompositeKeyFrame ( )
protected

◆ ~vtkPVCompositeKeyFrame()

vtkPVCompositeKeyFrame::~vtkPVCompositeKeyFrame ( )
protected

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 
)

◆ RemoveAllKeyValues()

virtual void vtkPVCompositeKeyFrame::RemoveAllKeyValues ( )
virtual

Overridden to pass on to the internal keyframe proxies.

Reimplemented from vtkPVKeyFrame.

◆ SetKeyTime()

virtual void vtkPVCompositeKeyFrame::SetKeyTime ( double  time)
virtual

Overridden to pass on to the internal keyframe proxies.

Reimplemented from vtkPVKeyFrame.

◆ SetKeyValue() [1/2]

virtual void vtkPVCompositeKeyFrame::SetKeyValue ( double  val)
inlinevirtual

Overridden to pass on to the internal keyframe proxies.

Reimplemented from vtkPVKeyFrame.

Definition at line 59 of file vtkPVCompositeKeyFrame.h.

◆ SetKeyValue() [2/2]

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

Overridden to pass on to the internal keyframe proxies.

Reimplemented from vtkPVKeyFrame.

◆ SetNumberOfKeyValues()

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

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 89 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()

virtual void vtkPVCompositeKeyFrame::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 from vtkPVKeyFrame.

Member Data Documentation

◆ Type

int vtkPVCompositeKeyFrame::Type
protected

Definition at line 105 of file vtkPVCompositeKeyFrame.h.

◆ BooleanKeyFrame

vtkPVBooleanKeyFrame* vtkPVCompositeKeyFrame::BooleanKeyFrame
protected

Definition at line 107 of file vtkPVCompositeKeyFrame.h.

◆ RampKeyFrame

vtkPVRampKeyFrame* vtkPVCompositeKeyFrame::RampKeyFrame
protected

Definition at line 108 of file vtkPVCompositeKeyFrame.h.

◆ ExponentialKeyFrame

vtkPVExponentialKeyFrame* vtkPVCompositeKeyFrame::ExponentialKeyFrame
protected

Definition at line 109 of file vtkPVCompositeKeyFrame.h.

◆ SinusoidKeyFrame

vtkPVSinusoidKeyFrame* vtkPVCompositeKeyFrame::SinusoidKeyFrame
protected

Definition at line 110 of file vtkPVCompositeKeyFrame.h.


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