vtkKWSimpleAnimationWidget Class Reference

a simple animation widget More...

#include <vtkKWSimpleAnimationWidget.h>

Inheritance diagram for vtkKWSimpleAnimationWidget:

[legend]

Collaboration diagram for vtkKWSimpleAnimationWidget:

[legend]

List of all members.

Public Types
typedef vtkKWCompositeWidget	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetSliceSetCommand (vtkObject *object, const char *method)
virtual void	SetSliceGetCommand (vtkObject *object, const char *method)
virtual void	Update ()
virtual void	UpdateEnableState ()
Static Public Member Functions
static vtkKWSimpleAnimationWidget *	New ()
static int	IsTypeOf (const char *type)
static vtkKWSimpleAnimationWidget *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWSimpleAnimationWidget ()
	~vtkKWSimpleAnimationWidget ()
virtual void	CreateWidget ()
virtual void	InvokeSliceSetCommand (int)
virtual int	InvokeSliceGetCommand ()
virtual void	InvokeSlicePostAnimationCommand ()
virtual void	InvokeCameraPostAnimationCommand ()
virtual void	FixAnimationSize (const char *filename, int *width, int *height)
Protected Attributes
vtkKWRenderWidget *	RenderWidget
vtkKWScaleWithEntrySet *	Parameters
vtkKWPushButtonSet *	AnimationButtonSet
vtkKWLabelWithLabel *	HelpLabel
int	AnimationType
char *	CameraPostAnimationCommand
char *	SlicePostAnimationCommand
char *	SliceGetCommand
char *	SliceSetCommand
enum	{ AnimationTypeCamera = 0, AnimationTypeSlice }
enum	{   AnimationDone = 0, AnimationPreviewing = 1, AnimationCreating = 2, AnimationCanceled = 4,   AnimationFailed = 8 }
int	AnimationStatus
virtual vtkKWRenderWidget *	GetRenderWidget ()
virtual void	SetRenderWidget (vtkKWRenderWidget *)
virtual void	SetMaximumNumberOfFrames (int max)
virtual void	SetNumberOfFrames (int val)
virtual void	SetAnimationType (int)
virtual int	GetAnimationType ()
virtual void	SetAnimationTypeToCamera ()
virtual void	SetAnimationTypeToSlice ()
virtual void	SetSliceRange (int min, int max)
virtual void	SetSliceRange (const int range[2])
virtual void	SetSlicePostAnimationCommand (vtkObject *object, const char *method)
virtual void	SetXStart (double val)
virtual void	SetXRotation (double val)
virtual void	SetYStart (double val)
virtual void	SetYRotation (double val)
virtual void	SetZStart (double val)
virtual void	SetZRotation (double val)
virtual void	SetZoomStart (double val)
virtual void	SetZoomFactor (double val)
virtual void	SetCameraPostAnimationCommand (vtkObject *object, const char *method)
virtual void	PreviewCameraAnimation ()
virtual void	CreateCameraAnimation (const char *filename, int width, int height, int fps, const char *fourcc)
virtual void	PreviewSliceAnimation ()
virtual void	CreateSliceAnimation (const char *filename, int width, int height, int fps, const char *fourcc)
virtual void	PreviewAnimationCallback ()
virtual void	CreateAnimationCallback ()
virtual void	CancelAnimationCallback ()
virtual void	DisableButtonsButCancel ()
virtual void	EnableButtonsButCancel ()

---

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 Typedef Documentation

typedef vtkKWCompositeWidget vtkKWSimpleAnimationWidget::Superclass

Reimplemented from vtkKWCompositeWidget.

Definition at line 48 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

Enumerator:

AnimationTypeCamera
AnimationTypeSlice

Definition at line 70 of file vtkKWSimpleAnimationWidget.h.

anonymous enum [protected]

Animation status BTX

Enumerator:

AnimationDone
AnimationPreviewing
AnimationCreating
AnimationCanceled
AnimationFailed

Definition at line 210 of file vtkKWSimpleAnimationWidget.h.

---

Constructor & Destructor Documentation

vtkKWSimpleAnimationWidget::vtkKWSimpleAnimationWidget

(

)

[protected]

vtkKWSimpleAnimationWidget::~vtkKWSimpleAnimationWidget

(

)

[protected]

---

Member Function Documentation

static vtkKWSimpleAnimationWidget* vtkKWSimpleAnimationWidget::New

(

)

[static]

Reimplemented from vtkKWCompositeWidget.

virtual const char* vtkKWSimpleAnimationWidget::GetClassName

(

)

[virtual]

Reimplemented from vtkKWCompositeWidget.

static int vtkKWSimpleAnimationWidget::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkKWCompositeWidget.

virtual int vtkKWSimpleAnimationWidget::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkKWCompositeWidget.

static vtkKWSimpleAnimationWidget* vtkKWSimpleAnimationWidget::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkKWCompositeWidget.

void vtkKWSimpleAnimationWidget::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			[virtual]

Reimplemented from vtkKWCompositeWidget.

virtual vtkKWRenderWidget* vtkKWSimpleAnimationWidget::GetRenderWidget

(

)

[virtual]

Set/Get the renderwidget to perform the animation on. It is not ref-counted.

virtual void vtkKWSimpleAnimationWidget::SetRenderWidget

(

vtkKWRenderWidget *

)

[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::SetMaximumNumberOfFrames

(

int

max

)

[virtual]

Set the number of frames and maximum number of frames

virtual void vtkKWSimpleAnimationWidget::SetNumberOfFrames

(

int

val

)

[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::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

(

)

[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::SetAnimationTypeToSlice

(

)

[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::SetSliceRange	(	int	min,
		int	max
	)			[virtual]

Set the slice range (i.e. the indices of the first and last slices available in the animation, when the animation type is Slice).

virtual void vtkKWSimpleAnimationWidget::SetSliceRange

(

const int

range[2]

)

[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 86 of file vtkKWSimpleAnimationWidget.h.

virtual void vtkKWSimpleAnimationWidget::SetSliceSetCommand	(	vtkObject *	object,
		const char *	method
	)			[virtual]

Set the command to invoke to set the slice value on an external source when the animation is in 'slice' mode. This command is mandatory for the slice animation to work. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command. The following parameters are also passed to the command: - the slice value: int

virtual void vtkKWSimpleAnimationWidget::SetSliceGetCommand	(	vtkObject *	object,
		const char *	method
	)			[virtual]

Set the command to invoke to get the slice value from an external source when the animation is in 'slice' mode. 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. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command. The following output is expected from the command: - the slice value: int

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. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command.

virtual void vtkKWSimpleAnimationWidget::SetXStart

(

double

val

)

[virtual]

Set the X start and total rotation.

virtual void vtkKWSimpleAnimationWidget::SetXRotation

(

double

val

)

[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::SetYStart

(

double

val

)

[virtual]

Set the Y start and total rotation.

virtual void vtkKWSimpleAnimationWidget::SetYRotation

(

double

val

)

[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::SetZStart

(

double

val

)

[virtual]

Set the Z start and total rotation.

virtual void vtkKWSimpleAnimationWidget::SetZRotation

(

double

val

)

[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::SetZoomStart

(

double

val

)

[virtual]

Set the zoom start and factor.

virtual void vtkKWSimpleAnimationWidget::SetZoomFactor

(

double

val

)

[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::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. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command.

virtual void vtkKWSimpleAnimationWidget::PreviewCameraAnimation

(

)

[virtual]

Preview and create camera animation

virtual void vtkKWSimpleAnimationWidget::CreateCameraAnimation	(	const char *	filename,
		int	width,
		int	height,
		int	fps,
		const char *	fourcc
	)			[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::PreviewSliceAnimation

(

)

[virtual]

Preview and create slice animation

virtual void vtkKWSimpleAnimationWidget::CreateSliceAnimation	(	const char *	filename,
		int	width,
		int	height,
		int	fps,
		const char *	fourcc
	)			[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::Update

(

)

[virtual]

Update the whole UI depending on the value of the Ivars

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::PreviewAnimationCallback

(

)

[virtual]

Callbacks. Internal, do not use.

virtual void vtkKWSimpleAnimationWidget::CreateAnimationCallback

(

)

[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::CancelAnimationCallback

(

)

[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::CreateWidget

(

)

[protected, virtual]

Create the widget.

Reimplemented from vtkKWCompositeWidget.

virtual void vtkKWSimpleAnimationWidget::InvokeSliceSetCommand

(

int

)

[protected, virtual]

virtual int vtkKWSimpleAnimationWidget::InvokeSliceGetCommand

(

)

[protected, virtual]

virtual void vtkKWSimpleAnimationWidget::InvokeSlicePostAnimationCommand

(

)

[protected, virtual]

virtual void vtkKWSimpleAnimationWidget::InvokeCameraPostAnimationCommand

(

)

[protected, virtual]

virtual void vtkKWSimpleAnimationWidget::FixAnimationSize	(	const char *	filename,
		int *	width,
		int *	height
	)			[protected, virtual]

Fix animation size

virtual void vtkKWSimpleAnimationWidget::DisableButtonsButCancel

(

)

[protected, virtual]

Enable/disable animation buttons

virtual void vtkKWSimpleAnimationWidget::EnableButtonsButCancel

(

)

[protected, 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

---

Member Data Documentation

vtkKWRenderWidget* vtkKWSimpleAnimationWidget::RenderWidget [protected]

Definition at line 198 of file vtkKWSimpleAnimationWidget.h.

vtkKWScaleWithEntrySet* vtkKWSimpleAnimationWidget::Parameters [protected]

Definition at line 202 of file vtkKWSimpleAnimationWidget.h.

vtkKWPushButtonSet* vtkKWSimpleAnimationWidget::AnimationButtonSet [protected]

Definition at line 203 of file vtkKWSimpleAnimationWidget.h.

vtkKWLabelWithLabel* vtkKWSimpleAnimationWidget::HelpLabel [protected]

Definition at line 204 of file vtkKWSimpleAnimationWidget.h.

int vtkKWSimpleAnimationWidget::AnimationType [protected]

Definition at line 206 of file vtkKWSimpleAnimationWidget.h.

int vtkKWSimpleAnimationWidget::AnimationStatus [protected]

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 219 of file vtkKWSimpleAnimationWidget.h.

char* vtkKWSimpleAnimationWidget::CameraPostAnimationCommand [protected]

Definition at line 222 of file vtkKWSimpleAnimationWidget.h.

char* vtkKWSimpleAnimationWidget::SlicePostAnimationCommand [protected]

Definition at line 223 of file vtkKWSimpleAnimationWidget.h.

char* vtkKWSimpleAnimationWidget::SliceGetCommand [protected]

Definition at line 224 of file vtkKWSimpleAnimationWidget.h.

char* vtkKWSimpleAnimationWidget::SliceSetCommand [protected]

Definition at line 225 of file vtkKWSimpleAnimationWidget.h.

---

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

• vtkKWSimpleAnimationWidget.h