vtkPainter.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkPainter.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.

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

/*
 * Copyright 2004 Sandia Corporation.
 * Under the terms of Contract DE-AC04-94AL85000, there is a non-exclusive
 * license for use of this work by or on behalf of the
 * U.S. Government. Redistribution and use in source and binary forms, with
 * or without modification, are permitted provided that this Notice and any
 * statement of authorship are reproduced on all copies.
 */

#ifndef vtkPainter_h
#define vtkPainter_h

#include "vtkRenderingOpenGLModule.h" // For export macro
#include "vtkObject.h"
#include "vtkWeakPointer.h" // needed for vtkWeakPointer.

class vtkAbstractArray;
class vtkActor;
class vtkDataObject;
class vtkDataSet;
class vtkInformation;
class vtkInformationIntegerKey;
class vtkPainterObserver;
class vtkRenderer;
class vtkTimerLog;
class vtkWindow;

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

  static vtkInformationIntegerKey* STATIC_DATA();

  static vtkInformationIntegerKey* CONSERVE_MEMORY();

  static vtkInformationIntegerKey* HIGH_QUALITY();


  vtkGetObjectMacro(Information, vtkInformation);
  virtual void SetInformation(vtkInformation*);


  vtkGetObjectMacro(DelegatePainter, vtkPainter);
  virtual void SetDelegatePainter(vtkPainter*);


  void Register(vtkObjectBase *o) VTK_OVERRIDE;
  void UnRegister(vtkObjectBase *o) VTK_OVERRIDE;

  enum {
    VERTS = 0x1,
    LINES = 0x2,
    POLYS = 0x4,
    STRIPS = 0x8
  };

  virtual void Render(vtkRenderer* renderer, vtkActor* actor,
                      unsigned long typeflags, bool forceCompileOnly);

  virtual void ReleaseGraphicsResources(vtkWindow *);


  vtkSetClampMacro(Progress,double,0.0,1.0);
  vtkGetMacro(Progress,double);

  virtual double GetTimeToDraw();

  virtual void UpdateBounds(double bounds[6]);


  void SetInput(vtkDataObject*);
  vtkGetObjectMacro(Input, vtkDataObject);

  virtual vtkDataObject* GetOutput()
    { return this->Input; }

protected:
  vtkPainter();
  ~vtkPainter();

  void ReportReferences(vtkGarbageCollector *collector) VTK_OVERRIDE;

  void UpdateDelegatePainter();

  virtual void PassInformation(vtkPainter* toPainter);

  virtual void PrepareForRendering(vtkRenderer*, vtkActor*) { }

  virtual void RenderInternal(vtkRenderer* renderer, vtkActor* actor,
                              unsigned long typeflags, bool forceCompileOnly);

  virtual void UpdateDelegateProgress(vtkPainter* delegate, double amount);

  virtual void ProcessInformation(vtkInformation*) { }

  virtual void ObserverPainterProgress(vtkPainter* toObserve);

  void UpdateProgress(double amount);


  vtkAbstractArray* GetInputArrayToProcess(int fieldAssociation,
    int fieldAttributeType,
    vtkDataSet* ds,
    bool *use_cell_data=0);
  vtkAbstractArray* GetInputArrayToProcess(int fieldAssociation,
    const char* name, vtkDataSet* dsl,
    bool *use_cell_data=0);

  // Time of most recent call to ProcessInformation().
  vtkTimeStamp InformationProcessTime;
  friend class vtkPainterObserver;
  vtkPainterObserver* Observer;

  vtkInformation* Information;
  vtkPainter* DelegatePainter;

  double Progress;
  double ProgressOffset;
  double ProgressScaleFactor;

  double TimeToDraw;
  vtkTimerLog* Timer;


  vtkWeakPointer<vtkWindow> LastWindow; // Window used for previous render.
                         // This is not reference counted.
private:
  vtkPainter(const vtkPainter &) VTK_DELETE_FUNCTION;
  void operator=(const vtkPainter &) VTK_DELETE_FUNCTION;

  vtkDataObject* Input;

};

#endif //vtkPainter_h