vtkKWSimpleAnimationWidget Class Reference

a simple animation widget More...

#include <vtkKWSimpleAnimationWidget.h>

Inheritance diagram for vtkKWSimpleAnimationWidget:

[legend]Collaboration diagram for vtkKWSimpleAnimationWidget:


[NOHEADER]
enum	{ AnimationTypeCamera = 0, AnimationTypeSlice }
virtual void	SetAnimationType (int)
virtual int	GetAnimationType ()
virtual void	SetAnimationTypeToCamera ()
virtual void	SetAnimationTypeToSlice ()
[NOHEADER]
enum	{ AnimationStopped = 0, AnimationPreviewing, AnimationCreating, AnimationCancelled }
int	AnimationStatus
Public Types
Public Member Functions
	vtkTypeRevisionMacro (vtkKWSimpleAnimationWidget, vtkKWCompositeWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *app)
virtual void	Update ()
virtual void	UpdateEnableState ()

virtual vtkKWRenderWidget *	GetRenderWidget ()
virtual void	SetRenderWidget (vtkKWRenderWidget *)

virtual void	SetSliceSetCommand (vtkObject object, const char method)
virtual void	InvokeSliceSetCommand (int)

virtual void	SetSliceGetCommand (vtkObject object, const char method)
virtual int	InvokeSliceGetCommand ()

virtual void	SetSliceGetMinAndMaxCommands (vtkObject object, const char get_min_method, const char *get_max_method)
virtual int	InvokeSliceGetMinCommand ()
virtual int	InvokeSliceGetMaxCommand ()

virtual void	SetSlicePostAnimationCommand (vtkObject object, const char method)
virtual void	InvokeSlicePostAnimationCommand ()

virtual void	SetCameraPostAnimationCommand (vtkObject object, const char method)
virtual void	InvokeCameraPostAnimationCommand ()

virtual void	PreviewAnimationCallback ()
virtual void	CreateAnimationCallback ()
virtual void	CancelAnimationCallback ()
Static Public Member Functions
vtkKWSimpleAnimationWidget *	New ()
Protected Types
Protected Member Functions
	vtkKWSimpleAnimationWidget ()
	~vtkKWSimpleAnimationWidget ()

virtual void	PreviewCameraAnimation ()
virtual void	CreateCameraAnimation (const char file_root, const char ext, int width, int height)
virtual void	PerformCameraAnimation (const char file_root, const char ext, int width, int height)

virtual void	PreviewSliceAnimation ()
virtual void	CreateSliceAnimation (const char file_root, const char ext, int width, int height)
virtual void	PerformSliceAnimation (const char file_root, const char ext, int width, int height)

virtual void	DisableButtonsButCancel ()
virtual void	EnableButtonsButCancel ()
Protected Attributes
vtkKWRenderWidget *	RenderWidget
vtkKWScaleWithEntrySet *	Parameters
vtkKWPushButtonSet *	AnimationButtonSet
vtkKWLabelWithLabel *	HelpLabel
int	AnimationType
char *	CameraPostAnimationCommand
char *	SlicePostAnimationCommand
char *	SliceGetCommand
char *	SliceGetMinCommand
char *	SliceGetMaxCommand
char *	SliceSetCommand

Detailed Description

a simple animation widget

This widget provides some simple controls and means to create an animation for either a 3D or a 2D scene. It supports two animation type. The first one, 'Camera' provides a user interface to rotate the camera in the scene. The second one, 'Slice' provides a different user interface to slice through a volume for example (say, display all the slices along the sagittal axis of a medical dataset). No explicit reference is made to the dataset, but callbacks must be set so that this widget can set or get the slice value on the approriate external resource.

Thanks:: This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149. Information on the National Centers for Biomedical Computing can be obtained from http://nihroadmap.nih.gov/bioinformatics.

Definition at line 43 of file vtkKWSimpleAnimationWidget.h.

Member Enumeration Documentation

anonymous enum

Set/Get the animation type. If set to 'camera', the widget will display controls to rotate the camera only the 3-axes. If set to 'slice', the widget will display controls to iterate over a range of slice. It is meant to actually slice through a 3D volume. This 'slice' modes requires several callbacks to be also defined. BTX
Enumeration values:

AnimationTypeCamera

AnimationTypeSlice

Definition at line 65 of file vtkKWSimpleAnimationWidget.h.

anonymous enum [protected]

Animation status BTX
Enumeration values:

AnimationStopped

AnimationPreviewing

AnimationCreating

AnimationCancelled

Definition at line 161 of file vtkKWSimpleAnimationWidget.h.

Constructor & Destructor Documentation

vtkKWSimpleAnimationWidget::vtkKWSimpleAnimationWidget ( ) [protected]

vtkKWSimpleAnimationWidget::~vtkKWSimpleAnimationWidget ( ) [protected]

Member Function Documentation

vtkKWSimpleAnimationWidget* vtkKWSimpleAnimationWidget::New ( ) [static]

Reimplemented from vtkKWCompositeWidget.

vtkKWSimpleAnimationWidget::vtkTypeRevisionMacro ( vtkKWSimpleAnimationWidget ,

vtkKWCompositeWidget

)

void vtkKWSimpleAnimationWidget::PrintSelf ( ostream & os,

vtkIndent indent

)

Reimplemented from vtkKWCompositeWidget.

virtual vtkKWRenderWidget* vtkKWSimpleAnimationWidget::GetRenderWidget ( ) [virtual]

Set/Get the renderwidget to perform the animation on

virtual void vtkKWSimpleAnimationWidget::SetRenderWidget ( vtkKWRenderWidget * ) [virtual]

Set/Get the renderwidget to perform the animation on

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

Create the widget.
Reimplemented from vtkKWCompositeWidget.

virtual void vtkKWSimpleAnimationWidget::SetAnimationType ( int ) [virtual]

Set/Get the animation type. If set to 'camera', the widget will display controls to rotate the camera only the 3-axes. If set to 'slice', the widget will display controls to iterate over a range of slice. It is meant to actually slice through a 3D volume. This 'slice' modes requires several callbacks to be also defined. BTX

virtual int vtkKWSimpleAnimationWidget::GetAnimationType ( ) [virtual]

Set/Get the animation type. If set to 'camera', the widget will display controls to rotate the camera only the 3-axes. If set to 'slice', the widget will display controls to iterate over a range of slice. It is meant to actually slice through a 3D volume. This 'slice' modes requires several callbacks to be also defined. BTX

virtual void vtkKWSimpleAnimationWidget::SetAnimationTypeToCamera ( ) [inline, virtual]

Set/Get the animation type. If set to 'camera', the widget will display controls to rotate the camera only the 3-axes. If set to 'slice', the widget will display controls to iterate over a range of slice. It is meant to actually slice through a 3D volume. This 'slice' modes requires several callbacks to be also defined. BTX
Definition at line 73 of file vtkKWSimpleAnimationWidget.h.
References AnimationTypeCamera.

virtual void vtkKWSimpleAnimationWidget::SetAnimationTypeToSlice ( ) [inline, virtual]

Set/Get the animation type. If set to 'camera', the widget will display controls to rotate the camera only the 3-axes. If set to 'slice', the widget will display controls to iterate over a range of slice. It is meant to actually slice through a 3D volume. This 'slice' modes requires several callbacks to be also defined. BTX
Definition at line 76 of file vtkKWSimpleAnimationWidget.h.
References AnimationTypeSlice.

virtual void vtkKWSimpleAnimationWidget::SetSliceSetCommand ( vtkObject * object,

const char * method

) [virtual]

Set the command to invoke to set the slice value on an external object when the animation is in 'slice' mode. This command is passed an int (the slice value). This command is mandatory for the slice animation to work.

virtual void vtkKWSimpleAnimationWidget::InvokeSliceSetCommand ( int ) [virtual]

Set the command to invoke to set the slice value on an external object when the animation is in 'slice' mode. This command is passed an int (the slice value). This command is mandatory for the slice animation to work.

virtual void vtkKWSimpleAnimationWidget::SetSliceGetCommand ( vtkObject * object,

const char * method

) [virtual]

Set the command to invoke to get the slice value from an external object when the animation is in 'slice' mode. This command should return an int (the slice value). This command is optional for the slice animation to work but will guarantee that the slice is set back to its proper value once the animation has been performed.

virtual int vtkKWSimpleAnimationWidget::InvokeSliceGetCommand ( ) [virtual]

Set the command to invoke to get the slice value from an external object when the animation is in 'slice' mode. This command should return an int (the slice value). This command is optional for the slice animation to work but will guarantee that the slice is set back to its proper value once the animation has been performed.

virtual void vtkKWSimpleAnimationWidget::SetSliceGetMinAndMaxCommands ( vtkObject * object,

const char * get_min_method,

const char * get_max_method

) [virtual]

Set the commands to invoke to get the minimum and maximum value of the slice range from an external object when the animation is in 'slice' mode. These commands should return an int (the min and max). These commands are mandatory for the slice animation to work.

virtual int vtkKWSimpleAnimationWidget::InvokeSliceGetMinCommand ( ) [virtual]

Set the commands to invoke to get the minimum and maximum value of the slice range from an external object when the animation is in 'slice' mode. These commands should return an int (the min and max). These commands are mandatory for the slice animation to work.

virtual int vtkKWSimpleAnimationWidget::InvokeSliceGetMaxCommand ( ) [virtual]

Set the commands to invoke to get the minimum and maximum value of the slice range from an external object when the animation is in 'slice' mode. These commands should return an int (the min and max). These commands are mandatory for the slice animation to work.

virtual void vtkKWSimpleAnimationWidget::SetSlicePostAnimationCommand ( vtkObject * object,

const char * method

) [virtual]

Set a command to be invoked after the slice animation has been created/previewed This command is optional.

virtual void vtkKWSimpleAnimationWidget::InvokeSlicePostAnimationCommand ( ) [virtual]

Set a command to be invoked after the slice animation has been created/previewed This command is optional.

virtual void vtkKWSimpleAnimationWidget::SetCameraPostAnimationCommand ( vtkObject * object,

const char * method

) [virtual]

Set a command to be invoked after the camera animation has been created/previewed This command is optional.

virtual void vtkKWSimpleAnimationWidget::InvokeCameraPostAnimationCommand ( ) [virtual]

Set a command to be invoked after the camera animation has been created/previewed This command is optional.

virtual void vtkKWSimpleAnimationWidget::Update ( ) [virtual]

Update the whole UI depending on the value of the Ivars

virtual void vtkKWSimpleAnimationWidget::PreviewAnimationCallback ( ) [virtual]

Callbacks

virtual void vtkKWSimpleAnimationWidget::CreateAnimationCallback ( ) [virtual]

Callbacks

virtual void vtkKWSimpleAnimationWidget::CancelAnimationCallback ( ) [virtual]

Callbacks

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

virtual void vtkKWSimpleAnimationWidget::PreviewCameraAnimation ( ) [protected, virtual]

Preview and create camera animation

virtual void vtkKWSimpleAnimationWidget::CreateCameraAnimation ( const char * file_root,

const char * ext,

int width,

int height

) [protected, virtual]

Preview and create camera animation

virtual void vtkKWSimpleAnimationWidget::PerformCameraAnimation ( const char * file_root,

const char * ext,

int width,

int height

) [protected, virtual]

Preview and create camera animation

virtual void vtkKWSimpleAnimationWidget::PreviewSliceAnimation ( ) [protected, virtual]

Preview and create slice animation

virtual void vtkKWSimpleAnimationWidget::CreateSliceAnimation ( const char * file_root,

const char * ext,

int width,

int height

) [protected, virtual]

Preview and create slice animation

virtual void vtkKWSimpleAnimationWidget::PerformSliceAnimation ( const char * file_root,

const char * ext,

int width,

int height

) [protected, virtual]

Preview and create slice animation

virtual void vtkKWSimpleAnimationWidget::DisableButtonsButCancel ( ) [protected, virtual]

Enable/disable animation buttons

virtual void vtkKWSimpleAnimationWidget::EnableButtonsButCancel ( ) [protected, virtual]

Enable/disable animation buttons

Member Data Documentation

vtkKWRenderWidget* vtkKWSimpleAnimationWidget::RenderWidget [protected]

Definition at line 149 of file vtkKWSimpleAnimationWidget.h.

vtkKWScaleWithEntrySet* vtkKWSimpleAnimationWidget::Parameters [protected]

Definition at line 153 of file vtkKWSimpleAnimationWidget.h.

vtkKWPushButtonSet* vtkKWSimpleAnimationWidget::AnimationButtonSet [protected]

Definition at line 154 of file vtkKWSimpleAnimationWidget.h.

vtkKWLabelWithLabel* vtkKWSimpleAnimationWidget::HelpLabel [protected]

Definition at line 155 of file vtkKWSimpleAnimationWidget.h.

int vtkKWSimpleAnimationWidget::AnimationType [protected]

Definition at line 157 of file vtkKWSimpleAnimationWidget.h.

int vtkKWSimpleAnimationWidget::AnimationStatus [protected]

Animation status BTX
Definition at line 169 of file vtkKWSimpleAnimationWidget.h.

char* vtkKWSimpleAnimationWidget::CameraPostAnimationCommand [protected]

Definition at line 172 of file vtkKWSimpleAnimationWidget.h.

char* vtkKWSimpleAnimationWidget::SlicePostAnimationCommand [protected]

Definition at line 173 of file vtkKWSimpleAnimationWidget.h.

char* vtkKWSimpleAnimationWidget::SliceGetCommand [protected]

Definition at line 174 of file vtkKWSimpleAnimationWidget.h.

char* vtkKWSimpleAnimationWidget::SliceGetMinCommand [protected]

Definition at line 175 of file vtkKWSimpleAnimationWidget.h.

char* vtkKWSimpleAnimationWidget::SliceGetMaxCommand [protected]

Definition at line 176 of file vtkKWSimpleAnimationWidget.h.

char* vtkKWSimpleAnimationWidget::SliceSetCommand [protected]

Definition at line 177 of file vtkKWSimpleAnimationWidget.h.

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

GUI/Widgets/vtkKWSimpleAnimationWidget.h

Generated on Tue May 30 12:44:13 2006 for ParaView by

1.3.5

vtkKWSimpleAnimationWidget Class Reference

[NOHEADER]

[NOHEADER]

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation