View.h

Go to the documentation of this file.

//============================================================================
//  The contents of this file are covered by the Viskores license. See
//  LICENSE.txt for details.
//
//  By contributing to this file, all contributors agree to the Developer
//  Certificate of Origin Version 1.1 (DCO 1.1) as stated in DCO.txt.
//============================================================================
 
//============================================================================
//  Copyright (c) Kitware, Inc.
//  All rights reserved.
//  See LICENSE.txt 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 viskores_rendering_View_h
#define viskores_rendering_View_h
 
#include <viskores/rendering/viskores_rendering_export.h>
 
#include <viskores/rendering/Camera.h>
#include <viskores/rendering/Canvas.h>
#include <viskores/rendering/Color.h>
#include <viskores/rendering/Mapper.h>
#include <viskores/rendering/Scene.h>
#include <viskores/rendering/TextAnnotation.h>
 
#include <functional>
#include <memory>
 
namespace viskores
{
namespace rendering
{
 
class VISKORES_RENDERING_EXPORT View
{
  struct InternalData;
 
public:
  View(const viskores::rendering::Scene& scene,
       const viskores::rendering::Mapper& mapper,
       const viskores::rendering::Canvas& canvas,
       const viskores::rendering::Color& backgroundColor = viskores::rendering::Color(0, 0, 0, 1),
       const viskores::rendering::Color& foregroundColor = viskores::rendering::Color(1, 1, 1, 1));
 
  View(const viskores::rendering::Scene& scene,
       const viskores::rendering::Mapper& mapper,
       const viskores::rendering::Canvas& canvas,
       const viskores::rendering::Camera& camera,
       const viskores::rendering::Color& backgroundColor = viskores::rendering::Color(0, 0, 0, 1),
       const viskores::rendering::Color& foregroundColor = viskores::rendering::Color(1, 1, 1, 1));
 
  virtual ~View();
 
  VISKORES_CONT
  const viskores::rendering::Scene& GetScene() const;
  VISKORES_CONT
  viskores::rendering::Scene& GetScene();
  VISKORES_CONT
  void SetScene(const viskores::rendering::Scene& scene);
 
  VISKORES_CONT
  const viskores::rendering::Mapper& GetMapper() const;
  VISKORES_CONT
  viskores::rendering::Mapper& GetMapper();
 
  VISKORES_CONT
  const viskores::rendering::Canvas& GetCanvas() const;
  VISKORES_CONT
  viskores::rendering::Canvas& GetCanvas();
 
  VISKORES_CONT
  const viskores::rendering::WorldAnnotator& GetWorldAnnotator() const;
 
  VISKORES_CONT
  const viskores::rendering::Camera& GetCamera() const;
  VISKORES_CONT
  viskores::rendering::Camera& GetCamera();
  VISKORES_CONT
  void SetCamera(const viskores::rendering::Camera& camera);
 
  VISKORES_CONT
  const viskores::rendering::Color& GetBackgroundColor() const;
  VISKORES_CONT
  void SetBackgroundColor(const viskores::rendering::Color& color);
 
  VISKORES_CONT
  void SetForegroundColor(const viskores::rendering::Color& color);
 
  VISKORES_CONT
  bool GetWorldAnnotationsEnabled() const { return this->WorldAnnotationsEnabled; }
 
  VISKORES_CONT
  void SetWorldAnnotationsEnabled(bool val) { this->WorldAnnotationsEnabled = val; }
 
  VISKORES_CONT void SetRenderAnnotationsEnabled(bool val) { this->RenderAnnotationsEnabled = val; }
  VISKORES_CONT bool GetRenderAnnotationsEnabled() const { return this->RenderAnnotationsEnabled; }
 
  virtual void Paint() = 0;
  virtual void RenderScreenAnnotations() = 0;
  virtual void RenderWorldAnnotations() = 0;
 
  void RenderAnnotations();
 
  void SaveAs(const std::string& fileName) const;
 
  VISKORES_CONT
  void SetAxisColor(viskores::rendering::Color c);
 
  VISKORES_CONT
  void ClearTextAnnotations();
 
  VISKORES_CONT
  void AddTextAnnotation(std::unique_ptr<viskores::rendering::TextAnnotation> ann);
 
  VISKORES_CONT
  void ClearAdditionalAnnotations();
 
  VISKORES_CONT
  void AddAdditionalAnnotation(std::function<void(void)> ann);
 
protected:
  void SetupForWorldSpace(bool viewportClip = true);
 
  void SetupForScreenSpace(bool viewportClip = false);
 
 
  viskores::rendering::Color AxisColor = viskores::rendering::Color::white;
  bool WorldAnnotationsEnabled = true;
  bool RenderAnnotationsEnabled = true;
 
private:
  std::unique_ptr<InternalData> Internal;
};
 
} // namespace viskores::rendering
} // namespace viskores
 
#endif //viskores_rendering_View_h