vtkViewNode.h

Go to the documentation of this file.

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

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

=========================================================================*/
#ifndef vtkViewNode_h
#define vtkViewNode_h

#include "vtkRenderingSceneGraphModule.h" // For export macro
#include "vtkWeakPointer.h" //avoid ref loop to parent
#include "vtkObject.h"

class vtkCollection;
class vtkViewNodeFactory;
class vtkViewNodeCollection;

class VTKRENDERINGSCENEGRAPH_EXPORT vtkViewNode :
  public vtkObject
{
public:
  vtkTypeMacro(vtkViewNode, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);


  vtkGetObjectMacro(Renderable, vtkObject);

  virtual void Build(bool /* prepass */) {};

  virtual void Synchronize(bool /* prepass */) {};

  virtual void Render(bool /*prepass*/) {};

  virtual void Invalidate(bool /*prepass*/) {};


  virtual void SetParent(vtkViewNode*);
  virtual vtkViewNode * GetParent();


  virtual void SetChildren(vtkViewNodeCollection*);
  vtkGetObjectMacro(Children, vtkViewNodeCollection);


  virtual void SetMyFactory(vtkViewNodeFactory*);
  vtkGetObjectMacro(MyFactory, vtkViewNodeFactory);

  vtkViewNode* GetViewNodeFor(vtkObject *);

  vtkViewNode *GetFirstAncestorOfType(const char *type);

  virtual void SetRenderable(vtkObject *);

  // if you want to traverse your children in a specific order
  // or way override this method
  virtual void Traverse(int operation);

  virtual void TraverseAllPasses();

  vtkMTimeType RenderTime;

  enum operation_type{noop, build, synchronize, render, invalidate};

protected:
  vtkViewNode();
  ~vtkViewNode();

  static const char* operation_type_strings[];

  void Apply(int operation, bool prepass);


  void AddMissingNode(vtkObject *obj);
  void AddMissingNodes(vtkCollection *col);


  void PrepareNodes();
  vtkCollection *PreparedNodes;

  void RemoveUnusedNodes();

  virtual vtkViewNode *CreateViewNode(vtkObject *obj);

  vtkObject *Renderable;
  vtkWeakPointer<vtkViewNode> Parent;
  vtkViewNodeCollection *Children;
  vtkViewNodeFactory *MyFactory;

  friend class vtkViewNodeFactory;

private:
  vtkViewNode(const vtkViewNode&) VTK_DELETE_FUNCTION;
  void operator=(const vtkViewNode&) VTK_DELETE_FUNCTION;
};

#endif