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

Interplates a sinusoid. More...

#include <vtkPVSinusoidKeyFrame.h>

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

Public Types

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 SetPhase (double)
 Get/Set the phase for the sine wave. More...
 
virtual double GetPhase ()
 Get/Set the phase for the sine wave. More...
 
virtual void SetFrequency (double)
 Get/Set the frequency for the sine wave in number of cycles for the entire length of this keyframe i.e. More...
 
virtual double GetFrequency ()
 Get/Set the frequency for the sine wave in number of cycles for the entire length of this keyframe i.e. More...
 
virtual void SetOffset (double)
 Get/Set the Wave offset. More...
 
virtual double GetOffset ()
 Get/Set the Wave offset. More...
 
- Public Member Functions inherited from vtkPVKeyFrame
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void RemoveAllKeyValues ()
 Removes all key values. 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 vtkPVSinusoidKeyFrameNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVSinusoidKeyFrameSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVKeyFrame
static int IsTypeOf (const char *type)
 
static vtkPVKeyFrameSafeDownCast (vtkObject *o)
 
static vtkPVKeyFrameNew ()
 

Protected Member Functions

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

Protected Attributes

double Phase
 
double Frequency
 
double Offset
 
- Protected Attributes inherited from vtkPVKeyFrame
double KeyTime
 
vtkPVKeyFrameInternals * Internals
 

Detailed Description

Interplates a sinusoid.

At any given time t, the resultant value obtained from this keyframe is given by : value = this->Offset + (Key Value) * Sin (2*pi*theta); where theta = this->Frequency*t + (this->Phase/360). As is clear from the equation, the amplitude of the wave is obtained from the value of the keyframe.

Definition at line 31 of file vtkPVSinusoidKeyFrame.h.

Member Typedef Documentation

◆ Superclass

Definition at line 35 of file vtkPVSinusoidKeyFrame.h.

Constructor & Destructor Documentation

◆ vtkPVSinusoidKeyFrame()

vtkPVSinusoidKeyFrame::vtkPVSinusoidKeyFrame ( )
protected

◆ ~vtkPVSinusoidKeyFrame()

vtkPVSinusoidKeyFrame::~vtkPVSinusoidKeyFrame ( )
protected

Member Function Documentation

◆ New()

static vtkPVSinusoidKeyFrame* vtkPVSinusoidKeyFrame::New ( )
static

◆ GetClassName()

virtual const char* vtkPVSinusoidKeyFrame::GetClassName ( )
virtual

Reimplemented from vtkPVKeyFrame.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkPVKeyFrame.

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ UpdateValue()

virtual void vtkPVSinusoidKeyFrame::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.

◆ SetPhase()

virtual void vtkPVSinusoidKeyFrame::SetPhase ( double  )
virtual

Get/Set the phase for the sine wave.

◆ GetPhase()

virtual double vtkPVSinusoidKeyFrame::GetPhase ( )
virtual

Get/Set the phase for the sine wave.

◆ SetFrequency()

virtual void vtkPVSinusoidKeyFrame::SetFrequency ( double  )
virtual

Get/Set the frequency for the sine wave in number of cycles for the entire length of this keyframe i.e.

until the next key frame.

◆ GetFrequency()

virtual double vtkPVSinusoidKeyFrame::GetFrequency ( )
virtual

Get/Set the frequency for the sine wave in number of cycles for the entire length of this keyframe i.e.

until the next key frame.

◆ SetOffset()

virtual void vtkPVSinusoidKeyFrame::SetOffset ( double  )
virtual

Get/Set the Wave offset.

◆ GetOffset()

virtual double vtkPVSinusoidKeyFrame::GetOffset ( )
virtual

Get/Set the Wave offset.

Member Data Documentation

◆ Phase

double vtkPVSinusoidKeyFrame::Phase
protected

Definition at line 74 of file vtkPVSinusoidKeyFrame.h.

◆ Frequency

double vtkPVSinusoidKeyFrame::Frequency
protected

Definition at line 75 of file vtkPVSinusoidKeyFrame.h.

◆ Offset

double vtkPVSinusoidKeyFrame::Offset
protected

Definition at line 76 of file vtkPVSinusoidKeyFrame.h.


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