vtk-m/vtkm/rendering/Canvas.cxx

629 lines
20 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.
//============================================================================
#include <vtkm/rendering/Canvas.h>
#include <vtkm/cont/ArrayHandleCounting.h>
#include <vtkm/cont/DataSetBuilderUniform.h>
#include <vtkm/cont/TryExecute.h>
#include <vtkm/io/DecodePNG.h>
#include <vtkm/io/EncodePNG.h>
#include <vtkm/io/FileUtils.h>
#include <vtkm/io/ImageUtils.h>
#include <vtkm/rendering/BitmapFontFactory.h>
#include <vtkm/rendering/LineRenderer.h>
#include <vtkm/rendering/TextRenderer.h>
#include <vtkm/rendering/WorldAnnotator.h>
#include <vtkm/worklet/DispatcherMapField.h>
#include <vtkm/worklet/WorkletMapField.h>
#include <fstream>
#include <iostream>
namespace vtkm
{
namespace rendering
{
namespace internal
{
struct ClearBuffers : public vtkm::worklet::WorkletMapField
{
using ControlSignature = void(FieldOut, FieldOut);
using ExecutionSignature = void(_1, _2);
VTKM_CONT
ClearBuffers() {}
VTKM_EXEC
void operator()(vtkm::Vec4f_32& color, vtkm::Float32& depth) const
{
color[0] = 0.f;
color[1] = 0.f;
color[2] = 0.f;
color[3] = 0.f;
// The depth is set to slightly larger than 1.0f, ensuring this color value always fails a
// depth check
depth = VTKM_DEFAULT_CANVAS_DEPTH;
}
}; // struct ClearBuffers
struct BlendBackground : public vtkm::worklet::WorkletMapField
{
vtkm::Vec4f_32 BackgroundColor;
VTKM_CONT
BlendBackground(const vtkm::Vec4f_32& backgroundColor)
: BackgroundColor(backgroundColor)
{
}
using ControlSignature = void(FieldInOut);
using ExecutionSignature = void(_1);
VTKM_EXEC void operator()(vtkm::Vec4f_32& color) const
{
if (color[3] >= 1.f)
return;
vtkm::Float32 alpha = BackgroundColor[3] * (1.f - color[3]);
color[0] = color[0] + BackgroundColor[0] * alpha;
color[1] = color[1] + BackgroundColor[1] * alpha;
color[2] = color[2] + BackgroundColor[2] * alpha;
color[3] = alpha + color[3];
}
}; // struct BlendBackground
struct DrawColorSwatch : public vtkm::worklet::WorkletMapField
{
using ControlSignature = void(FieldIn, WholeArrayInOut);
using ExecutionSignature = void(_1, _2);
VTKM_CONT
DrawColorSwatch(vtkm::Id2 dims, vtkm::Id2 xBounds, vtkm::Id2 yBounds, const vtkm::Vec4f_32 color)
: Color(color)
{
ImageWidth = dims[0];
ImageHeight = dims[1];
SwatchBottomLeft[0] = xBounds[0];
SwatchBottomLeft[1] = yBounds[0];
SwatchWidth = xBounds[1] - xBounds[0];
SwatchHeight = yBounds[1] - yBounds[0];
}
template <typename FrameBuffer>
VTKM_EXEC void operator()(const vtkm::Id& index, FrameBuffer& frameBuffer) const
{
// local bar coord
vtkm::Id x = index % SwatchWidth;
vtkm::Id y = index / SwatchWidth;
// offset to global image coord
x += SwatchBottomLeft[0];
y += SwatchBottomLeft[1];
vtkm::Id offset = y * ImageWidth + x;
frameBuffer.Set(offset, Color);
}
vtkm::Id ImageWidth;
vtkm::Id ImageHeight;
vtkm::Id2 SwatchBottomLeft;
vtkm::Id SwatchWidth;
vtkm::Id SwatchHeight;
const vtkm::Vec4f_32 Color;
}; // struct DrawColorSwatch
struct DrawColorBar : public vtkm::worklet::WorkletMapField
{
using ControlSignature = void(FieldIn, WholeArrayInOut, WholeArrayIn);
using ExecutionSignature = void(_1, _2, _3);
VTKM_CONT
DrawColorBar(vtkm::Id2 dims, vtkm::Id2 xBounds, vtkm::Id2 yBounds, bool horizontal)
: Horizontal(horizontal)
{
ImageWidth = dims[0];
ImageHeight = dims[1];
BarBottomLeft[0] = xBounds[0];
BarBottomLeft[1] = yBounds[0];
BarWidth = xBounds[1] - xBounds[0];
BarHeight = yBounds[1] - yBounds[0];
}
template <typename FrameBuffer, typename ColorMap>
VTKM_EXEC void operator()(const vtkm::Id& index,
FrameBuffer& frameBuffer,
const ColorMap& colorMap) const
{
// local bar coord
vtkm::Id x = index % BarWidth;
vtkm::Id y = index / BarWidth;
vtkm::Id sample = Horizontal ? x : y;
const vtkm::Vec4ui_8 color = colorMap.Get(sample);
vtkm::Float32 normalizedHeight = Horizontal
? static_cast<vtkm::Float32>(y) / static_cast<vtkm::Float32>(BarHeight)
: static_cast<vtkm::Float32>(x) / static_cast<vtkm::Float32>(BarWidth);
// offset to global image coord
x += BarBottomLeft[0];
y += BarBottomLeft[1];
vtkm::Id offset = y * ImageWidth + x;
// If the colortable has alpha values, we blend each color sample with translucent white.
// The height of the resultant translucent bar indicates the opacity.
constexpr vtkm::Float32 conversionToFloatSpace = (1.0f / 255.0f);
vtkm::Float32 alpha = color[3] * conversionToFloatSpace;
if (alpha < 1 && normalizedHeight <= alpha)
{
constexpr vtkm::Float32 intensity = 0.4f;
constexpr vtkm::Float32 inverseIntensity = (1.0f - intensity);
alpha *= inverseIntensity;
vtkm::Vec4f_32 blendedColor(1.0f * intensity + (color[0] * conversionToFloatSpace) * alpha,
1.0f * intensity + (color[1] * conversionToFloatSpace) * alpha,
1.0f * intensity + (color[2] * conversionToFloatSpace) * alpha,
1.0f);
frameBuffer.Set(offset, blendedColor);
}
else
{
// make sure this is opaque
vtkm::Vec4f_32 fColor((color[0] * conversionToFloatSpace),
(color[1] * conversionToFloatSpace),
(color[2] * conversionToFloatSpace),
1.0f);
frameBuffer.Set(offset, fColor);
}
}
vtkm::Id ImageWidth;
vtkm::Id ImageHeight;
vtkm::Id2 BarBottomLeft;
vtkm::Id BarWidth;
vtkm::Id BarHeight;
bool Horizontal;
}; // struct DrawColorBar
} // namespace internal
struct Canvas::CanvasInternals
{
CanvasInternals(vtkm::Id width, vtkm::Id height)
: Width(width)
, Height(height)
{
BackgroundColor.Components[0] = 0.f;
BackgroundColor.Components[1] = 0.f;
BackgroundColor.Components[2] = 0.f;
BackgroundColor.Components[3] = 1.f;
ForegroundColor.Components[0] = 1.f;
ForegroundColor.Components[1] = 1.f;
ForegroundColor.Components[2] = 1.f;
ForegroundColor.Components[3] = 1.f;
}
vtkm::Id Width;
vtkm::Id Height;
vtkm::rendering::Color BackgroundColor;
vtkm::rendering::Color ForegroundColor;
ColorBufferType ColorBuffer;
DepthBufferType DepthBuffer;
vtkm::rendering::BitmapFont Font;
FontTextureType FontTexture;
vtkm::Matrix<vtkm::Float32, 4, 4> ModelView;
vtkm::Matrix<vtkm::Float32, 4, 4> Projection;
};
Canvas::Canvas(vtkm::Id width, vtkm::Id height)
: Internals(new CanvasInternals(0, 0))
{
vtkm::MatrixIdentity(Internals->ModelView);
vtkm::MatrixIdentity(Internals->Projection);
this->ResizeBuffers(width, height);
}
Canvas::~Canvas() {}
vtkm::rendering::Canvas* Canvas::NewCopy() const
{
return new vtkm::rendering::Canvas(*this);
}
vtkm::Id Canvas::GetWidth() const
{
return Internals->Width;
}
vtkm::Id Canvas::GetHeight() const
{
return Internals->Height;
}
const Canvas::ColorBufferType& Canvas::GetColorBuffer() const
{
return Internals->ColorBuffer;
}
Canvas::ColorBufferType& Canvas::GetColorBuffer()
{
return Internals->ColorBuffer;
}
const Canvas::DepthBufferType& Canvas::GetDepthBuffer() const
{
return Internals->DepthBuffer;
}
Canvas::DepthBufferType& Canvas::GetDepthBuffer()
{
return Internals->DepthBuffer;
}
vtkm::cont::DataSet Canvas::GetDataSet(const std::string& colorFieldName,
const std::string& depthFieldName) const
{
vtkm::cont::DataSetBuilderUniform builder;
vtkm::cont::DataSet dataSet = builder.Create(vtkm::Id2(this->GetWidth(), this->GetHeight()));
if (!colorFieldName.empty())
{
dataSet.AddPointField(colorFieldName, this->GetColorBuffer());
}
if (!depthFieldName.empty())
{
dataSet.AddPointField(depthFieldName, this->GetDepthBuffer());
}
return dataSet;
}
vtkm::cont::DataSet Canvas::GetDataSet(const char* colorFieldName, const char* depthFieldName) const
{
return this->GetDataSet((colorFieldName != nullptr) ? std::string(colorFieldName) : std::string(),
(depthFieldName != nullptr) ? std::string(depthFieldName)
: std::string());
}
const vtkm::rendering::Color& Canvas::GetBackgroundColor() const
{
return Internals->BackgroundColor;
}
void Canvas::SetBackgroundColor(const vtkm::rendering::Color& color)
{
Internals->BackgroundColor = color;
}
const vtkm::rendering::Color& Canvas::GetForegroundColor() const
{
return Internals->ForegroundColor;
}
void Canvas::SetForegroundColor(const vtkm::rendering::Color& color)
{
Internals->ForegroundColor = color;
}
void Canvas::Clear()
{
internal::ClearBuffers worklet;
vtkm::worklet::DispatcherMapField<internal::ClearBuffers> dispatcher(worklet);
dispatcher.Invoke(this->GetColorBuffer(), this->GetDepthBuffer());
}
void Canvas::BlendBackground()
{
internal::BlendBackground worklet(GetBackgroundColor().Components);
vtkm::worklet::DispatcherMapField<internal::BlendBackground> dispatcher(worklet);
dispatcher.Invoke(this->GetColorBuffer());
}
void Canvas::ResizeBuffers(vtkm::Id width, vtkm::Id height)
{
VTKM_ASSERT(width >= 0);
VTKM_ASSERT(height >= 0);
vtkm::Id numPixels = width * height;
if (Internals->ColorBuffer.GetNumberOfValues() != numPixels)
{
Internals->ColorBuffer.Allocate(numPixels);
}
if (Internals->DepthBuffer.GetNumberOfValues() != numPixels)
{
Internals->DepthBuffer.Allocate(numPixels);
}
Internals->Width = width;
Internals->Height = height;
}
void Canvas::AddColorSwatch(const vtkm::Vec2f_64& point0,
const vtkm::Vec2f_64& vtkmNotUsed(point1),
const vtkm::Vec2f_64& point2,
const vtkm::Vec2f_64& vtkmNotUsed(point3),
const vtkm::rendering::Color& color) const
{
vtkm::Float64 width = static_cast<vtkm::Float64>(this->GetWidth());
vtkm::Float64 height = static_cast<vtkm::Float64>(this->GetHeight());
vtkm::Id2 x, y;
x[0] = static_cast<vtkm::Id>(((point0[0] + 1.) / 2.) * width + .5);
x[1] = static_cast<vtkm::Id>(((point2[0] + 1.) / 2.) * width + .5);
y[0] = static_cast<vtkm::Id>(((point0[1] + 1.) / 2.) * height + .5);
y[1] = static_cast<vtkm::Id>(((point2[1] + 1.) / 2.) * height + .5);
vtkm::Id2 dims(this->GetWidth(), this->GetHeight());
vtkm::Id totalPixels = (x[1] - x[0]) * (y[1] - y[0]);
vtkm::cont::ArrayHandleCounting<vtkm::Id> iterator(0, 1, totalPixels);
vtkm::worklet::DispatcherMapField<internal::DrawColorSwatch> dispatcher(
internal::DrawColorSwatch(dims, x, y, color.Components));
dispatcher.Invoke(iterator, this->GetColorBuffer());
}
void Canvas::AddColorSwatch(const vtkm::Float64 x0,
const vtkm::Float64 y0,
const vtkm::Float64 x1,
const vtkm::Float64 y1,
const vtkm::Float64 x2,
const vtkm::Float64 y2,
const vtkm::Float64 x3,
const vtkm::Float64 y3,
const vtkm::rendering::Color& color) const
{
this->AddColorSwatch(vtkm::make_Vec(x0, y0),
vtkm::make_Vec(x1, y1),
vtkm::make_Vec(x2, y2),
vtkm::make_Vec(x3, y3),
color);
}
void Canvas::AddLine(const vtkm::Vec2f_64& point0,
const vtkm::Vec2f_64& point1,
vtkm::Float32 linewidth,
const vtkm::rendering::Color& color) const
{
vtkm::rendering::Canvas* self = const_cast<vtkm::rendering::Canvas*>(this);
LineRenderer renderer(self, vtkm::MatrixMultiply(Internals->Projection, Internals->ModelView));
renderer.RenderLine(point0, point1, linewidth, color);
}
void Canvas::AddLine(vtkm::Float64 x0,
vtkm::Float64 y0,
vtkm::Float64 x1,
vtkm::Float64 y1,
vtkm::Float32 linewidth,
const vtkm::rendering::Color& color) const
{
this->AddLine(vtkm::make_Vec(x0, y0), vtkm::make_Vec(x1, y1), linewidth, color);
}
void Canvas::AddColorBar(const vtkm::Bounds& bounds,
const vtkm::cont::ColorTable& colorTable,
bool horizontal) const
{
vtkm::Float64 width = static_cast<vtkm::Float64>(this->GetWidth());
vtkm::Float64 height = static_cast<vtkm::Float64>(this->GetHeight());
vtkm::Id2 x, y;
x[0] = static_cast<vtkm::Id>(((bounds.X.Min + 1.) / 2.) * width + .5);
x[1] = static_cast<vtkm::Id>(((bounds.X.Max + 1.) / 2.) * width + .5);
y[0] = static_cast<vtkm::Id>(((bounds.Y.Min + 1.) / 2.) * height + .5);
y[1] = static_cast<vtkm::Id>(((bounds.Y.Max + 1.) / 2.) * height + .5);
vtkm::Id barWidth = x[1] - x[0];
vtkm::Id barHeight = y[1] - y[0];
vtkm::Id numSamples = horizontal ? barWidth : barHeight;
vtkm::cont::ArrayHandle<vtkm::Vec4ui_8> colorMap;
{
vtkm::cont::ScopedRuntimeDeviceTracker tracker(vtkm::cont::DeviceAdapterTagSerial{});
colorTable.Sample(static_cast<vtkm::Int32>(numSamples), colorMap);
}
vtkm::Id2 dims(this->GetWidth(), this->GetHeight());
vtkm::Id totalPixels = (x[1] - x[0]) * (y[1] - y[0]);
vtkm::cont::ArrayHandleCounting<vtkm::Id> iterator(0, 1, totalPixels);
vtkm::worklet::DispatcherMapField<internal::DrawColorBar> dispatcher(
internal::DrawColorBar(dims, x, y, horizontal));
dispatcher.Invoke(iterator, this->GetColorBuffer(), colorMap);
}
void Canvas::AddColorBar(vtkm::Float32 x,
vtkm::Float32 y,
vtkm::Float32 width,
vtkm::Float32 height,
const vtkm::cont::ColorTable& colorTable,
bool horizontal) const
{
this->AddColorBar(
vtkm::Bounds(vtkm::Range(x, x + width), vtkm::Range(y, y + height), vtkm::Range(0, 0)),
colorTable,
horizontal);
}
vtkm::Id2 Canvas::GetScreenPoint(vtkm::Float32 x,
vtkm::Float32 y,
vtkm::Float32 z,
const vtkm::Matrix<vtkm::Float32, 4, 4>& transform) const
{
vtkm::Vec4f_32 point(x, y, z, 1.0f);
point = vtkm::MatrixMultiply(transform, point);
vtkm::Id2 pixelPos;
vtkm::Float32 width = static_cast<vtkm::Float32>(Internals->Width);
vtkm::Float32 height = static_cast<vtkm::Float32>(Internals->Height);
pixelPos[0] = static_cast<vtkm::Id>(vtkm::Round((1.0f + point[0]) * width * 0.5f + 0.5f));
pixelPos[1] = static_cast<vtkm::Id>(vtkm::Round((1.0f + point[1]) * height * 0.5f + 0.5f));
return pixelPos;
}
void Canvas::AddText(const vtkm::Matrix<vtkm::Float32, 4, 4>& transform,
vtkm::Float32 scale,
const vtkm::Vec2f_32& anchor,
const vtkm::rendering::Color& color,
const std::string& text,
const vtkm::Float32& depth) const
{
if (!Internals->FontTexture.IsValid())
{
if (!LoadFont())
{
return;
}
}
vtkm::rendering::Canvas* self = const_cast<vtkm::rendering::Canvas*>(this);
TextRenderer fontRenderer(self, Internals->Font, Internals->FontTexture);
fontRenderer.RenderText(transform, scale, anchor, color, text, depth);
}
void Canvas::AddText(const vtkm::Vec2f_32& position,
vtkm::Float32 scale,
vtkm::Float32 angle,
vtkm::Float32 windowAspect,
const vtkm::Vec2f_32& anchor,
const vtkm::rendering::Color& color,
const std::string& text) const
{
vtkm::Matrix<vtkm::Float32, 4, 4> translationMatrix =
Transform3DTranslate(position[0], position[1], 0.f);
vtkm::Matrix<vtkm::Float32, 4, 4> scaleMatrix = Transform3DScale(1.0f / windowAspect, 1.0f, 1.0f);
vtkm::Vec3f_32 rotationAxis(0.0f, 0.0f, 1.0f);
vtkm::Matrix<vtkm::Float32, 4, 4> rotationMatrix = Transform3DRotate(angle, rotationAxis);
vtkm::Matrix<vtkm::Float32, 4, 4> transform =
vtkm::MatrixMultiply(translationMatrix, vtkm::MatrixMultiply(scaleMatrix, rotationMatrix));
this->AddText(transform, scale, anchor, color, text, 0.f);
}
void Canvas::AddText(vtkm::Float32 x,
vtkm::Float32 y,
vtkm::Float32 scale,
vtkm::Float32 angle,
vtkm::Float32 windowAspect,
vtkm::Float32 anchorX,
vtkm::Float32 anchorY,
const vtkm::rendering::Color& color,
const std::string& text) const
{
this->AddText(vtkm::make_Vec(x, y),
scale,
angle,
windowAspect,
vtkm::make_Vec(anchorX, anchorY),
color,
text);
}
bool Canvas::LoadFont() const
{
Internals->Font = BitmapFontFactory::CreateLiberation2Sans();
const std::vector<unsigned char>& rawPNG = Internals->Font.GetRawImageData();
std::vector<unsigned char> rgba;
unsigned long textureWidth, textureHeight;
auto error = io::DecodePNG(rgba, textureWidth, textureHeight, &rawPNG[0], rawPNG.size());
if (error != 0)
{
return false;
}
vtkm::Id numValues = static_cast<vtkm::Id>(textureWidth * textureHeight);
vtkm::cont::ArrayHandle<UInt8> alpha;
alpha.Allocate(numValues);
auto alphaPortal = alpha.WritePortal();
for (vtkm::Id i = 0; i < numValues; ++i)
{
alphaPortal.Set(i, rgba[static_cast<std::size_t>(i * 4 + 3)]);
}
Internals->FontTexture = FontTextureType(vtkm::Id(textureWidth), vtkm::Id(textureHeight), alpha);
Internals->FontTexture.SetFilterMode(TextureFilterMode::Linear);
Internals->FontTexture.SetWrapMode(TextureWrapMode::Clamp);
return true;
}
const vtkm::Matrix<vtkm::Float32, 4, 4>& Canvas::GetModelView() const
{
return Internals->ModelView;
}
const vtkm::Matrix<vtkm::Float32, 4, 4>& Canvas::GetProjection() const
{
return Internals->Projection;
}
void Canvas::SetViewToWorldSpace(const vtkm::rendering::Camera& camera, bool vtkmNotUsed(clip))
{
Internals->ModelView = camera.CreateViewMatrix();
Internals->Projection = camera.CreateProjectionMatrix(GetWidth(), GetHeight());
}
void Canvas::SetViewToScreenSpace(const vtkm::rendering::Camera& vtkmNotUsed(camera),
bool vtkmNotUsed(clip))
{
vtkm::MatrixIdentity(Internals->ModelView);
vtkm::MatrixIdentity(Internals->Projection);
Internals->Projection[2][2] = -1.0f;
}
void Canvas::SaveAs(const std::string& fileName) const
{
this->RefreshColorBuffer();
ColorBufferType::ReadPortalType colorPortal = GetColorBuffer().ReadPortal();
vtkm::Id width = GetWidth();
vtkm::Id height = GetHeight();
if (vtkm::io::EndsWith(fileName, ".png"))
{
std::vector<unsigned char> img(static_cast<size_t>(4 * width * height));
for (vtkm::Id yIndex = height - 1; yIndex >= 0; yIndex--)
{
for (vtkm::Id xIndex = 0; xIndex < width; xIndex++)
{
vtkm::Vec4f_32 tuple = colorPortal.Get(yIndex * width + xIndex);
// y = 0 is the top of a .png file.
size_t idx = static_cast<size_t>(4 * width * (height - 1 - yIndex) + 4 * xIndex);
img[idx + 0] = (unsigned char)(tuple[0] * 255);
img[idx + 1] = (unsigned char)(tuple[1] * 255);
img[idx + 2] = (unsigned char)(tuple[2] * 255);
img[idx + 3] = (unsigned char)(tuple[3] * 255);
}
}
vtkm::io::SavePNG(
fileName, img, static_cast<unsigned long>(width), static_cast<unsigned long>(height));
return;
}
std::ofstream of(fileName.c_str(), std::ios_base::binary | std::ios_base::out);
of << "P6" << std::endl << width << " " << height << std::endl << 255 << std::endl;
for (vtkm::Id yIndex = height - 1; yIndex >= 0; yIndex--)
{
for (vtkm::Id xIndex = 0; xIndex < width; xIndex++)
{
vtkm::Vec4f_32 tuple = colorPortal.Get(yIndex * width + xIndex);
of << (unsigned char)(tuple[0] * 255);
of << (unsigned char)(tuple[1] * 255);
of << (unsigned char)(tuple[2] * 255);
}
}
of.close();
}
vtkm::rendering::WorldAnnotator* Canvas::CreateWorldAnnotator() const
{
return new vtkm::rendering::WorldAnnotator(this);
}
}
} // vtkm::rendering