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

  Program:   Visualization Toolkit
  Module:    vtkContextDevice3D.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 vtkContextDevice3D - Abstract class for drawing 3D primitives.
//
// .SECTION Description
// This defines the interface for a vtkContextDevice3D. In this sense a
// ContextDevice is a class used to paint 3D primitives onto a device, such as
// an OpenGL context.
//
// This is private API, and should not be used outside of the vtkContext3D.

#ifndef vtkContextDevice3D_h
#define vtkContextDevice3D_h

#include "vtkRenderingContext2DModule.h" // For export macro
#include "vtkObject.h"
#include "vtkVector.h"       // For the vector coordinates.
#include "vtkRect.h"         // For the rectangles..

class vtkMatrix4x4;
class vtkViewport;
class vtkPen;
class vtkBrush;

class VTKRENDERINGCONTEXT2D_EXPORT vtkContextDevice3D : public vtkObject
{
public:
  vtkTypeMacro(vtkContextDevice3D, vtkObject);
  virtual void PrintSelf(ostream &os, vtkIndent indent);

  static vtkContextDevice3D * New();

  // Description:
  // Draw a polyline between the specified points.
  // \sa DrawLines()
  virtual void DrawPoly(const float *verts, int n,
                        const unsigned char *colors = 0, int nc = 0) = 0;

  // Description:
  // Draw lines defined by specified pair of points.
  // \sa DrawPoly()
  virtual void DrawLines(const float *verts, int n,
                         const unsigned char *colors = 0, int nc = 0) = 0;

  // Description:
  // Draw points at the vertex positions specified.
  virtual void DrawPoints(const float *verts, int n,
                          const unsigned char *colors = 0, int nc = 0) = 0;

  // Description:
  // Draw triangles to generate the specified mesh.
  virtual void DrawTriangleMesh(const float *mesh, int n,
                                const unsigned char *colors, int nc) = 0;

  // Description:
  // Apply the supplied pen which controls the outlines of shapes, as well as
  // lines, points and related primitives. This makes a deep copy of the vtkPen
  // object in the vtkContext2D, it does not hold a pointer to the supplied object.
  virtual void ApplyPen(vtkPen *pen) = 0;

  // Description:
  // Apply the supplied brush which controls the outlines of shapes, as well as
  // lines, points and related primitives. This makes a deep copy of the vtkBrush
  // object in the vtkContext2D, it does not hold a pointer to the supplied object.
  virtual void ApplyBrush(vtkBrush *brush) = 0;

  // Description:
  // Set the model view matrix for the display
  virtual void SetMatrix(vtkMatrix4x4 *m) = 0;

  // Description:
  // Set the model view matrix for the display
  virtual void GetMatrix(vtkMatrix4x4 *m) = 0;

  // Description:
  // Multiply the current model view matrix by the supplied one
  virtual void MultiplyMatrix(vtkMatrix4x4 *m) = 0;

  // Description:
  // Push the current matrix onto the stack.
  virtual void PushMatrix() = 0;

  // Description:
  // Pop the current matrix off of the stack.
  virtual void PopMatrix() = 0;

  // Description:
  // Supply a float array of length 4 with x1, y1, width, height specifying
  // clipping region for the device in pixels.
  virtual void SetClipping(const vtkRecti &rect) = 0;

  // Description:
  // Disable clipping of the display.
  // Remove in a future release - retained for API compatibility.
  virtual void DisableClipping() { this->EnableClipping(false); }

  // Description:
  // Enable or disable the clipping of the scene.
  virtual void EnableClipping(bool enable) = 0;

  // Description:
  // Enable/Disable the specified clipping plane.
  virtual void EnableClippingPlane(int i, double *planeEquation) = 0;
  virtual void DisableClippingPlane(int i) = 0;

protected:
  vtkContextDevice3D();
  ~vtkContextDevice3D();

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

#endif
