MapperGlyphBase.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_MapperGlyphBase_h
#define viskores_rendering_MapperGlyphBase_h
 
#include <viskores/Deprecated.h>
#include <viskores/cont/ColorTable.h>
#include <viskores/rendering/Camera.h>
#include <viskores/rendering/Mapper.h>
 
#include <memory>
 
namespace viskores
{
namespace rendering
{
 
class CanvasRayTracer;
 
class VISKORES_RENDERING_EXPORT MapperGlyphBase : public Mapper
{
public:
  MapperGlyphBase();
 
  virtual ~MapperGlyphBase();
 
  void SetCanvas(viskores::rendering::Canvas* canvas) override;
  virtual viskores::rendering::Canvas* GetCanvas() const override;
 
  virtual viskores::cont::Field::Association GetAssociation() const;
  virtual void SetAssociation(viskores::cont::Field::Association association);
  virtual bool GetUseCells() const;
  virtual void SetUseCells();
  virtual bool GetUsePoints() const;
  virtual void SetUsePoints();
  VISKORES_DEPRECATED(2.2, "Use GetUsePoints() or GetAssociation().")
  virtual bool GetUseNodes() const;
  VISKORES_DEPRECATED(2.2, "Use SetUsePoints() or SetAssociation().")
  virtual void SetUseNodes();
 
  // These options do not seem to be supported yet.
  // I'm not sure why you would need UseStride. Just use Stride = 1.
  virtual bool GetUseStride() const;
  virtual void SetUseStride(bool on);
  virtual viskores::Id GetStride() const;
  virtual void SetStride(viskores::Id stride);
 
  virtual viskores::Float32 GetBaseSize() const;
  virtual void SetBaseSize(viskores::Float32 size);
 
  virtual bool GetScaleByValue() const;
  virtual void SetScaleByValue(bool on);
 
  virtual viskores::Float32 GetScaleDelta() const;
  virtual void SetScaleDelta(viskores::Float32 delta);
 
  virtual void SetCompositeBackground(bool on);
 
protected:
  virtual viskores::cont::DataSet FilterPoints(const viskores::cont::UnknownCellSet& cellSet,
                                               const viskores::cont::CoordinateSystem& coords,
                                               const viskores::cont::Field& scalarField) const;
 
 
  viskores::rendering::CanvasRayTracer* Canvas = nullptr;
  bool CompositeBackground = true;
 
  viskores::cont::Field::Association Association = viskores::cont::Field::Association::Points;
 
  bool UseStride = false;
  viskores::Id Stride = 1;
 
  bool ScaleByValue = false;
  viskores::Float32 BaseSize = -1.f;
  viskores::Float32 ScaleDelta = 0.5f;
};
}
} //namespace viskores::rendering
 
#endif //viskores_rendering_MapperGlyphBase_h