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

  Program:   Visualization Toolkit
  Module:    $RCSfile: vtkDistanceToCamera.h,v $

  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.

=========================================================================*/
/*-------------------------------------------------------------------------
  Copyright 2008 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
// .NAME vtkDistanceToCamera - calculates distance from points to the camera.
//
// .SECTION Description
// This filter adds a double array containing the distance from each point
// to the camera. If Scaling is on, it will use the values in the input
// array to process in order to scale the size of the points. ScreenSize
// sets the size in screen pixels that you would want a rendered rectangle
// at that point to be, if it was scaled by the output array.

#ifndef __vtkDistanceToCamera_h
#define __vtkDistanceToCamera_h

#include "vtkPolyDataAlgorithm.h"

class vtkRenderer;

class VTK_RENDERING_EXPORT vtkDistanceToCamera : public vtkPolyDataAlgorithm 
{
public:
  static vtkDistanceToCamera *New();
  vtkTypeRevisionMacro(vtkDistanceToCamera,vtkPolyDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent);

  // Description:
  // The renderer which will ultimately render these points.
  void SetRenderer(vtkRenderer* ren);
  vtkGetObjectMacro(Renderer, vtkRenderer);

  // Description:
  // The desired screen size obtained by scaling glyphs by the distance
  // array. It assumes the glyph at each point will be unit size.
  vtkSetMacro(ScreenSize, double);
  vtkGetMacro(ScreenSize, double);

  // Description:
  // Whether to scale the distance by the input array to process.
  vtkSetMacro(Scaling, bool);
  vtkGetMacro(Scaling, bool);
  vtkBooleanMacro(Scaling, bool);
  
  // Description:
  // The modified time of this filter.
  virtual unsigned long GetMTime();

protected:
  vtkDistanceToCamera();
  ~vtkDistanceToCamera();
  
  int RequestData(
    vtkInformation *,
    vtkInformationVector **,
    vtkInformationVector *);

  vtkRenderer* Renderer;
  double ScreenSize;
  bool Scaling;
  int LastRendererSize[2];
  double LastCameraPosition[3];
  double LastCameraFocalPoint[3];
  double LastCameraViewUp[3];
  double LastCameraParallelScale;
  
private:
  vtkDistanceToCamera(const vtkDistanceToCamera&);  // Not implemented.
  void operator=(const vtkDistanceToCamera&);  // Not implemented.
};

#endif
