Interplates a sinusoid. More...

#include <vtkPVSinusoidKeyFrame.h>

Inheritance diagram for vtkPVSinusoidKeyFrame:

Collaboration diagram for vtkPVSinusoidKeyFrame:

[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) override

void	UpdateValue (double currenttime, vtkPVAnimationCue cue, vtkPVKeyFrame next) override
	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
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...

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 vtkPVSinusoidKeyFrame *	New ()

static int	IsTypeOf (const char *type)

static vtkPVSinusoidKeyFrame *	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
	vtkPVSinusoidKeyFrame ()

	~vtkPVSinusoidKeyFrame () 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
double	Phase

double	Frequency

double	Offset

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

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

Member Typedef Documentation

◆ Superclass

typedef vtkPVKeyFrame vtkPVSinusoidKeyFrame::Superclass

Definition at line 23 of file vtkPVSinusoidKeyFrame.h.

Constructor & Destructor Documentation

◆ vtkPVSinusoidKeyFrame()

vtkPVSinusoidKeyFrame::vtkPVSinusoidKeyFrame ( )

protected

◆ ~vtkPVSinusoidKeyFrame()

vtkPVSinusoidKeyFrame::~vtkPVSinusoidKeyFrame ( )

overrideprotected

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
	)

overridevirtual

Reimplemented from vtkPVKeyFrame.

◆ UpdateValue()

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

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

◆ Frequency

double vtkPVSinusoidKeyFrame::Frequency

protected

Definition at line 63 of file vtkPVSinusoidKeyFrame.h.

◆ Offset

double vtkPVSinusoidKeyFrame::Offset

protected

Definition at line 64 of file vtkPVSinusoidKeyFrame.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Animation/vtkPVSinusoidKeyFrame.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPVSinusoidKeyFrame()

◆ ~vtkPVSinusoidKeyFrame()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ UpdateValue()

◆ SetPhase()

◆ GetPhase()

◆ SetFrequency()

◆ GetFrequency()

◆ SetOffset()

◆ GetOffset()

Member Data Documentation

◆ Phase

◆ Frequency

◆ Offset