/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkCameraWidget.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
// .NAME vtkCameraWidget - 2D widget for saving a series of camera views
// .SECTION Description
// This class provides support for interactively saving a series of camera
// views into an interpolated path (using vtkCameraInterpolator). To use the
// class start by specifying a camera to interpolate, and then simply start
// recording by hitting the "record" button, manipulate the camera (by using
// an interactor, direct scripting, or any other means), and then save the
// camera view. Repeat this process to record a series of views.  The user
// can then play back interpolated camera views using the
// vtkCameraInterpolator.

// .SECTION See Also
// vtkBorderWidget vtkCameraInterpolator


#ifndef vtkCameraWidget_h
#define vtkCameraWidget_h

#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkBorderWidget.h"

class vtkCameraRepresentation;


class VTKINTERACTIONWIDGETS_EXPORT vtkCameraWidget : public vtkBorderWidget
{
public:
  // Description:
  // Instantiate this class.
  static vtkCameraWidget *New();

  // Description:
  // Standar VTK class methods.
  vtkTypeMacro(vtkCameraWidget,vtkBorderWidget);
  void PrintSelf(ostream& os, vtkIndent indent);

  // Description:
  // Specify an instance of vtkWidgetRepresentation used to represent this
  // widget in the scene. Note that the representation is a subclass of vtkProp
  // so it can be added to the renderer independent of the widget.
  void SetRepresentation(vtkCameraRepresentation *r)
    {this->Superclass::SetWidgetRepresentation(reinterpret_cast<vtkWidgetRepresentation*>(r));}

  // Description:
  // Create the default widget representation if one is not set.
  void CreateDefaultRepresentation();

protected:
  vtkCameraWidget();
  ~vtkCameraWidget();

  // Description:
  // When selecting the interior of this widget, special operations occur
  // (i.e., adding a camera view, deleting a path, animating a path). Thus
  // this methods overrides the superclasses' method.
  virtual void SelectRegion(double eventPos[2]);

private:
  vtkCameraWidget(const vtkCameraWidget&);  //Not implemented
  void operator=(const vtkCameraWidget&);  //Not implemented
};

#endif
