vtkPVAnimationCue Class Reference

the GUI for an Animation Cue. More...

#include <vtkPVAnimationCue.h>

Inheritance diagram for vtkPVAnimationCue:

[legend]Collaboration diagram for vtkPVAnimationCue:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkPVAnimationCue, vtkPVSimpleAnimationCue)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *app)
void	SetTimeLineParent (vtkKWWidget *frame)
virtual void	SetLabelText (const char *label)
virtual void	PackWidget ()
virtual void	UnpackWidget ()
virtual void	RemoveAllKeyFrames ()
void	DeleteKeyFrame (int id)
virtual void	ReplaceKeyFrame (vtkPVKeyFrame *oldFrame, vtkPVKeyFrame *newFrame)
virtual void	StartRecording ()
virtual void	StopRecording ()
virtual void	RecordState (double ntime, double offset, int onlyFocus)
virtual void	RecordState (double ntime, double offset)
void	SetAnimationScene (vtkPVAnimationScene *scene)
virtual void	UpdateEnableState ()
virtual void	SaveState (ofstream *file)
void	SetEnableZoom (int zoom)
const char *	GetTclNameCommand ()
virtual void	Detach ()
virtual void	SelectKeyFrame (int id)
virtual int	CreateAndAddKeyFrame (double time, int type)
virtual vtkPVTimeLine *	GetTimeLine ()
virtual void	GetFocus ()
virtual void	RemoveFocus ()
virtual int	HasFocus ()
void	SetPVSource (vtkPVSource *)
virtual vtkPVSource *	GetPVSource ()
virtual void	SetTimeMarker (double time)
double	GetTimeMarker ()
virtual void	SetName (const char *)
virtual char *	GetName ()
virtual void	SetSourceTreeName (const char *)
virtual char *	GetSourceTreeName ()
virtual void	Zoom (double range[2])
void	Zoom (double s, double e)
virtual void	UpdateCueVisibility (int advanced)
virtual int	GetCueVisibility ()
virtual void	SetTimeBounds (double bounds[2], int enable_scaling=0)
virtual int	GetTimeBounds (double *bounds)
Static Public Member Functions
vtkPVAnimationCue *	New ()
Protected Types
enum	{ NONE = 0, IMAGE_OPEN, IMAGE_CLOSE }
Protected Member Functions
	vtkPVAnimationCue ()
	~vtkPVAnimationCue ()
void	InitializeObservers (vtkObject *object)
virtual void	ExecuteEvent (vtkObject *obj, unsigned long event, void *data)
virtual void	SetTclNameCommand (const char *)
void	SetImageType (int type)
virtual int	GetImageType ()
void	GetSelfFocus ()
void	RemoveSelfFocus ()
virtual void	RegisterProxies ()
virtual void	UnregisterProxies ()
Protected Attributes
vtkKWWidget *	TimeLineParent
vtkPVSource *	PVSource
vtkKWLabel *	Label
vtkKWLabel *	Image
vtkKWFrame *	Frame
vtkKWFrame *	TimeLineContainer
vtkKWFrame *	TimeLineFrame
vtkPVTimeLine *	TimeLine
int	ImageType
int	ShowTimeLine
char *	Name
char *	SourceTreeName
char *	TclNameCommand
int	Focus
vtkPVAnimationScene *	PVAnimationScene
int	CueVisibility
int	DisableSelectionChangedEvent

---

Detailed Description

the GUI for an Animation Cue.

vtkPVAnimationCue is manages the GUI for an Animation Cue. The GUI has two sections, the navgation interface: which shows the label of the cue and the timeline: which is used to modify keyframes. ParaView puts these two sections in two panes of a split frame so that the label length does not reduce the visible area for the timelines. The parent of an object of this class acts as the parent for the Navigation section, while the TimeLineParent is the parent for the timeline. Both of which need to be set before calling create. This class has Virtual mode. In this mode, no proxies are created for this class. This mode is used by the Subclass vtkPVAnimationCueTree which represents a GUI element which has child cues eg. the cue for the PVSource or for a property with multiple elements. Thus, Virtual cue is used merely to group the chidlren. The support for adding children and managing them is provided by the subclass vtkPVAnimationCueTree.

See also:

vtkPVAnimationCueTree vtkSMAnimationCueProxy

Definition at line 56 of file vtkPVAnimationCue.h.

---

Member Enumeration Documentation

anonymous enum [protected]

Enumeration values: NONE  IMAGE_OPEN  IMAGE_CLOSE  Definition at line 228 of file vtkPVAnimationCue.h.

---

Constructor & Destructor Documentation

vtkPVAnimationCue::vtkPVAnimationCue (   )  [protected]

vtkPVAnimationCue::~vtkPVAnimationCue (   )  [protected]

---

Member Function Documentation

vtkPVAnimationCue* vtkPVAnimationCue::New (   )  [static]

Reimplemented from vtkPVSimpleAnimationCue. Reimplemented in vtkPVAnimationCueTree, and vtkPVCameraAnimationCue.

vtkPVAnimationCue::vtkTypeRevisionMacro (  vtkPVAnimationCue  , vtkPVSimpleAnimationCue  )

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

Reimplemented from vtkPVSimpleAnimationCue. Reimplemented in vtkPVAnimationCueTree, and vtkPVCameraAnimationCue.

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

Create the widget. Reimplemented from vtkPVSimpleAnimationCue. Reimplemented in vtkPVAnimationCueTree.

void vtkPVAnimationCue::SetTimeLineParent (  vtkKWWidget *  frame  )

TimeLineParent is the frame that contains the timelines. this->Parent is the frame which contains the labels (or the Navgation widget) for the cue.

virtual void vtkPVAnimationCue::SetLabelText (  const char *  label  )  [virtual]

Label Text is the text shown for this cue. Reimplemented from vtkPVSimpleAnimationCue.

virtual vtkPVTimeLine* vtkPVAnimationCue::GetTimeLine (   )  [virtual]

Get the timeline object.

virtual void vtkPVAnimationCue::PackWidget (   )  [virtual]

Reimplemented in vtkPVAnimationCueTree.

virtual void vtkPVAnimationCue::UnpackWidget (   )  [virtual]

Reimplemented in vtkPVAnimationCueTree.

virtual void vtkPVAnimationCue::GetFocus (   )  [virtual]

Provides for highlighting of the selected cue. Reimplemented in vtkPVAnimationCueTree.

virtual void vtkPVAnimationCue::RemoveFocus (   )  [virtual]

Provides for highlighting of the selected cue. Reimplemented in vtkPVAnimationCueTree.

virtual int vtkPVAnimationCue::HasFocus (   )  [inline, virtual]

Provides for highlighting of the selected cue. Reimplemented in vtkPVAnimationCueTree. Definition at line 86 of file vtkPVAnimationCue.h.

virtual void vtkPVAnimationCue::RemoveAllKeyFrames (   )  [virtual]

Remove All Key frames from this cue. Reimplemented from vtkPVSimpleAnimationCue. Reimplemented in vtkPVAnimationCueTree.

void vtkPVAnimationCue::DeleteKeyFrame (  int  id  )

Deletes the keyframe at given index. If the deleted key frame is the currenly selected keyframe, it changes the selection and the timeline is updated. Reimplemented from vtkPVSimpleAnimationCue.

virtual void vtkPVAnimationCue::ReplaceKeyFrame (  vtkPVKeyFrame *  oldFrame, vtkPVKeyFrame *  newFrame )  [virtual]

Replaces a keyframe with another. The Key time and key value of the oldFrame and copied over to the newFrame; Reimplemented from vtkPVSimpleAnimationCue. Reimplemented in vtkPVCameraAnimationCue.

virtual void vtkPVAnimationCue::StartRecording (   )  [virtual]

Start Recording. Once recording has been started new key frames cannot be added directly. Reimplemented from vtkPVSimpleAnimationCue. Reimplemented in vtkPVAnimationCueTree, and vtkPVCameraAnimationCue.

virtual void vtkPVAnimationCue::StopRecording (   )  [virtual]

Stop Recording. Reimplemented from vtkPVSimpleAnimationCue. Reimplemented in vtkPVAnimationCueTree.

virtual void vtkPVAnimationCue::RecordState (  double  ntime, double  offset, int  onlyFocus )  [virtual]

Reimplemented in vtkPVAnimationCueTree, and vtkPVCameraAnimationCue.

virtual void vtkPVAnimationCue::RecordState (  double  ntime, double  offset )  [virtual]

Reimplemented from vtkPVSimpleAnimationCue. Reimplemented in vtkPVAnimationCueTree, and vtkPVCameraAnimationCue.

void vtkPVAnimationCue::SetAnimationScene (  vtkPVAnimationScene *  scene  )

Set a pointer to the AnimationScene. This is not reference counted. A cue adds itself to the scene when it has two or more key frames (i.e. the is animatable), and it removes itself from the Scene is the number of keyframes reduces.

void vtkPVAnimationCue::SetPVSource (  vtkPVSource *   )

Pointer to the PVSource that this cue stands for. The PVSource is used to generate the tcl name when GetTclNameCommand is called.

virtual vtkPVSource* vtkPVAnimationCue::GetPVSource (   )  [virtual]

Pointer to the PVSource that this cue stands for. The PVSource is used to generate the tcl name when GetTclNameCommand is called.

virtual void vtkPVAnimationCue::SetTimeMarker (  double  time  )  [virtual]

Time marker is a vartical line used to indicate the current time. This method sets the timemarker of the timeline for this cue alone. Reimplemented in vtkPVAnimationCueTree.

double vtkPVAnimationCue::GetTimeMarker (   )

Time marker is a vartical line used to indicate the current time. This method sets the timemarker of the timeline for this cue alone.

virtual void vtkPVAnimationCue::UpdateEnableState (   )  [virtual]

Update the "enable" state of the object and its internal parts. Depending on different Ivars (this->Enabled, the application's Limited Edition Mode, etc.), the "enable" state of the object is updated and propagated to its internal parts/subwidgets. This will, for example, enable/disable parts of the widget UI, enable/disable the visibility of 3D widgets, etc. Reimplemented from vtkPVSimpleAnimationCue. Reimplemented in vtkPVAnimationCueTree.

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

Reimplemented in vtkPVAnimationCueTree.

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

Each cue is assigned a unique name. This name is used to indentify the cue in trace/ state. Names are assigned my the vtkPVAnimationManager while creating the PVAnimationCue. A child cue can be obtained from the parent vtkPVAnimationCueTree using this name. Note that this method does not ensure that the name is indeed unique. It is responsibility of the vtkPVAnimationManager to set unique names (atleast among the siblings) for the trace/ state to work properly. Also, only vtkPVAnimationManager must set the name of the cue.

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

Each cue is assigned a unique name. This name is used to indentify the cue in trace/ state. Names are assigned my the vtkPVAnimationManager while creating the PVAnimationCue. A child cue can be obtained from the parent vtkPVAnimationCueTree using this name. Note that this method does not ensure that the name is indeed unique. It is responsibility of the vtkPVAnimationManager to set unique names (atleast among the siblings) for the trace/ state to work properly. Also, only vtkPVAnimationManager must set the name of the cue.

virtual void vtkPVAnimationCue::SetSourceTreeName (  const char *   )  [virtual]

This is the Name of the vtkPVAnimationCueTree for the base of this Cue. This name need not be set when this Cue has a vtkPVSource associated with it. If it does not have a PVSource (like Camera) in that case this name must be set. It is used by vtkPVActiveTrackSelector to identify the parent of the cue in case the PVSource is not present.

virtual char* vtkPVAnimationCue::GetSourceTreeName (   )  [virtual]

This is the Name of the vtkPVAnimationCueTree for the base of this Cue. This name need not be set when this Cue has a vtkPVSource associated with it. If it does not have a PVSource (like Camera) in that case this name must be set. It is used by vtkPVActiveTrackSelector to identify the parent of the cue in case the PVSource is not present.

void vtkPVAnimationCue::SetEnableZoom (  int  zoom  )

Enable horizontal zooming of the timeline.

virtual void vtkPVAnimationCue::Zoom (  double  range[2]  )  [virtual]

Reimplemented in vtkPVAnimationCueTree.

void vtkPVAnimationCue::Zoom (  double  s, double  e )  [inline]

Definition at line 172 of file vtkPVAnimationCue.h.

const char* vtkPVAnimationCue::GetTclNameCommand (   )

The name of a cue for a PVSource depends on the PVSource's name. For trace to work reliably, the cue's name must be constructed on using the PVSource (not it's name, since the name may change when the trace is run). This returns the tcl script/string that evaluates the name correctly at runtime. For non-source cues (.i.e. cues for things like Camera or the property cues), this is same as the name of the cue.

virtual void vtkPVAnimationCue::UpdateCueVisibility (  int  advanced  )  [virtual]

Updates the visibility of the cue. If the animated property is not "animateable", then it is visible only in Advanced mode. Reimplemented in vtkPVAnimationCueTree.

virtual int vtkPVAnimationCue::GetCueVisibility (   )  [virtual]

Updates the visibility of the cue. If the animated property is not "animateable", then it is visible only in Advanced mode.

virtual void vtkPVAnimationCue::Detach (   )  [virtual]

Detachs the cue. i.e. removes it from scene etc. and prepares it to be deleted. Reimplemented in vtkPVAnimationCueTree.

virtual void vtkPVAnimationCue::SelectKeyFrame (  int  id  )  [virtual]

This will select the keyframe. Fires a SelectionChangedEvent. Reimplemented from vtkPVSimpleAnimationCue.

virtual void vtkPVAnimationCue::SetTimeBounds (  double  bounds[2], int  enable_scaling = 0 )  [virtual]

Set the timeline parameter bounds. This moves the timeline end points. Depending upon is enable_scaling is set, the internal nodes are scaled. Reimplemented from vtkPVSimpleAnimationCue. Reimplemented in vtkPVAnimationCueTree.

virtual int vtkPVAnimationCue::GetTimeBounds (  double *  bounds  )  [virtual]

Set the timeline parameter bounds. This moves the timeline end points. Depending upon is enable_scaling is set, the internal nodes are scaled. Reimplemented from vtkPVSimpleAnimationCue.

virtual int vtkPVAnimationCue::CreateAndAddKeyFrame (  double  time, int  type )  [virtual]

Creates a new key frame of the specified type and add it to the cue at the given time. Time is normalized to the span of the cue [0,1]. This method also does not verify is a key frame already exists at the specified time. Reimplemented from vtkPVSimpleAnimationCue.

void vtkPVAnimationCue::SetImageType (  int  type  )  [protected]

Set/Get the type of the image shown to the left of the label in the Navigation interface. This is useful esp for simulating the apperance of a tree.

virtual int vtkPVAnimationCue::GetImageType (   )  [protected, virtual]

Set/Get the type of the image shown to the left of the label in the Navigation interface. This is useful esp for simulating the apperance of a tree.

void vtkPVAnimationCue::InitializeObservers (  vtkObject *  object  )  [protected]

virtual void vtkPVAnimationCue::ExecuteEvent (  vtkObject *  obj, unsigned long  event, void *  data )  [protected, virtual]

Reimplemented from vtkPVSimpleAnimationCue. Reimplemented in vtkPVAnimationCueTree.

virtual void vtkPVAnimationCue::SetTclNameCommand (  const char *   )  [protected, virtual]

void vtkPVAnimationCue::GetSelfFocus (   )  [protected]

Internal methods to change focus state of this cue.

void vtkPVAnimationCue::RemoveSelfFocus (   )  [protected]

Internal methods to change focus state of this cue.

virtual void vtkPVAnimationCue::RegisterProxies (   )  [protected, virtual]

A PVCue registers the proxies and adds it to the AnimationScene iff it has atleast two keyframes and it is not virtual. Whenever this criteria is not met, it is unregistered and removed form the AnimationScene. This ensures that SMState and BatchScript will have only those cue proxies which actually constitute any animation. Reimplemented from vtkPVSimpleAnimationCue.

virtual void vtkPVAnimationCue::UnregisterProxies (   )  [protected, virtual]

A PVCue registers the proxies and adds it to the AnimationScene iff it has atleast two keyframes and it is not virtual. Whenever this criteria is not met, it is unregistered and removed form the AnimationScene. This ensures that SMState and BatchScript will have only those cue proxies which actually constitute any animation. Reimplemented from vtkPVSimpleAnimationCue.

---

Member Data Documentation

vtkKWWidget* vtkPVAnimationCue::TimeLineParent [protected]

Definition at line 238 of file vtkPVAnimationCue.h.

vtkPVSource* vtkPVAnimationCue::PVSource [protected]

Definition at line 239 of file vtkPVAnimationCue.h.

vtkKWLabel* vtkPVAnimationCue::Label [protected]

Definition at line 241 of file vtkPVAnimationCue.h.

vtkKWLabel* vtkPVAnimationCue::Image [protected]

Definition at line 242 of file vtkPVAnimationCue.h.

vtkKWFrame* vtkPVAnimationCue::Frame [protected]

Definition at line 243 of file vtkPVAnimationCue.h.

vtkKWFrame* vtkPVAnimationCue::TimeLineContainer [protected]

Definition at line 245 of file vtkPVAnimationCue.h.

vtkKWFrame* vtkPVAnimationCue::TimeLineFrame [protected]

Definition at line 246 of file vtkPVAnimationCue.h.

vtkPVTimeLine* vtkPVAnimationCue::TimeLine [protected]

Definition at line 247 of file vtkPVAnimationCue.h.

int vtkPVAnimationCue::ImageType [protected]

Definition at line 249 of file vtkPVAnimationCue.h.

int vtkPVAnimationCue::ShowTimeLine [protected]

Definition at line 250 of file vtkPVAnimationCue.h.

char* vtkPVAnimationCue::Name [protected]

Definition at line 252 of file vtkPVAnimationCue.h.

char* vtkPVAnimationCue::SourceTreeName [protected]

Definition at line 253 of file vtkPVAnimationCue.h.

char* vtkPVAnimationCue::TclNameCommand [protected]

Definition at line 254 of file vtkPVAnimationCue.h.

int vtkPVAnimationCue::Focus [protected]

Definition at line 257 of file vtkPVAnimationCue.h.

vtkPVAnimationScene* vtkPVAnimationCue::PVAnimationScene [protected]

Definition at line 258 of file vtkPVAnimationCue.h.

int vtkPVAnimationCue::CueVisibility [protected]

Definition at line 276 of file vtkPVAnimationCue.h.

int vtkPVAnimationCue::DisableSelectionChangedEvent [protected]

Definition at line 277 of file vtkPVAnimationCue.h.

---

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

• GUI/Client/vtkPVAnimationCue.h

---