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

  Program:   Visualization Toolkit
  Module:    vtkCameraActor.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 vtkCameraActor - a frustum to represent a camera.
// .SECTION Description
// vtkCameraActor is an actor used to represent a camera by its wireframe
// frustum.

// .SECTION See Also
// vtkLight vtkConeSource vtkFrustumSource vtkCameraActor

#ifndef vtkCameraActor_h
#define vtkCameraActor_h

#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkProp3D.h"

class vtkCamera;
class vtkFrustumSource;
class vtkPolyDataMapper;
class vtkActor;
class vtkProperty;

class VTKRENDERINGCORE_EXPORT vtkCameraActor : public vtkProp3D
{
public:
  static vtkCameraActor *New();
  vtkTypeMacro(vtkCameraActor, vtkProp3D);
  void PrintSelf(ostream& os, vtkIndent indent);

  // Description:
  // The camera to represent. Initial value is NULL.
  void SetCamera(vtkCamera *camera);
  vtkGetObjectMacro(Camera, vtkCamera);

  // Description:
  // Ratio between the width and the height of the frustum. Initial value is
  // 1.0 (square)
  vtkSetMacro(WidthByHeightRatio, double);
  vtkGetMacro(WidthByHeightRatio, double);

  // Description:
  // Support the standard render methods.
  virtual int RenderOpaqueGeometry(vtkViewport *viewport);

  // Description:
  // Does this prop have some translucent polygonal geometry? No.
  virtual int HasTranslucentPolygonalGeometry();

  // Description:
  // Release any graphics resources that are being consumed by this actor.
  // The parameter window could be used to determine which graphic
  // resources to release.
  void ReleaseGraphicsResources(vtkWindow *);

  // Description:
  // Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
  double *GetBounds();

  // Description:
  // Get the actors mtime plus consider its properties and texture if set.
  unsigned long int GetMTime();

  // Description:
  // Get property of the internal actor.
  vtkProperty *GetProperty();

  // Description:
  // Set property of the internal actor.
  void SetProperty(vtkProperty *p);

protected:
  vtkCameraActor();
  ~vtkCameraActor();

  void UpdateViewProps();

  vtkCamera *Camera;
  double WidthByHeightRatio;

  vtkFrustumSource *FrustumSource;
  vtkPolyDataMapper *FrustumMapper;
  vtkActor *FrustumActor;

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

#endif
