vpDisplay.cpp

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2025 by Inria. All rights reserved.
 *
 * This software 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 2 of the License, or
 * (at your option) any later version.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See https://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Description:
 * Image display.
 */

 
#include <visp3/core/vpDisplay.h>
#include <visp3/core/vpDisplayException.h>
#include <visp3/core/vpImageConvert.h>
 
#include <visp3/core/vpMath.h>
#include <visp3/core/vpMeterPixelConversion.h>
#include <visp3/core/vpPoint.h>
 
BEGIN_VISP_NAMESPACE
vpDisplay::vpDisplay()
  : m_displayHasBeenInitialized(false), m_windowXPosition(0), m_windowYPosition(0), m_width(0), m_height(0), m_title(),
  m_scale(1), m_scaleType(SCALE_DEFAULT)
{ }

vpDisplay::vpDisplay(const vpDisplay &d)
  : m_displayHasBeenInitialized(d.m_displayHasBeenInitialized), m_windowXPosition(d.m_windowXPosition),
  m_windowYPosition(d.m_windowYPosition), m_width(d.m_width), m_height(d.m_height), m_title(d.m_title),
  m_scale(d.m_scale), m_scaleType(d.m_scaleType)
{ }

vpDisplay::~vpDisplay() { m_displayHasBeenInitialized = false; }

void vpDisplay::getImage(const vpImage<unsigned char> &Isrc, vpImage<vpRGBa> &Idest)
{
  if (Isrc.display != nullptr) {
    (Isrc.display)->getImage(Idest);
  }
  else {
    vpImageConvert::convert(Isrc, Idest);
  }
}

void vpDisplay::getImage(const vpImage<vpRGBa> &Isrc, vpImage<vpRGBa> &Idest)
{
  if (Isrc.display != nullptr) {
    (Isrc.display)->getImage(Idest);
  }
  else {
    Idest = Isrc;
  }
}

void vpDisplay::setDownScalingFactor(unsigned int scale)
{
  if (!m_displayHasBeenInitialized) {
    m_scale = scale;
  }
  else {
    std::cout << "Warning: Cannot apply the down scaling factor " << scale
      << " to the display window since the display is initialized yet..." << std::endl;
  }
}

unsigned int vpDisplay::computeAutoScale(unsigned int width, unsigned int height)
{
  unsigned int screen_width, screen_height;
  getScreenSize(screen_width, screen_height);
  double wscale = std::max<double>(1., ceil((2. * static_cast<double>(width)) / static_cast<double>(screen_width)));
  double hscale = std::max<double>(1., ceil((2. * static_cast<double>(height)) / static_cast<double>(screen_height)));
  unsigned int scale = std::max<unsigned int>(1u, std::max<unsigned int>(static_cast<unsigned int>(wscale), static_cast<unsigned int>(hscale)));
  return scale;
}

void vpDisplay::setScale(vpScaleType scaleType, unsigned int width, unsigned int height)
{
  switch (scaleType) {
  case vpDisplay::SCALE_AUTO:
    setDownScalingFactor(computeAutoScale(width, height));
    break;
  case vpDisplay::SCALE_DEFAULT:
  case vpDisplay::SCALE_1:
    break;
  case vpDisplay::SCALE_2:
    setDownScalingFactor(2);
    break;
  case vpDisplay::SCALE_3:
    setDownScalingFactor(3);
    break;
  case vpDisplay::SCALE_4:
    setDownScalingFactor(4);
    break;
  case vpDisplay::SCALE_5:
    setDownScalingFactor(5);
    break;
  case vpDisplay::SCALE_6:
    setDownScalingFactor(6);
    break;
  case vpDisplay::SCALE_7:
    setDownScalingFactor(7);
    break;
  case vpDisplay::SCALE_8:
    setDownScalingFactor(8);
    break;
  case vpDisplay::SCALE_9:
    setDownScalingFactor(9);
    break;
  case vpDisplay::SCALE_10:
    setDownScalingFactor(10);
    break;
  default: {
    throw(vpException(vpException::fatalError, "Unsupported scale type in vpDisplay::setScale()"));
  }
  }
}

void vpDisplay::setDownScalingFactor(vpScaleType scaleType)
{
  if (!m_displayHasBeenInitialized) {
    m_scaleType = scaleType;
  }
}
END_VISP_NAMESPACE