ParaView
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkPVSinusoidKeyFrame Class Reference

#include <vtkPVSinusoidKeyFrame.h>

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

List of all members.

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)
virtual void SetPhase (double)
virtual double GetPhase ()
virtual void SetFrequency (double)
virtual double GetFrequency ()
virtual void SetOffset (double)
virtual double GetOffset ()

Static Public Member Functions

static vtkPVSinusoidKeyFrameNew ()
static int IsTypeOf (const char *type)
static vtkPVSinusoidKeyFrameSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkPVSinusoidKeyFrame ()
 ~vtkPVSinusoidKeyFrame ()

Protected Attributes

double Phase
double Frequency
double Offset

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 30 of file vtkPVSinusoidKeyFrame.h.


Constructor & Destructor Documentation

vtkPVSinusoidKeyFrame::vtkPVSinusoidKeyFrame ( ) [protected]
vtkPVSinusoidKeyFrame::~vtkPVSinusoidKeyFrame ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkPVKeyFrame.

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

Reimplemented from vtkPVKeyFrame.

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

Reimplemented from vtkPVKeyFrame.

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

Reimplemented from vtkPVKeyFrame.

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

Reimplemented from vtkPVKeyFrame.

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

Reimplemented from vtkPVKeyFrame.

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.

virtual void vtkPVSinusoidKeyFrame::SetPhase ( double  ) [virtual]

Get/Set the phase for the sine wave.

virtual double vtkPVSinusoidKeyFrame::GetPhase ( ) [virtual]

Get/Set the phase for the sine wave.

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.

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.

virtual void vtkPVSinusoidKeyFrame::SetOffset ( double  ) [virtual]

Get/Set the Wave offset.

virtual double vtkPVSinusoidKeyFrame::GetOffset ( ) [virtual]

Get/Set the Wave offset.


Member Data Documentation

Definition at line 68 of file vtkPVSinusoidKeyFrame.h.

Definition at line 69 of file vtkPVSinusoidKeyFrame.h.

Definition at line 70 of file vtkPVSinusoidKeyFrame.h.


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