vtkViewport.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    $RCSfile: vtkViewport.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.

=========================================================================*/
#ifndef __vtkViewport_h
#define __vtkViewport_h

#include "vtkObject.h"

class vtkActor2DCollection;
class vtkAssemblyPath;
class vtkProp;
class vtkPropCollection;
class vtkWindow;

class VTK_FILTERING_EXPORT vtkViewport : public vtkObject
{
public:
  vtkTypeRevisionMacro(vtkViewport,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);

  void AddProp(vtkProp *);

  vtkPropCollection *GetProps() {return this->Props;};

  int HasProp(vtkProp *);

  void RemoveProp(vtkProp *);

  void RemoveAllProps(void);


  void AddActor2D(vtkProp* p) {this->AddProp(p);};
  void RemoveActor2D(vtkProp* p);
  vtkActor2DCollection *GetActors2D();


  vtkSetVector3Macro(Background,double);
  vtkGetVector3Macro(Background,double);


  vtkSetVector2Macro(Aspect,double);
  vtkGetVectorMacro(Aspect,double,2);
  virtual void ComputeAspect();
  

  vtkSetVector2Macro(PixelAspect,double);
  vtkGetVectorMacro(PixelAspect,double,2);


  vtkSetVector4Macro(Viewport,double);
  vtkGetVectorMacro(Viewport,double,4);


  vtkSetVector3Macro(DisplayPoint,double);
  vtkGetVectorMacro(DisplayPoint,double,3);


  vtkSetVector3Macro(ViewPoint,double);
  vtkGetVectorMacro(ViewPoint,double,3);


  vtkSetVector4Macro(WorldPoint,double);
  vtkGetVectorMacro(WorldPoint,double,4);
   
  virtual double *GetCenter();

  virtual int IsInViewport(int x,int y); 

  virtual vtkWindow *GetVTKWindow() = 0;

  virtual void DisplayToView(); // these get modified in subclasses

  virtual void ViewToDisplay(); // to handle stereo rendering

  virtual void WorldToView();

  virtual void ViewToWorld();

  void DisplayToWorld() {this->DisplayToView(); this->ViewToWorld();};

  void WorldToDisplay() {this->WorldToView(); this->ViewToDisplay();};


  virtual void LocalDisplayToDisplay(double &x, double &y);
  virtual void DisplayToNormalizedDisplay(double &u, double &v);
  virtual void NormalizedDisplayToViewport(double &x, double &y);
  virtual void ViewportToNormalizedViewport(double &u, double &v);
  virtual void NormalizedViewportToView(double &x, double &y, double &z);
  virtual void ViewToWorld(double &, double &, double &) {};
  virtual void DisplayToLocalDisplay(double &x, double &y);
  virtual void NormalizedDisplayToDisplay(double &u, double &v);
  virtual void ViewportToNormalizedDisplay(double &x, double &y);
  virtual void NormalizedViewportToViewport(double &u, double &v);
  virtual void ViewToNormalizedViewport(double &x, double &y, double &z);
  virtual void WorldToView(double &, double &, double &) {};


  int *GetSize();
  int *GetOrigin();
  void GetTiledSize(int *width, int *height);
  void GetTiledSizeAndOrigin(int *width, int *height, 
                             int *lowerLeftX, int *lowerLeftY);
  
  // The following methods describe the public pick interface for picking
  // Props in a viewport.

  virtual vtkAssemblyPath* PickProp(double selectionX, double selectionY) = 0;


  vtkAssemblyPath* PickPropFrom(double selectionX, double selectionY, 
                                vtkPropCollection*);
  

  vtkGetMacro(PickX, double);
  vtkGetMacro(PickY, double);
  vtkGetMacro(IsPicking, int);

  virtual double GetPickedZ() = 0;
  
protected:
  // Create a vtkViewport with a black background, a white ambient light, 
  // two-sided lighting turned on, a viewport of (0,0,1,1), and back face 
  // culling turned off.
  vtkViewport();
  ~vtkViewport();

  //BTX
  // Picking functions to be implemented by sub-classes
  // Perform the main picking loop
  virtual void DevicePickRender() = 0;
  // Enter a pick mode
  virtual void StartPick(unsigned int pickFromSize) = 0;
  // Set the pick id to the next id before drawing an object
  virtual void UpdatePickId() = 0;
  // Exit Pick mode
  virtual void DonePick() = 0; 
  // Return the id of the picked object, only valid after a call to DonePick
  virtual unsigned int GetPickedId() = 0;
  //ETX

  // Ivars for picking
  // Store a picked Prop (contained in an assembly path)
  vtkAssemblyPath* PickedProp;
  vtkPropCollection* PickFromProps;
  // Boolean flag to determine if picking is enabled for this render
  int IsPicking;
  unsigned int CurrentPickId;
  double PickX;
  double PickY;
  // End Ivars for picking
  
  vtkPropCollection *Props;
  vtkActor2DCollection *Actors2D;
  vtkWindow *VTKWindow;
  double Background[3];  
  double Viewport[4];
  double Aspect[2];
  double PixelAspect[2];
  double Center[2];

  int Size[2];
  int Origin[2];
  double DisplayPoint[3];
  double ViewPoint[3];
  double WorldPoint[4];

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



#endif

Generated on Tue Oct 5 08:39:01 2004 for VTK by Doxygen 1.3.8-20040913