vtkPVKeyFrame Class Reference

superclass for Key Frame GUIs More...

#include <vtkPVKeyFrame.h>

Inheritance diagram for vtkPVKeyFrame:

[legend]Collaboration diagram for vtkPVKeyFrame:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkPVKeyFrame, vtkPVTracedWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *app)
void	SetKeyFrameProxy (vtkSMKeyFrameProxy *kfProxy)
void	SetKeyTimeWithTrace (double time)
virtual void	InitializeKeyValueUsingCurrentState ()=0
virtual void	InitializeKeyValueDomainUsingCurrentState ()=0
void	TimeChangedCallback ()
virtual void	PrepareForDisplay ()
virtual void	SaveState (ofstream *file)
virtual void	UpdateEnableState ()
virtual void	Copy (vtkPVKeyFrame *fromKF)
virtual vtkSMKeyFrameProxy *	GetKeyFrameProxy ()
void	SetKeyTime (double time)
double	GetKeyTime ()
void	SetTimeMinimumBound (double min)
void	SetTimeMaximumBound (double max)
void	ClearTimeBounds ()
void	SetAnimationCueProxy (vtkSMAnimationCueProxy *cueproxy)
virtual vtkSMAnimationCueProxy *	GetAnimationCueProxy ()
virtual void	SetValueToMinimum ()=0
virtual void	SetValueToMaximum ()=0
virtual void	SetName (const char *)
virtual char *	GetName ()
void	SetAnimationScene (vtkPVAnimationScene *scene)
virtual vtkPVAnimationScene *	GetAnimationScene ()
void	SetDuration (double duration)
virtual double	GetDuration ()
virtual void	SetTimeChangeable (int)
virtual int	GetTimeChangeable ()
virtual void	SetBlankTimeEntry (int)
virtual int	GetBlankTimeEntry ()
Protected Member Functions
	vtkPVKeyFrame ()
	~vtkPVKeyFrame ()
virtual void	ChildCreate (vtkKWApplication *app)
virtual void	SetKeyFrameProxyName (const char *)
virtual void	SetKeyFrameProxyXMLName (const char *)
void	DetermineKeyFrameProxyName ()
virtual void	ExecuteEvent (vtkObject *, unsigned long event, void *)
virtual void	UpdateValuesFromProxy ()
double	GetRelativeTime (double ntime)
double	GetNormalizedTime (double rtime)
Protected Attributes
vtkSMKeyFrameProxy *	KeyFrameProxy
char *	KeyFrameProxyName
char *	KeyFrameProxyXMLName
vtkKWLabel *	TimeLabel
vtkKWThumbWheel *	TimeThumbWheel
vtkSMAnimationCueProxy *	AnimationCueProxy
char *	Name
vtkPVKeyFrameObserver *	Observer
double	TimeBounds [2]
double	Duration
int	BlankTimeEntry
int	TimeChangeable
vtkPVAnimationScene *	AnimationScene
int	BlockUpdates
Friends
class	vtkPVKeyFrameObserver

---

Detailed Description

superclass for Key Frame GUIs

Definition at line 35 of file vtkPVKeyFrame.h.

---

Constructor & Destructor Documentation

vtkPVKeyFrame::vtkPVKeyFrame (   )  [protected]

vtkPVKeyFrame::~vtkPVKeyFrame (   )  [protected]

---

Member Function Documentation

vtkPVKeyFrame::vtkTypeRevisionMacro (  vtkPVKeyFrame  , vtkPVTracedWidget  )

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

Reimplemented from vtkPVTracedWidget. Reimplemented in vtkPVBooleanKeyFrame, vtkPVCameraKeyFrame, vtkPVExponentialKeyFrame, vtkPVPropertyKeyFrame, vtkPVProxyKeyFrame, vtkPVRampKeyFrame, and vtkPVSinusoidKeyFrame.

virtual void vtkPVKeyFrame::Create (  vtkKWApplication *  app  )  [virtual]

Create the widget. Reimplemented from vtkKWCompositeWidget.

virtual vtkSMKeyFrameProxy* vtkPVKeyFrame::GetKeyFrameProxy (   )  [virtual]

Get the keyframe proxy.

void vtkPVKeyFrame::SetKeyFrameProxy (  vtkSMKeyFrameProxy *  kfProxy  )

Set the keyframe proxy to be used by this GUI. If set before calling Create(), this class will not create any instance of KeyFrameProxy, instead use the one provided. When set after create, the old one is dereferenced and the GUI is updated to the values of the provided proxy. Note that the type of the KeyFrameProxy and that of the GUI must match.

void vtkPVKeyFrame::SetKeyTime (  double  time  )

Get/Set the key time: the time for this key frame. Time is normalized, i.e. 1 == end of cue.

double vtkPVKeyFrame::GetKeyTime (   )

Get/Set the key time: the time for this key frame. Time is normalized, i.e. 1 == end of cue.

void vtkPVKeyFrame::SetKeyTimeWithTrace (  double  time  )

Calls SetKeyTime() and adds it to the trace.

virtual void vtkPVKeyFrame::InitializeKeyValueUsingCurrentState (   )  [pure virtual]

Initialized Key Value using current animated property value. Implemented in vtkPVCameraKeyFrame, and vtkPVPropertyKeyFrame.

virtual void vtkPVKeyFrame::InitializeKeyValueDomainUsingCurrentState (   )  [pure virtual]

Initialize the Key Value bounds using current animatied property value and domain state. Implemented in vtkPVCameraKeyFrame, and vtkPVPropertyKeyFrame.

void vtkPVKeyFrame::SetTimeMinimumBound (  double  min  )

If set, these ranges can be used to bound the values. Timebounds are in normalized time.

void vtkPVKeyFrame::SetTimeMaximumBound (  double  max  )

If set, these ranges can be used to bound the values. Timebounds are in normalized time.

void vtkPVKeyFrame::ClearTimeBounds (   )

If set, these ranges can be used to bound the values. Timebounds are in normalized time.

void vtkPVKeyFrame::TimeChangedCallback (   )

Callbacks for GUI

virtual void vtkPVKeyFrame::PrepareForDisplay (   )  [virtual]

Prepares the Key frame GUI for display. Typically, updates the GUI to reflect the state of the underlying proxy/property.

void vtkPVKeyFrame::SetAnimationCueProxy (  vtkSMAnimationCueProxy *  cueproxy  )  [inline]

A pointer to the AnimationCueProxy is need so that the keyframe can obtain information about the animated property. Must be set before calling create and should not be changed thereafter. Note that it is not reference counted for fear of loops. Definition at line 95 of file vtkPVKeyFrame.h.

virtual vtkSMAnimationCueProxy* vtkPVKeyFrame::GetAnimationCueProxy (   )  [virtual]

A pointer to the AnimationCueProxy is need so that the keyframe can obtain information about the animated property. Must be set before calling create and should not be changed thereafter. Note that it is not reference counted for fear of loops.

virtual void vtkPVKeyFrame::SetValueToMinimum (   )  [pure virtual]

These methods set the current Key value to min or max if they exist. Otherwise the value remains unchanged. Implemented in vtkPVCameraKeyFrame, and vtkPVPropertyKeyFrame.

virtual void vtkPVKeyFrame::SetValueToMaximum (   )  [pure virtual]

These methods set the current Key value to min or max if they exist. Otherwise the value remains unchanged. Implemented in vtkPVCameraKeyFrame, and vtkPVPropertyKeyFrame.

virtual void vtkPVKeyFrame::SaveState (  ofstream *  file  )  [virtual]

Save state of the GUI. Reimplemented in vtkPVCameraKeyFrame, vtkPVExponentialKeyFrame, vtkPVPropertyKeyFrame, and vtkPVSinusoidKeyFrame.

virtual void vtkPVKeyFrame::UpdateEnableState (   )  [virtual]

Propagate widget enable state. Reimplemented from vtkKWWidget. Reimplemented in vtkPVExponentialKeyFrame, vtkPVPropertyKeyFrame, and vtkPVSinusoidKeyFrame.

virtual void vtkPVKeyFrame::SetName (  const char *   )  [virtual]

Name is used for trace alone. Do not use this directly.

virtual char* vtkPVKeyFrame::GetName (   )  [virtual]

Name is used for trace alone. Do not use this directly.

void vtkPVKeyFrame::SetAnimationScene (  vtkPVAnimationScene *  scene  )

Used to obtain duration. If not set the Duration ivar will be used in normalizing time.

virtual vtkPVAnimationScene* vtkPVKeyFrame::GetAnimationScene (   )  [virtual]

Used to obtain duration. If not set the Duration ivar will be used in normalizing time.

void vtkPVKeyFrame::SetDuration (  double  duration  )

If AnimationScene is not set, Duration is used to normalize time.

virtual double vtkPVKeyFrame::GetDuration (   )  [virtual]

If AnimationScene is not set, Duration is used to normalize time.

virtual void vtkPVKeyFrame::Copy (  vtkPVKeyFrame *  fromKF  )  [virtual]

Copies the values from argument. If the two differ in type, only corresponding properies are copied over; Reimplemented in vtkPVPropertyKeyFrame.

virtual void vtkPVKeyFrame::SetTimeChangeable (  int   )  [virtual]

Get/Set if the time for this key frame is changeable. If not the widget is disabled. Default is true.

virtual int vtkPVKeyFrame::GetTimeChangeable (   )  [virtual]

Get/Set if the time for this key frame is changeable. If not the widget is disabled. Default is true.

virtual void vtkPVKeyFrame::SetBlankTimeEntry (  int   )  [virtual]

Get/Set if the time entry should show any text. Not set by default. Note that BlankTimeEntry has any effect only when TimeChangeable is set to 0. ie. when time is changeable, BlankTimeEntry is ignored and the time value will be shown in the time-entry box.

virtual int vtkPVKeyFrame::GetBlankTimeEntry (   )  [virtual]

Get/Set if the time entry should show any text. Not set by default. Note that BlankTimeEntry has any effect only when TimeChangeable is set to 0. ie. when time is changeable, BlankTimeEntry is ignored and the time value will be shown in the time-entry box.

virtual void vtkPVKeyFrame::ChildCreate (  vtkKWApplication *  app  )  [protected, virtual]

Reimplemented in vtkPVBooleanKeyFrame, vtkPVCameraKeyFrame, vtkPVExponentialKeyFrame, vtkPVPropertyKeyFrame, vtkPVRampKeyFrame, and vtkPVSinusoidKeyFrame.

virtual void vtkPVKeyFrame::SetKeyFrameProxyName (  const char *   )  [protected, virtual]

virtual void vtkPVKeyFrame::SetKeyFrameProxyXMLName (  const char *   )  [protected, virtual]

void vtkPVKeyFrame::DetermineKeyFrameProxyName (   )  [protected]

virtual void vtkPVKeyFrame::ExecuteEvent (  vtkObject *  , unsigned long  event, void *  )  [protected, virtual]

virtual void vtkPVKeyFrame::UpdateValuesFromProxy (   )  [protected, virtual]

Update the values from the vtkSMKeyFrameProxy. Reimplemented in vtkPVCameraKeyFrame, vtkPVExponentialKeyFrame, vtkPVPropertyKeyFrame, and vtkPVSinusoidKeyFrame.

double vtkPVKeyFrame::GetRelativeTime (  double  ntime  )  [protected]

double vtkPVKeyFrame::GetNormalizedTime (  double  rtime  )  [protected]

---

Friends And Related Function Documentation

friend class vtkPVKeyFrameObserver [friend]

Definition at line 172 of file vtkPVKeyFrame.h.

---

Member Data Documentation

vtkSMKeyFrameProxy* vtkPVKeyFrame::KeyFrameProxy [protected]

Definition at line 158 of file vtkPVKeyFrame.h.

char* vtkPVKeyFrame::KeyFrameProxyName [protected]

Definition at line 159 of file vtkPVKeyFrame.h.

char* vtkPVKeyFrame::KeyFrameProxyXMLName [protected]

Definition at line 160 of file vtkPVKeyFrame.h.

vtkKWLabel* vtkPVKeyFrame::TimeLabel [protected]

Definition at line 166 of file vtkPVKeyFrame.h.

vtkKWThumbWheel* vtkPVKeyFrame::TimeThumbWheel [protected]

Definition at line 167 of file vtkPVKeyFrame.h.

vtkSMAnimationCueProxy* vtkPVKeyFrame::AnimationCueProxy [protected]

Definition at line 169 of file vtkPVKeyFrame.h.

char* vtkPVKeyFrame::Name [protected]

Definition at line 170 of file vtkPVKeyFrame.h.

vtkPVKeyFrameObserver* vtkPVKeyFrame::Observer [protected]

Definition at line 173 of file vtkPVKeyFrame.h.

double vtkPVKeyFrame::TimeBounds[2] [protected]

Definition at line 183 of file vtkPVKeyFrame.h.

double vtkPVKeyFrame::Duration [protected]

Definition at line 184 of file vtkPVKeyFrame.h.

int vtkPVKeyFrame::BlankTimeEntry [protected]

Definition at line 186 of file vtkPVKeyFrame.h.

int vtkPVKeyFrame::TimeChangeable [protected]

Definition at line 187 of file vtkPVKeyFrame.h.

vtkPVAnimationScene* vtkPVKeyFrame::AnimationScene [protected]

Definition at line 189 of file vtkPVKeyFrame.h.

int vtkPVKeyFrame::BlockUpdates [protected]

Definition at line 191 of file vtkPVKeyFrame.h.

---

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

• GUI/Client/vtkPVKeyFrame.h

---