#3698 Scale bar. Take 1. Only vertical variant implemented so far

This commit is contained in:
Bjørn Erik Jensen
2018-11-15 11:24:09 +01:00
parent 76abf0fe01
commit d8a466a9ef
10 changed files with 1728 additions and 4 deletions

View File

@@ -18,6 +18,8 @@ add_library( ${PROJECT_NAME}
cafCategoryLegend.h
cafOverlayScalarMapperLegend.h
cafOverlayScalarMapperLegend.cpp
cafOverlayScaleLegend.h
cafOverlayScaleLegend.cpp
cafInternalLegendRenderTools.h
cafInternalLegendRenderTools.cpp
cafCategoryMapper.cpp

View File

@@ -0,0 +1,683 @@
//##################################################################################################
//
// Custom Visualization Core library
// Copyright (C) 2018- Ceetron Solutions AS
//
// This library may be used under the terms of either the GNU General Public License or
// the GNU Lesser General Public License as follows:
//
// GNU General Public License Usage
// This library is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE.
//
// See the GNU General Public License at <<http://www.gnu.org/licenses/gpl.html>>
// for more details.
//
// GNU Lesser General Public License Usage
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE.
//
// See the GNU Lesser General Public License at <<http://www.gnu.org/licenses/lgpl-2.1.html>>
// for more details.
//
//##################################################################################################
#include "cvfBase.h"
#include "cafOverlayScaleLegend.h"
#include "cvfOpenGL.h"
#include "cvfOpenGLResourceManager.h"
#include "cvfGeometryBuilderDrawableGeo.h"
#include "cvfGeometryUtils.h"
#include "cvfViewport.h"
#include "cvfCamera.h"
#include "cvfTextDrawer.h"
#include "cvfFont.h"
#include "cvfShaderProgram.h"
#include "cvfShaderProgramGenerator.h"
#include "cvfShaderSourceProvider.h"
#include "cvfShaderSourceRepository.h"
#include "cvfUniform.h"
#include "cvfMatrixState.h"
#include "cvfBufferObjectManaged.h"
#include "cvfGlyph.h"
#include "cvfRenderStateDepth.h"
#include "cvfRenderStateLine.h"
#include "cafInternalLegendRenderTools.h"
#include "cafTickMarkGenerator.h"
#ifndef CVF_OPENGL_ES
#include "cvfRenderState_FF.h"
#endif
#include "cvfScalarMapper.h"
#include <array>
#include "cvfRenderStateBlending.h"
#include <algorithm>
#include <cmath>
namespace caf {
using namespace cvf;
//==================================================================================================
///
/// \class cvf::OverlayColorLegend
/// \ingroup Render
///
///
///
//==================================================================================================
//--------------------------------------------------------------------------------------------------
/// Constructor
//--------------------------------------------------------------------------------------------------
OverlayScaleLegend::OverlayScaleLegend(Font* font)
: TitledOverlayFrame(font, 200, 200)
, m_tickNumberPrecision(4)
, m_numberFormat(AUTO)
, m_Layout(Vec2ui(200u, 200u))
, m_font(font)
{
CVF_ASSERT(font);
CVF_ASSERT(!font->isEmpty());
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
OverlayScaleLegend::~OverlayScaleLegend()
{
// Empty destructor to avoid errors with undefined types when cvf::ref's destructor gets called
}
//--------------------------------------------------------------------------------------------------
/// Hardware rendering using shader programs
//--------------------------------------------------------------------------------------------------
void OverlayScaleLegend::render(OpenGLContext* oglContext, const Vec2i& position, const Vec2ui& size)
{
renderGeneric(oglContext, position, size, false);
}
//--------------------------------------------------------------------------------------------------
/// Software rendering using software
//--------------------------------------------------------------------------------------------------
void OverlayScaleLegend::renderSoftware(OpenGLContext* oglContext, const Vec2i& position, const Vec2ui& size)
{
renderGeneric(oglContext, position, size, true);
}
//--------------------------------------------------------------------------------------------------
/// Set up camera/viewport and render
//--------------------------------------------------------------------------------------------------
void OverlayScaleLegend::renderGeneric(OpenGLContext* oglContext, const Vec2i& position, const Vec2ui& size, bool software)
{
if (size.x() <= 0 || size.y() <= 0)
{
return;
}
Camera camera;
camera.setViewport(position.x(), position.y(), size.x(), size.y());
camera.setProjectionAsPixelExact2D();
camera.setViewMatrix(Mat4d::IDENTITY);
camera.applyOpenGL();
camera.viewport()->applyOpenGL(oglContext, Viewport::CLEAR_DEPTH);
m_Layout = LayoutInfo(size);
layoutInfo(&m_Layout);
m_textDrawer = new TextDrawer(this->font());
// Set up text drawer
float maxLegendRightPos = 0;
setupTextDrawer(m_textDrawer.p(), &m_Layout );
Vec2f backgroundSize(size);
// Do the actual rendering
if (software)
{
if ( this->backgroundEnabled() )
{
InternalLegendRenderTools::renderBackgroundImmediateMode(oglContext,
backgroundSize,
this->backgroundColor(),
this->backgroundFrameColor());
}
renderLegendImmediateMode(oglContext, &m_Layout);
m_textDrawer->renderSoftware(oglContext, camera);
}
else
{
const MatrixState matrixState(camera);
if ( this->backgroundEnabled() )
{
InternalLegendRenderTools::renderBackgroundUsingShaders(oglContext,
matrixState,
backgroundSize,
this->backgroundColor(),
this->backgroundFrameColor());
}
renderLegendUsingShaders(oglContext, &m_Layout, matrixState);
m_textDrawer->render(oglContext, camera);
}
CVF_CHECK_OGL(oglContext);
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void OverlayScaleLegend::setupTextDrawer(TextDrawer* textDrawer, const LayoutInfo* layout)
{
CVF_ASSERT(layout);
textDrawer->setVerticalAlignment(TextDrawer::CENTER);
textDrawer->setTextColor(this->textColor());
m_visibleTickLabels.clear();
const float textX = layout->startPt.x() + layout->majorTickSize / 2.0f /* tickEndX*/ + layout->tickTextLeadSpace;
const float overlapTolerance = 1.2f * layout->charHeight;
float lastVisibleTextY = 0.0;
size_t numTicks = layout->ticks.size();
size_t it;
for (it = 0; it < numTicks; it++)
{
if(!layout->ticks[it].isMajor) continue;
float textY = static_cast<float>(layout->startPt.y() + layout->ticks[it].displayValue);
// Always draw first and last tick label. For all others, skip drawing if text ends up
// on top of the previous label.
if (it != 0 && it != (numTicks - 1))
{
if (cvf::Math::abs(textY - lastVisibleTextY) < overlapTolerance)
{
m_visibleTickLabels.push_back(false);
continue;
}
// Make sure it does not overlap the last tick as well
float lastTickY = static_cast<float>(layout->startPt.y() + layout->axisLength);
if (cvf::Math::abs(textY - lastTickY) < overlapTolerance)
{
m_visibleTickLabels.push_back(false);
continue;
}
}
double tickValue = layout->ticks[it].domainValue;
String valueString;
switch (m_numberFormat)
{
case FIXED:
valueString = String::number(tickValue, 'f', m_tickNumberPrecision);
break;
case SCIENTIFIC:
valueString = String::number(tickValue, 'e', m_tickNumberPrecision);
break;
default:
valueString = String::number(tickValue);
break;
}
Vec2f pos(textX, textY);
textDrawer->addText(valueString, pos);
lastVisibleTextY = textY;
m_visibleTickLabels.push_back(true);
}
float titleY = static_cast<float>(layout->overallLegendSize.y()) - layout->margins.y() - layout->charHeight/2.0f;
for (it = 0; it < this->titleStrings().size(); it++)
{
Vec2f pos(layout->margins.x(), titleY);
textDrawer->addText(this->titleStrings()[it], pos);
titleY -= layout->lineSpacing;
}
}
//--------------------------------------------------------------------------------------------------
/// Draw the legend using shader programs
//--------------------------------------------------------------------------------------------------
void OverlayScaleLegend::renderLegendUsingShaders(OpenGLContext* oglContext, LayoutInfo* layout, const MatrixState& matrixState)
{
CVF_CALLSITE_OPENGL(oglContext);
CVF_TIGHT_ASSERT(layout);
CVF_TIGHT_ASSERT(layout->overallLegendSize.x() > 0);
CVF_TIGHT_ASSERT(layout->overallLegendSize.y() > 0);
RenderStateDepth depth(false);
depth.applyOpenGL(oglContext);
RenderStateLine line(static_cast<float>(this->lineWidth()));
line.applyOpenGL(oglContext);
// All vertices. Initialized here to set Z to zero once and for all.
static float vertexArray[] =
{
0.0f, 0.0f, 0.0f,
0.0f, 0.0f, 0.0f,
0.0f, 0.0f, 0.0f,
0.0f, 0.0f, 0.0f,
0.0f, 0.0f, 0.0f
};
// Per vector convenience pointers
float* v0 = &vertexArray[0];
float* v1 = &vertexArray[3];
float* v2 = &vertexArray[6];
float* v3 = &vertexArray[9];
float* v4 = &vertexArray[12];
// Connects
static const ushort trianglesConnects[] = { 0, 1, 4, 0, 4, 3 };
ref<ShaderProgram> shaderProgram = oglContext->resourceManager()->getLinkedUnlitColorShaderProgram(oglContext);
CVF_TIGHT_ASSERT(shaderProgram.notNull());
if (shaderProgram->useProgram(oglContext))
{
shaderProgram->clearUniformApplyTracking();
shaderProgram->applyFixedUniforms(oglContext, matrixState);
}
glBindBuffer(GL_ARRAY_BUFFER, 0);
glEnableVertexAttribArray(ShaderProgram::VERTEX);
glVertexAttribPointer(ShaderProgram::VERTEX, 3, GL_FLOAT, GL_FALSE, 0, vertexArray);
// Draw axis
{
v0[0] = layout->startPt.x();
v0[1] = layout->startPt.y();
v1[0] = v0[0];
v1[1] = v0[1] + layout->axisLength;
static const ushort axisConnects[] = { 0, 1 };
UniformFloat uniformColor("u_color", Color4f(this->lineColor()));
shaderProgram->applyUniform(oglContext, uniformColor);
#ifdef CVF_OPENGL_ES
glDrawElements(GL_LINES, 2, GL_UNSIGNED_SHORT, axisConnects);
#else
glDrawRangeElements(GL_LINES, 0, 3, 2, GL_UNSIGNED_SHORT, axisConnects);
#endif
}
// Draw ticks
for (const auto& tickInfo : layout->ticks)
{
if (tickInfo.isMajor)
{
v0[0] = layout->startPt.x() - layout->majorTickSize / 2.0f;
v0[1] = static_cast<float>(tickInfo.displayValue) + layout->startPt.y();
v1[0] = v0[0] + layout->majorTickSize;
v1[1] = v0[1];
}
else
{
v0[0] = layout->startPt.x() - layout->minorTickSize / 2.0f;
v0[1] = static_cast<float>(tickInfo.displayValue) + layout->startPt.y();
v1[0] = v0[0] + layout->minorTickSize;
v1[1] = v0[1];
}
static const ushort tickConnects[] = {0, 1};
UniformFloat uniformColor("u_color", Color4f(this->lineColor()));
shaderProgram->applyUniform(oglContext, uniformColor);
#ifdef CVF_OPENGL_ES
glDrawElements(GL_LINES, 2, GL_UNSIGNED_SHORT, axisConnects);
#else
glDrawRangeElements(GL_LINES, 0, 3, 2, GL_UNSIGNED_SHORT, tickConnects);
#endif
}
glDisableVertexAttribArray(ShaderProgram::VERTEX);
CVF_TIGHT_ASSERT(shaderProgram.notNull());
shaderProgram->useNoProgram(oglContext);
// Reset render states
RenderStateDepth resetDepth;
resetDepth.applyOpenGL(oglContext);
RenderStateLine resetLine;
resetLine.applyOpenGL(oglContext);
CVF_CHECK_OGL(oglContext);
}
//--------------------------------------------------------------------------------------------------
/// Draw the legend using immediate mode OpenGL
//--------------------------------------------------------------------------------------------------
void OverlayScaleLegend::renderLegendImmediateMode(OpenGLContext* oglContext, LayoutInfo* layout)
{
#if 0
#ifdef CVF_OPENGL_ES
CVF_UNUSED(layout);
CVF_FAIL_MSG("Not supported on OpenGL ES");
#else
CVF_TIGHT_ASSERT(layout);
CVF_TIGHT_ASSERT(layout->overallLegendSize.x() > 0);
CVF_TIGHT_ASSERT(layout->overallLegendSize.y() > 0);
RenderStateDepth depth(false);
depth.applyOpenGL(oglContext);
RenderStateLighting_FF lighting(false);
lighting.applyOpenGL(oglContext);
// All vertices. Initialized here to set Z to zero once and for all.
static float vertexArray[] =
{
0.0f, 0.0f, 0.0f,
0.0f, 0.0f, 0.0f,
0.0f, 0.0f, 0.0f,
0.0f, 0.0f, 0.0f,
0.0f, 0.0f, 0.0f,
};
// Per vector convenience pointers
float* v0 = &vertexArray[0];
float* v1 = &vertexArray[3];
float* v2 = &vertexArray[6];
float* v3 = &vertexArray[9];
float* v4 = &vertexArray[12];
// Constant coordinates
v0[0] = v3[0] = layout->tickStartX;
v1[0] = v4[0] = layout->tickMidX;
// Render color bar as one colored quad per pixel
int legendHeightPixelCount = static_cast<int>(layout->tickYPixelPos->get(m_tickValues.size() - 1) - layout->tickYPixelPos->get(0) + 0.01);
if (m_scalarMapper.notNull())
{
int iPx;
for (iPx = 0; iPx < legendHeightPixelCount; iPx++)
{
const Color3ub& clr = m_scalarMapper->mapToColor(m_scalarMapper->domainValue((iPx+0.5)/legendHeightPixelCount));
float y0 = static_cast<float>(layout->colorBarRect.min().y() + iPx);
float y1 = static_cast<float>(layout->colorBarRect.min().y() + iPx + 1);
// Dynamic coordinates for rectangle
v0[1] = v1[1] = y0;
v3[1] = v4[1] = y1;
// Draw filled rectangle elements
glColor3ubv(clr.ptr());
glBegin(GL_TRIANGLE_FAN);
glVertex3fv(v0);
glVertex3fv(v1);
glVertex3fv(v4);
glVertex3fv(v3);
glEnd();
}
}
// Render frame
// Dynamic coordinates for tickmarks-lines
bool isRenderingFrame = true;
if (isRenderingFrame)
{
v0[0] = v2[0] = layout->colorBarRect.min().x()-0.5f;
v1[0] = v3[0] = layout->colorBarRect.max().x()-0.5f;
v0[1] = v1[1] = layout->colorBarRect.min().y()-0.5f;
v2[1] = v3[1] = layout->colorBarRect.max().y()-0.5f;
glColor3fv(this->textColor().ptr());
glBegin(GL_LINES);
glVertex3fv(v0);
glVertex3fv(v1);
glVertex3fv(v1);
glVertex3fv(v3);
glVertex3fv(v3);
glVertex3fv(v2);
glVertex3fv(v2);
glVertex3fv(v0);
glEnd();
}
// Render tickmarks
bool isRenderingTicks = true;
if (isRenderingTicks)
{
// Constant coordinates
v0[0] = layout->tickStartX;
v1[0] = layout->tickMidX - 0.5f*(layout->tickEndX - layout->tickMidX) - 0.5f;
v2[0] = layout->tickMidX;
v3[0] = layout->tickEndX - 0.5f*(layout->tickEndX - layout->tickMidX) - 0.5f;
v4[0] = layout->tickEndX;
size_t ic;
for (ic = 0; ic < m_tickValues.size(); ic++)
{
float y0 = static_cast<float>(layout->colorBarRect.min().y() + layout->tickYPixelPos->get(ic) - 0.5f);
// Dynamic coordinates for tickmarks-lines
v0[1] = v1[1] = v2[1] = v3[1] = v4[1] = y0;
glColor3fv(this->textColor().ptr());
glBegin(GL_LINES);
if ( m_visibleTickLabels[ic])
{
glVertex3fv(v0);
glVertex3fv(v4);
}
else
{
glVertex3fv(v2);
glVertex3fv(v3);
}
glEnd();
}
}
// Reset render states
RenderStateLighting_FF resetLighting;
resetLighting.applyOpenGL(oglContext);
RenderStateDepth resetDepth;
resetDepth.applyOpenGL(oglContext);
CVF_CHECK_OGL(oglContext);
#endif // CVF_OPENGL_ES
#endif // 0
}
//--------------------------------------------------------------------------------------------------
/// Get layout information
//--------------------------------------------------------------------------------------------------
void OverlayScaleLegend::layoutInfo(LayoutInfo* layout)
{
CVF_TIGHT_ASSERT(layout);
ref<Glyph> glyph = this->font()->getGlyph(L'A');
layout->charHeight = static_cast<float>(glyph->height());
layout->lineSpacing = layout->charHeight*1.5f;
layout->margins = Vec2f(8.0f, 8.0f);
layout->tickTextLeadSpace = 5.0f;
layout->majorTickSize = 9.0f;
layout->minorTickSize = 5.0f;
float maxAxisLength = static_cast<float>(layout->overallLegendSize.y())
- 2*layout->margins.y()
- static_cast<float>(this->titleStrings().size()) * layout->lineSpacing
- layout->lineSpacing;
auto currentScale = m_currentScale != 0.0 ? m_currentScale : 1.0;
layout->startPt = {layout->margins.x() + layout->majorTickSize / 2.0f, layout->margins.y() + layout->charHeight / 2.0f };
layout->ticks.clear();
size_t numTicks = m_ticksInDomain.size();
if (numTicks > 1)
{
double tickSpacingInDomain = m_ticksInDomain[1] - m_ticksInDomain[0];
bool finished = false;
for (size_t i = 0; i < numTicks; i++)
{
for (size_t j = 0; j < 2; j++)
{
double tickInDomain = m_ticksInDomain[i] + ((double)j * tickSpacingInDomain / 2.0);
double tickInDisplay = tickInDomain * currentScale;
if (tickInDisplay - layout->startPt.y() < maxAxisLength)
{
layout->ticks.emplace_back(LayoutInfo::Tick(tickInDisplay, tickInDomain, j == 0));
}
else
{
finished = true;
break;
}
}
if (finished) break;
}
layout->axisLength = static_cast<float>(layout->ticks.back().displayValue);
}
else
layout->axisLength = 0;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void OverlayScaleLegend::setTickPrecision(int precision)
{
m_tickNumberPrecision = precision;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void OverlayScaleLegend::setTickFormat(NumberFormat format)
{
m_numberFormat = format;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
cvf::Vec2ui OverlayScaleLegend::preferredSize()
{
LayoutInfo layout({200,200}); // Use default size
layoutInfo(&layout);
float prefferredYSize = 400;
//float prefferredYSize = 2 * layout.margins.y()
// + layout.lineSpacing * this->titleStrings().size()
// + 1.5f * layout.lineSpacing * m_tickValues.size();
unsigned int maxTickTextWidth = 0;
for (double tickValue : m_ticksInDomain )
{
String valueString;
switch ( m_numberFormat )
{
case FIXED:
valueString = String::number(tickValue, 'f', m_tickNumberPrecision);
break;
case SCIENTIFIC:
valueString = String::number(tickValue, 'e', m_tickNumberPrecision);
break;
default:
valueString = String::number(tickValue);
break;
}
unsigned int textWidth = this->font()->textExtent(valueString).x();
maxTickTextWidth = maxTickTextWidth < textWidth ? textWidth : maxTickTextWidth;
}
float prefferredXSize = layout.margins.x() + layout.tickTextLeadSpace + maxTickTextWidth;
for (const cvf::String& titleLine : titleStrings())
{
float titleWidth = this->font()->textExtent(titleLine).x() + 2*layout.margins.x();
prefferredXSize = prefferredXSize < titleWidth ? titleWidth : prefferredXSize;
}
prefferredXSize = std::min(prefferredXSize, 400.0f);
return { (unsigned int)(std::ceil(prefferredXSize)), (unsigned int)(std::ceil(prefferredYSize)) };
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void OverlayScaleLegend::setDisplayCoordTransform(const caf::DisplayCoordTransform* displayCoordTransform)
{
m_dispalyCoordsTransform = displayCoordTransform;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
void OverlayScaleLegend::updateFromCamera(const Camera* camera)
{
auto windowSize = Vec2ui(camera->viewport()->width(), camera->viewport()->height());
Vec3d windowOrigoInDomain;
Vec3d windowMaxInDomain;
camera->unproject(Vec3d(0, 0, 0), &windowOrigoInDomain);
camera->unproject(Vec3d(windowSize.x(), windowSize.y(), 0), &windowMaxInDomain);
if (m_dispalyCoordsTransform.notNull())
{
windowOrigoInDomain = m_dispalyCoordsTransform->transformToDomainCoord(windowOrigoInDomain);
windowMaxInDomain = m_dispalyCoordsTransform->transformToDomainCoord(windowMaxInDomain);
}
Vec3d windowOrigoPoint;
Vec3d windowMaxPoint;
camera->project(windowOrigoInDomain, &windowOrigoPoint);
camera->project(windowMaxInDomain, &windowMaxPoint);
m_currentScale = (windowMaxPoint.y() - windowOrigoPoint.y()) / (windowMaxInDomain.y() - windowOrigoInDomain.y());
auto textSize = m_font->textExtent(String::number(-1.999e-17));
int xTickMaxCount = windowSize.x() / (2 * textSize.x());
int yTickMaxCount = windowSize.y() / (2 * textSize.x());
double minDomainYStepSize = (windowMaxInDomain.y() - windowOrigoInDomain.y()) / yTickMaxCount;
caf::TickMarkGenerator yTickCreator(windowOrigoInDomain.y(), windowMaxInDomain.y(), minDomainYStepSize);
auto ticks = yTickCreator.tickMarkValues();
m_ticksInDomain.clear();
for (const auto& tick : ticks)
{
m_ticksInDomain.push_back(tick - ticks.front());
}
}
} // namespace cvf

View File

@@ -0,0 +1,162 @@
//##################################################################################################
//
// Custom Visualization Core library
// Copyright (C) 2018- Ceetron Solutions AS
//
// This library may be used under the terms of either the GNU General Public License or
// the GNU Lesser General Public License as follows:
//
// GNU General Public License Usage
// This library is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE.
//
// See the GNU General Public License at <<http://www.gnu.org/licenses/gpl.html>>
// for more details.
//
// GNU Lesser General Public License Usage
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE.
//
// See the GNU Lesser General Public License at <<http://www.gnu.org/licenses/lgpl-2.1.html>>
// for more details.
//
//##################################################################################################
#pragma once
#include "cafDisplayCoordTransform.h"
#include "cafTitledOverlayFrame.h"
#include "cvfOverlayItem.h"
#include "cvfArray.h"
#include "cvfCamera.h"
#include "cvfString.h"
#include "cvfRect.h"
namespace cvf {
class Font;
class ShaderProgram;
class MatrixState;
class TextDrawer;
class ScalarMapper;
}
namespace caf {
//==================================================================================================
//
// Overlay color legend
//
//==================================================================================================
class OverlayScaleLegend : public caf::TitledOverlayFrame
{
using Font = cvf::Font;
using ScalarMapper = cvf::ScalarMapper;
using OpenGLContext = cvf::OpenGLContext;
using Vec2i = cvf::Vec2i;
using Vec2ui = cvf::Vec2ui;
using Color3f = cvf::Color3f;
using Color4f = cvf::Color4f;
using String = cvf::String;
using DoubleArray = cvf::DoubleArray;
using MatrixState = cvf::MatrixState;
using Vec2f = cvf::Vec2f;
using Rectf = cvf::Rectf;
using TextDrawer = cvf::TextDrawer;
using Camera = cvf::Camera;
public:
OverlayScaleLegend(Font* font);
virtual ~OverlayScaleLegend();
void setTickPrecision(int precision);
enum NumberFormat { AUTO, SCIENTIFIC, FIXED};
void setTickFormat(NumberFormat format);
virtual cvf::Vec2ui preferredSize() override;
void setDisplayCoordTransform(const caf::DisplayCoordTransform* displayCoordTransform);
void updateFromCamera(const Camera* camera);
protected:
void render(OpenGLContext* oglContext, const Vec2i& position, const Vec2ui& size) override;
void renderSoftware(OpenGLContext* oglContext, const Vec2i& position, const Vec2ui& size) override;
struct LayoutInfo
{
struct Tick
{
Tick(double displayValue, double domainValue, bool isMajor)
: displayValue(displayValue)
, domainValue(domainValue)
, isMajor(isMajor) {}
double displayValue;
double domainValue;
bool isMajor;
};
LayoutInfo(const Vec2ui& setSize)
{
overallLegendSize = setSize;
}
float charHeight;
float lineSpacing;
Vec2f margins;
float tickTextLeadSpace;
//Rectf colorBarRect;
Vec2f startPt;
float axisLength;
float majorTickSize;
float minorTickSize;
std::vector<Tick> ticks;
Vec2ui overallLegendSize;
};
void layoutInfo(LayoutInfo* layout);
void renderGeneric(OpenGLContext* oglContext,
const Vec2i& position,
const Vec2ui& size,
bool software);
void renderLegendUsingShaders(OpenGLContext* oglContext,
LayoutInfo* layout,
const MatrixState& matrixState);
void renderLegendImmediateMode(OpenGLContext* oglContext,
LayoutInfo* layout);
void setupTextDrawer(TextDrawer* textDrawer,
const LayoutInfo* layout);
protected:
std::vector<bool> m_visibleTickLabels; // Skip tick labels ending up on top of previous visible label
int m_tickNumberPrecision;
NumberFormat m_numberFormat;
LayoutInfo m_Layout;
cvf::ref<TextDrawer> m_textDrawer;
cvf::cref<ScalarMapper> m_scalarMapper;
cvf::ref<Font> m_font;
cvf::cref<caf::DisplayCoordTransform> m_dispalyCoordsTransform;
double m_currentScale = 0.0; // [pixels/length]
std::vector<double> m_ticksInDomain;
};
}