vtk-m/vtkm/rendering/ConnectivityProxy.h
Kenneth Moreland e051565d96 Use scoped enums in rendering classes
We should try to favor scoped enums over unscoped enums for their
enhanced type safety.
2022-03-17 15:28:11 -06:00

85 lines
3.2 KiB
C++

//============================================================================
// 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 vtk_m_rendering_ConnectivityProxy_h
#define vtk_m_rendering_ConnectivityProxy_h
#include <memory>
#include <vtkm/Deprecated.h>
#include <vtkm/cont/DataSet.h>
#include <vtkm/rendering/CanvasRayTracer.h>
#include <vtkm/rendering/Mapper.h>
#include <vtkm/rendering/View.h>
#include <vtkm/rendering/raytracing/Camera.h>
#include <vtkm/rendering/raytracing/PartialComposite.h>
#include <vtkm/rendering/raytracing/Ray.h>
namespace vtkm
{
namespace rendering
{
using PartialVector64 = std::vector<vtkm::rendering::raytracing::PartialComposite<vtkm::Float64>>;
using PartialVector32 = std::vector<vtkm::rendering::raytracing::PartialComposite<vtkm::Float32>>;
class VTKM_RENDERING_EXPORT ConnectivityProxy
{
public:
ConnectivityProxy(vtkm::cont::DataSet& dataset);
ConnectivityProxy(const vtkm::cont::UnknownCellSet& cellset,
const vtkm::cont::CoordinateSystem& coords,
const vtkm::cont::Field& scalarField);
// Do not allow the default constructor
ConnectivityProxy() = delete;
~ConnectivityProxy();
enum struct RenderMode
{
Volume,
Energy,
VOLUME_MODE VTKM_DEPRECATED(1.8, "Use Volume.") = Volume,
ENERGY_MODE VTKM_DEPRECATED(1.8, "Use Energy.") = Energy
};
VTKM_DEPRECATED(1.8, "Use ConnectivityProxy::RenderMode::Volume")
static constexpr RenderMode VOLUME_MODE = RenderMode::Volume;
VTKM_DEPRECATED(1.8, "Use ConnectivityProxy::RenderMode::Energy")
static constexpr RenderMode ENERGY_MODE = RenderMode::Energy;
void SetRenderMode(RenderMode mode);
void SetSampleDistance(const vtkm::Float32&);
void SetCanvas(vtkm::rendering::Canvas* canvas);
void SetScalarField(const std::string& fieldName);
void SetEmissionField(const std::string& fieldName);
void SetCamera(const vtkm::rendering::Camera& camera);
void SetScalarRange(const vtkm::Range& range);
void SetColorMap(vtkm::cont::ArrayHandle<vtkm::Vec4f_32>& colormap);
void SetCompositeBackground(bool on);
void SetDebugPrints(bool on);
void SetUnitScalar(vtkm::Float32 unitScalar);
void SetEpsilon(vtkm::Float64 epsilon); // epsilon for bumping lost rays
vtkm::Bounds GetSpatialBounds();
vtkm::Range GetScalarFieldRange();
vtkm::Range GetScalarRange();
void Trace(const vtkm::rendering::Camera& camera, vtkm::rendering::CanvasRayTracer* canvas);
void Trace(vtkm::rendering::raytracing::Ray<vtkm::Float64>& rays);
void Trace(vtkm::rendering::raytracing::Ray<vtkm::Float32>& rays);
PartialVector64 PartialTrace(vtkm::rendering::raytracing::Ray<vtkm::Float64>& rays);
PartialVector32 PartialTrace(vtkm::rendering::raytracing::Ray<vtkm::Float32>& rays);
protected:
struct InternalsType;
struct BoundsFunctor;
std::shared_ptr<InternalsType> Internals;
};
}
} //namespace vtkm::rendering
#endif //vtk_m_rendering_SceneRendererVolume_h