vtkPVAnimationCueTree Class Reference

represents a non-leaf node in the animation GUI. More...

#include <vtkPVAnimationCueTree.h>

Inheritance diagram for vtkPVAnimationCueTree:

[legend]Collaboration diagram for vtkPVAnimationCueTree:


Public Member Functions
	vtkTypeRevisionMacro (vtkPVAnimationCueTree, vtkPVAnimationCue)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *app)
void	AddChildCue (vtkPVAnimationCue *child)
void	RemoveChildCue (vtkPVAnimationCue *child)
vtkPVAnimationCue *	GetChild (const char *name)
vtkCollectionIterator *	NewChildrenIterator ()
virtual void	PackWidget ()
virtual void	UnpackWidget ()
virtual void	SetTimeBounds (double bounds[2], int enable_scaling=0)
virtual void	GetFocus ()
virtual void	RemoveFocus ()
virtual int	HasFocus ()
virtual void	SetTimeMarker (double time)
virtual void	StartRecording ()
virtual void	StopRecording ()
virtual void	UpdateEnableState ()
virtual void	SaveState (ofstream *file)
virtual void	Zoom (double range[2])
virtual void	RemoveAllKeyFrames ()
virtual void	UpdateCueVisibility (int advanced)
virtual void	Detach ()

virtual void	ToggleExpandedState ()
void	SetExpanded (int expand)

virtual void	ScaleChildrenOnEndPointsChangeOn ()
virtual void	ScaleChildrenOnEndPointsChangeOff ()
virtual void	SetScaleChildrenOnEndPointsChange (int)
virtual int	GetScaleChildrenOnEndPointsChange ()

virtual void	MoveEndPointsWhenChildrenChangeOn ()
virtual void	MoveEndPointsWhenChildrenChangeOff ()
virtual void	SetMoveEndPointsWhenChildrenChange (int)
virtual int	GetMoveEndPointsWhenChildrenChange ()

virtual void	RecordState (double ntime, double offset)
virtual void	RecordState (double ntime, double offset, int onlyFocus)
Static Public Member Functions
vtkPVAnimationCueTree *	New ()
Protected Member Functions
	vtkPVAnimationCueTree ()
	~vtkPVAnimationCueTree ()
virtual void	ExecuteEvent (vtkObject wdg, unsigned long event, void calldata)
void	DrawChildConnections (vtkPVAnimationCue *child)
virtual void	SetLastParameterBounds (double, double)
void	SetLastParameterBounds (double[2])
void	ScaleChildren (double old_bounds[2], double new_bounds[2])
void	RemoveChildrenFocus (vtkPVAnimationCue *exception=NULL)
void	AdjustEndPoints ()
Protected Attributes
int	Expanded
vtkCollection *	Children
vtkKWFrame *	NavigatorContainer
vtkKWCanvas *	NavigatorCanvas
vtkKWFrame *	NavigatorChildrenFrame
vtkKWFrame *	TimeLineChildrenFrame
double	LastParameterBounds [2]
int	ScaleChildrenOnEndPointsChange
int	MoveEndPointsWhenChildrenChange
int	ForceBounds

Detailed Description

represents a non-leaf node in the animation GUI.

vtkPVAnimationCueTree can be thought of as a node in the timeline tree which has children. This is Virtual Cue i.e. it does not have any actual proxies associated with it. It merely acts a container for the children cues. The user cannot directly add/remove keys in the timeline associated with vtkPVAnimationCueTree. Its timeline automatically adjust to the maximum extent of the children timelines. The user can scale children timelines by moving the end points of its timeline.

See also:: vtkPVAnimationCue

Definition at line 40 of file vtkPVAnimationCueTree.h.

Constructor & Destructor Documentation

vtkPVAnimationCueTree::vtkPVAnimationCueTree ( ) [protected]

vtkPVAnimationCueTree::~vtkPVAnimationCueTree ( ) [protected]

Member Function Documentation

vtkPVAnimationCueTree* vtkPVAnimationCueTree::New ( ) [static]

Reimplemented from vtkPVAnimationCue.

vtkPVAnimationCueTree::vtkTypeRevisionMacro ( vtkPVAnimationCueTree ,

vtkPVAnimationCue

)

void vtkPVAnimationCueTree::PrintSelf ( ostream & os,

vtkIndent indent

)

Reimplemented from vtkPVAnimationCue.

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

Create the widget.
Reimplemented from vtkPVAnimationCue.

void vtkPVAnimationCueTree::AddChildCue ( vtkPVAnimationCue * child )

Add a child cue. Currently, child can be added only after the parent has been created and the child must not have been created. This method appropriately set the child parent and creates and packs it.

void vtkPVAnimationCueTree::RemoveChildCue ( vtkPVAnimationCue * child )

Remove a child cue.

vtkPVAnimationCue* vtkPVAnimationCueTree::GetChild ( const char * name )

Returns the first child with the given name. Method present for Trace/State. vtkPVAnimationManager ensures that these names are unique.

vtkCollectionIterator* vtkPVAnimationCueTree::NewChildrenIterator ( )

Allocates a new Iterator for the chilren. The caller should delete the allocated iterator.

virtual void vtkPVAnimationCueTree::PackWidget ( ) [virtual]

Reimplemented from vtkPVAnimationCue.

virtual void vtkPVAnimationCueTree::UnpackWidget ( ) [virtual]

Reimplemented from vtkPVAnimationCue.

virtual void vtkPVAnimationCueTree::ToggleExpandedState ( ) [virtual]

Expand or collapse the children.

void vtkPVAnimationCueTree::SetExpanded ( int expand )

Expand or collapse the children.

virtual void vtkPVAnimationCueTree::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. This also updates the children bounds.
Reimplemented from vtkPVAnimationCue.

virtual void vtkPVAnimationCueTree::ScaleChildrenOnEndPointsChangeOn ( ) [virtual]

Indicates if this AnimationCueTree must scale the children timeline endpoints if the user changes the endpoints of this tree.

virtual void vtkPVAnimationCueTree::ScaleChildrenOnEndPointsChangeOff ( ) [virtual]

Indicates if this AnimationCueTree must scale the children timeline endpoints if the user changes the endpoints of this tree.

virtual void vtkPVAnimationCueTree::SetScaleChildrenOnEndPointsChange ( int ) [virtual]

Indicates if this AnimationCueTree must scale the children timeline endpoints if the user changes the endpoints of this tree.

virtual int vtkPVAnimationCueTree::GetScaleChildrenOnEndPointsChange ( ) [virtual]

Indicates if this AnimationCueTree must scale the children timeline endpoints if the user changes the endpoints of this tree.

virtual void vtkPVAnimationCueTree::MoveEndPointsWhenChildrenChangeOn ( ) [virtual]

Indicates if the endpoints of the timeline controlled by this AnimationCueTree must be repositioned if those of the children are moved.

virtual void vtkPVAnimationCueTree::MoveEndPointsWhenChildrenChangeOff ( ) [virtual]

Indicates if the endpoints of the timeline controlled by this AnimationCueTree must be repositioned if those of the children are moved.

virtual void vtkPVAnimationCueTree::SetMoveEndPointsWhenChildrenChange ( int ) [virtual]

Indicates if the endpoints of the timeline controlled by this AnimationCueTree must be repositioned if those of the children are moved.

virtual int vtkPVAnimationCueTree::GetMoveEndPointsWhenChildrenChange ( ) [virtual]

Indicates if the endpoints of the timeline controlled by this AnimationCueTree must be repositioned if those of the children are moved.

virtual void vtkPVAnimationCueTree::GetFocus ( ) [virtual]

This method removes the focus of all children cues and sets the focus of itself.
Reimplemented from vtkPVAnimationCue.

virtual void vtkPVAnimationCueTree::RemoveFocus ( ) [virtual]

Removes the focus from itself and all the children cues.
Reimplemented from vtkPVAnimationCue.

virtual int vtkPVAnimationCueTree::HasFocus ( ) [virtual]

Returns 1 is itself or any of the children cues has the focus.
Reimplemented from vtkPVAnimationCue.

virtual void vtkPVAnimationCueTree::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 and all the children cues.
Reimplemented from vtkPVAnimationCue.

virtual void vtkPVAnimationCueTree::StartRecording ( ) [virtual]

Start Recording.
Reimplemented from vtkPVAnimationCue.

virtual void vtkPVAnimationCueTree::StopRecording ( ) [virtual]

Stop Recording.
Reimplemented from vtkPVAnimationCue.

virtual void vtkPVAnimationCueTree::RecordState ( double ntime,

double offset

) [virtual]

Calls RecordState on all the children cues.
Reimplemented from vtkPVAnimationCue.

virtual void vtkPVAnimationCueTree::RecordState ( double ntime,

double offset,

int onlyFocus

) [virtual]

Calls RecordState on all the children cues.
Reimplemented from vtkPVAnimationCue.

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

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

Reimplemented from vtkPVAnimationCue.

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

Reimplemented from vtkPVAnimationCue.

virtual void vtkPVAnimationCueTree::RemoveAllKeyFrames ( ) [virtual]

Remove All Key frames from this cue.
Reimplemented from vtkPVAnimationCue.

virtual void vtkPVAnimationCueTree::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 from vtkPVAnimationCue.

virtual void vtkPVAnimationCueTree::Detach ( ) [virtual]

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

virtual void vtkPVAnimationCueTree::ExecuteEvent ( vtkObject * wdg,

unsigned long event,

void * calldata

) [protected, virtual]

Reimplemented from vtkPVAnimationCue.

void vtkPVAnimationCueTree::DrawChildConnections ( vtkPVAnimationCue * child ) [protected]

virtual void vtkPVAnimationCueTree::SetLastParameterBounds ( double ,

double

) [protected, virtual]

void vtkPVAnimationCueTree::SetLastParameterBounds ( double [2] ) [protected]

void vtkPVAnimationCueTree::ScaleChildren ( double old_bounds[2],

double new_bounds[2]

) [protected]

void vtkPVAnimationCueTree::RemoveChildrenFocus ( vtkPVAnimationCue * exception = NULL ) [protected]

void vtkPVAnimationCueTree::AdjustEndPoints ( ) [protected]

Member Data Documentation

int vtkPVAnimationCueTree::Expanded [protected]

Definition at line 156 of file vtkPVAnimationCueTree.h.

vtkCollection* vtkPVAnimationCueTree::Children [protected]

Definition at line 157 of file vtkPVAnimationCueTree.h.

vtkKWFrame* vtkPVAnimationCueTree::NavigatorContainer [protected]

Definition at line 159 of file vtkPVAnimationCueTree.h.

vtkKWCanvas* vtkPVAnimationCueTree::NavigatorCanvas [protected]

Definition at line 160 of file vtkPVAnimationCueTree.h.

vtkKWFrame* vtkPVAnimationCueTree::NavigatorChildrenFrame [protected]

Definition at line 161 of file vtkPVAnimationCueTree.h.

vtkKWFrame* vtkPVAnimationCueTree::TimeLineChildrenFrame [protected]

Definition at line 163 of file vtkPVAnimationCueTree.h.

double vtkPVAnimationCueTree::LastParameterBounds[2] [protected]

Definition at line 170 of file vtkPVAnimationCueTree.h.

int vtkPVAnimationCueTree::ScaleChildrenOnEndPointsChange [protected]

Definition at line 175 of file vtkPVAnimationCueTree.h.

int vtkPVAnimationCueTree::MoveEndPointsWhenChildrenChange [protected]

Definition at line 176 of file vtkPVAnimationCueTree.h.

int vtkPVAnimationCueTree::ForceBounds [protected]

Definition at line 180 of file vtkPVAnimationCueTree.h.

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

GUI/Client/vtkPVAnimationCueTree.h

Generated on Tue May 30 12:34:47 2006 for ParaView by

1.3.5

vtkPVAnimationCueTree Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation