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 "vtkObject.h"
#include "vtkRenderingSceneGraphModule.h" // For export macro
#include "vtkWeakPointer.h"               //avoid ref loop to parent
#include <list>                           // for ivar
#include <map>                            // for ivar
 
class vtkCollection;
class vtkViewNodeFactory;
 
class VTKRENDERINGSCENEGRAPH_EXPORT vtkViewNode : public vtkObject
{
public:
  vtkTypeMacro(vtkViewNode, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  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 std::list<vtkViewNode*> const& GetChildren() { return this->Children; }
 
 
  virtual void SetMyFactory(vtkViewNodeFactory*);
  vtkGetObjectMacro(MyFactory, vtkViewNodeFactory);
 
  vtkViewNode* GetViewNodeFor(vtkObject*);
 
  vtkViewNode* GetFirstAncestorOfType(const char* type);
 
  vtkViewNode* GetFirstChildOfType(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() override;
 
  static const char* operation_type_strings[];
 
  virtual void Apply(int operation, bool prepass);
 
 
  void AddMissingNode(vtkObject* obj);
  void AddMissingNodes(vtkCollection* col);
 
 
  void PrepareNodes();
 
  void RemoveUnusedNodes();
 
  virtual vtkViewNode* CreateViewNode(vtkObject* obj);
 
  vtkObject* Renderable;
  vtkWeakPointer<vtkViewNode> Parent;
  std::list<vtkViewNode*> Children;
  vtkViewNodeFactory* MyFactory;
  std::map<vtkObject*, vtkViewNode*> Renderables;
  friend class vtkViewNodeFactory;
 
  // used in the prepare/add/remove opertions
  bool Used;
 
private:
  vtkViewNode(const vtkViewNode&) = delete;
  void operator=(const vtkViewNode&) = delete;
};
 
#endif