vtkSMKeyFrameProxy Class Reference

#include <vtkSMKeyFrameProxy.h>

Inheritance diagram for vtkSMKeyFrameProxy:

[legend]Collaboration diagram for vtkSMKeyFrameProxy:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkSMKeyFrameProxy, vtkSMProxy)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SaveInBatchScript (ofstream *file)
vtkClientServerID	GetID ()
virtual void	SetKeyTime (double)
virtual double	GetKeyTime ()
void	SetKeyValue (double val)
void	SetKeyValue (unsigned int index, double val)
double	GetKeyValue ()
double	GetKeyValue (unsigned int index)
unsigned int	GetNumberOfKeyValues ()
void	SetNumberOfKeyValues (unsigned int num)
virtual void	UpdateValue (double currenttime, vtkSMAnimationCueProxy *cueProxy, vtkSMKeyFrameProxy *next)
virtual void	Copy (vtkSMProxy *src, const char *exceptionClass, int proxyPropertyCopyFlag)
Static Public Member Functions
vtkSMKeyFrameProxy *	New ()
Protected Member Functions
	vtkSMKeyFrameProxy ()
	~vtkSMKeyFrameProxy ()
Protected Attributes
double	KeyTime
vtkSMKeyFrameProxyInternals *	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 34 of file vtkSMKeyFrameProxy.h.

---

Constructor & Destructor Documentation

vtkSMKeyFrameProxy::vtkSMKeyFrameProxy (   )  [protected]

vtkSMKeyFrameProxy::~vtkSMKeyFrameProxy (   )  [protected]

---

Member Function Documentation

vtkSMKeyFrameProxy::vtkTypeRevisionMacro (  vtkSMKeyFrameProxy  , vtkSMProxy  )

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

Reimplemented from vtkSMProxy. Reimplemented in vtkSMBooleanKeyFrameProxy, vtkSMCameraKeyFrameProxy, vtkSMExponentialKeyFrameProxy, vtkSMRampKeyFrameProxy, and vtkSMSinusoidKeyFrameProxy.

vtkSMKeyFrameProxy* vtkSMKeyFrameProxy::New (   )  [static]

Reimplemented from vtkSMProxy. Reimplemented in vtkSMBooleanKeyFrameProxy, vtkSMCameraKeyFrameProxy, vtkSMExponentialKeyFrameProxy, vtkSMRampKeyFrameProxy, and vtkSMSinusoidKeyFrameProxy.

virtual void vtkSMKeyFrameProxy::SaveInBatchScript (  ofstream *  file  )  [virtual]

Reimplemented in vtkSMCameraKeyFrameProxy, vtkSMExponentialKeyFrameProxy, and vtkSMSinusoidKeyFrameProxy.

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

virtual double vtkSMKeyFrameProxy::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.

void vtkSMKeyFrameProxy::SetKeyValue (  double  val  )  [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 54 of file vtkSMKeyFrameProxy.h.

void vtkSMKeyFrameProxy::SetKeyValue (  unsigned int  index, double  val )

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 vtkSMCameraKeyFrameProxy.

double vtkSMKeyFrameProxy::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 56 of file vtkSMKeyFrameProxy.h.

double vtkSMKeyFrameProxy::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. Reimplemented in vtkSMCameraKeyFrameProxy.

unsigned int vtkSMKeyFrameProxy::GetNumberOfKeyValues (   )

Set/Get the number of key values this key frame currently stores.

void vtkSMKeyFrameProxy::SetNumberOfKeyValues (  unsigned int  num  )

Set/Get the number of key values this key frame currently stores.

virtual void vtkSMKeyFrameProxy::UpdateValue (  double  currenttime, vtkSMAnimationCueProxy *  cueProxy, vtkSMKeyFrameProxy *  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 vtkSMBooleanKeyFrameProxy, vtkSMCameraKeyFrameProxy, vtkSMExponentialKeyFrameProxy, vtkSMRampKeyFrameProxy, and vtkSMSinusoidKeyFrameProxy.

vtkClientServerID vtkSMKeyFrameProxy::GetID (   )  [inline]

Definition at line 74 of file vtkSMKeyFrameProxy.h.

virtual void vtkSMKeyFrameProxy::Copy (  vtkSMProxy *  src, const char *  exceptionClass, int  proxyPropertyCopyFlag )  [virtual]

Overridden to call MarkAllPropertiesAsModified(). Reimplemented from vtkSMProxy.

---

Member Data Documentation

double vtkSMKeyFrameProxy::KeyTime [protected]

Definition at line 86 of file vtkSMKeyFrameProxy.h.

vtkSMKeyFrameProxyInternals* vtkSMKeyFrameProxy::Internals [protected]

Reimplemented from vtkSMProxy. Definition at line 87 of file vtkSMKeyFrameProxy.h.

---

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

• Servers/ServerManager/vtkSMKeyFrameProxy.h

---