/*=========================================================================

   Program: ParaView
   Module: pqBackgroundEditorWidget.cxx

   Copyright (c) 2005-2012 Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2.

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=========================================================================*/

#include "pqBackgroundEditorWidget.h"
#include "ui_pqBackgroundEditorWidget.h"

#include <QGridLayout>
#include <QPushButton>

#include "pqPropertiesPanel.h"
#include "pqProxy.h"
#include "pqRenderView.h"
#include "pqTextureSelectorPropertyWidget.h"
#include "pqUndoStack.h"
#include "vtkSMProperty.h"
#include "vtkSMPropertyGroup.h"
#include "vtkSMPropertyHelper.h"
#include "vtkSMProxy.h"

const char* COLOR_PROPERTY = "Background";
const char* COLOR2_PROPERTY = "Background2";
const char* GRADIENT_BACKGROUND_PROPERTY = "UseGradientBackground";
const char* IMAGE_BACKGROUND_PROPERTY = "UseTexturedBackground";
const char* SKYBOX_BACKGROUND_PROPERTY = "UseSkyboxBackground";
const char* IMAGE_PROPERTY = "BackgroundTexture";
const char* ENV_LIGHTING_PROPERTY = "UseEnvironmentLighting";

const char* ENV_COLOR_PROPERTY = "EnvironmentalBG";
const char* ENV_COLOR2_PROPERTY = "EnvironmentalBG2";
const char* ENV_GRADIENT_BACKGROUND_PROPERTY = "UseGradientEnvironmentalBG";
const char* ENV_IMAGE_BACKGROUND_PROPERTY = "UseTexturedEnvironmentalBG";
const char* ENV_IMAGE_PROPERTY = "EnvironmentalBGTexture";

enum BackgroundType
{
  SINGLE_COLOR_TYPE,
  GRADIENT_TYPE,
  IMAGE_TYPE,
  SKYBOX_TYPE
};

class pqBackgroundEditorWidget::pqInternal : public Ui::BackgroundEditorWidget
{
public:
  enum BackgroundType PreviousType;
  pqTextureSelectorPropertyWidget* TextureSelector = nullptr;

  // whether the widget is customized for Environmental background settings or
  // the more typical Backplate type background.
  bool ForEnvironment = false;

  pqInternal(pqBackgroundEditorWidget* self)
    : PreviousType(SINGLE_COLOR_TYPE)
  {
    this->setupUi(self);
    this->mainLayout->setMargin(pqPropertiesPanel::suggestedMargin());
    this->mainLayout->setSpacing(pqPropertiesPanel::suggestedVerticalSpacing());
    this->page1Layout->setMargin(pqPropertiesPanel::suggestedMargin());
    this->page1Layout->setHorizontalSpacing(pqPropertiesPanel::suggestedHorizontalSpacing());
    this->page1Layout->setVerticalSpacing(pqPropertiesPanel::suggestedVerticalSpacing());
    this->page3Layout->setMargin(pqPropertiesPanel::suggestedMargin());
    this->page3Layout->setSpacing(pqPropertiesPanel::suggestedVerticalSpacing());
  }
};

pqBackgroundEditorWidget::pqBackgroundEditorWidget(
  vtkSMProxy* smProxy, vtkSMPropertyGroup* smGroup, QWidget* parentObject, bool forEnvironment)
  : Superclass(smProxy, smGroup, parentObject)
  , Internal(new pqInternal(this))
{
  Ui::BackgroundEditorWidget& ui = *this->Internal;
  this->Internal->ForEnvironment = forEnvironment;

  if (this->Internal->ForEnvironment)
  {
    ui.BackgroundType->removeItem(3); // SkyBox
  }
  connect(ui.BackgroundType, SIGNAL(currentIndexChanged(int)), this,
    SLOT(currentIndexChangedBackgroundType(int)));
  connect(ui.RestoreDefaultColor, SIGNAL(clicked()), this, SLOT(clickedRestoreDefaultColor()));
  connect(ui.RestoreDefaultColor2, SIGNAL(clicked()), this, SLOT(clickedRestoreDefaultColor2()));

  if (!this->Internal->ForEnvironment)
  {
    this->addPropertyLink(ui.Color, COLOR_PROPERTY);
    this->addPropertyLink(ui.Color2, COLOR2_PROPERTY);
  }
  else
  {
    this->addPropertyLink(ui.Color, ENV_COLOR_PROPERTY);
    this->addPropertyLink(ui.Color2, ENV_COLOR2_PROPERTY);
  }

  vtkSMProperty* smProperty;
  if (!this->Internal->ForEnvironment)
  {
    smProperty = smGroup->GetProperty(GRADIENT_BACKGROUND_PROPERTY);
  }
  else
  {
    smProperty = smGroup->GetProperty(ENV_GRADIENT_BACKGROUND_PROPERTY);
  }
  if (smProperty)
  {
    this->addPropertyLink(
      this, "gradientBackground", SIGNAL(gradientBackgroundChanged()), smProperty);
  }
  else
  {
    ui.BackgroundType->hide();
  }

  if (!this->Internal->ForEnvironment)
  {
    smProperty = smGroup->GetProperty(IMAGE_BACKGROUND_PROPERTY);
  }
  else
  {
    smProperty = smGroup->GetProperty(ENV_IMAGE_BACKGROUND_PROPERTY);
  }
  if (smProperty)
  {
    this->addPropertyLink(this, "imageBackground", SIGNAL(imageBackgroundChanged()), smProperty);
  }
  else
  {
    ui.BackgroundType->hide();
  }

  smProperty = smGroup->GetProperty(SKYBOX_BACKGROUND_PROPERTY);
  if (smProperty)
  {
    this->addPropertyLink(this, "skyboxBackground", SIGNAL(skyboxBackgroundChanged()), smProperty);
  }
  else
  {
    if (!this->Internal->ForEnvironment)
    {
      ui.BackgroundType->hide();
    }
  }

  smProperty = smGroup->GetProperty(ENV_LIGHTING_PROPERTY);
  if (smProperty)
  {
    this->addPropertyLink(
      this, "environmentLighting", SIGNAL(environmentLightingChanged()), smProperty);
  }
  else
  {
    if (!this->Internal->ForEnvironment)
    {
      ui.BackgroundType->hide();
    }
  }

  QObject::connect(this->Internal->EnvLighting, SIGNAL(stateChanged(int)), this,
    SIGNAL(environmentLightingChanged()));

  currentIndexChangedBackgroundType(this->Internal->PreviousType);

  if (!this->Internal->ForEnvironment)
  {
    smProperty = smGroup->GetProperty(IMAGE_PROPERTY);
  }
  else
  {
    smProperty = smGroup->GetProperty(ENV_IMAGE_PROPERTY);
  }
  if (smProperty)
  {
    // Can't use property link with texture, create the widget manually and connect signals
    this->Internal->TextureSelector =
      new pqTextureSelectorPropertyWidget(smProxy, smProperty, this);
    QObject::connect(
      this->Internal->TextureSelector, SIGNAL(changeAvailable()), this, SIGNAL(changeAvailable()));
    QObject::connect(
      this->Internal->TextureSelector, SIGNAL(changeFinished()), this, SIGNAL(changeFinished()));
    ui.page3Layout->insertWidget(0, this->Internal->TextureSelector);
  }
}

pqBackgroundEditorWidget::~pqBackgroundEditorWidget()
{
  delete this->Internal;
  this->Internal = nullptr;
}

void pqBackgroundEditorWidget::currentIndexChangedBackgroundType(int type)
{
  const int ROWS = 4;
  const int COLS = 2;
  Ui::BackgroundEditorWidget& ui = *this->Internal;
  const char* colorButtonName[4] = { "Color", "Color 1", "Color", "Color" };
  int currentPage[4] = { 0, 0, 1, 1 };
  bool visibleControls[4][ROWS] = { { true, false, false, false }, { true, true, false, false },
    { false, false, true, false }, { false, false, true, true } };
  QWidget* controls[ROWS][COLS] = { { ui.Color, ui.RestoreDefaultColor },
    { ui.Color2, ui.RestoreDefaultColor2 }, { this->Internal->TextureSelector, nullptr },
    { ui.EnvLighting, nullptr } };
  for (int i = 0; i < ROWS; ++i)
  {
    for (int j = 0; j < COLS; ++j)
    {
      QWidget* control = controls[i][j];
      if (control)
      {
        control->setVisible(visibleControls[type][i]);
      }
    }
  }
  ui.stackedWidget->setCurrentIndex(currentPage[type]);
  ui.Color->setText(colorButtonName[type]);
  fireGradientAndImageChanged(this->Internal->PreviousType, type);
  this->Internal->PreviousType = BackgroundType(type);
}

bool pqBackgroundEditorWidget::gradientBackground() const
{
  return this->Internal->BackgroundType->currentIndex() == GRADIENT_TYPE;
}

void pqBackgroundEditorWidget::setGradientBackground(bool gradientValue)
{
  enum BackgroundType typeFunction[4][2] = { { SINGLE_COLOR_TYPE, GRADIENT_TYPE },
    { SINGLE_COLOR_TYPE, GRADIENT_TYPE }, { IMAGE_TYPE, GRADIENT_TYPE },
    { SKYBOX_TYPE, GRADIENT_TYPE } };
  int newType = typeFunction[this->Internal->PreviousType][gradientValue];
  fireGradientAndImageChanged(this->Internal->PreviousType, newType);
  this->Internal->BackgroundType->setCurrentIndex(newType);
}

bool pqBackgroundEditorWidget::imageBackground() const
{
  return this->Internal->BackgroundType->currentIndex() == IMAGE_TYPE;
}

void pqBackgroundEditorWidget::setImageBackground(bool imageValue)
{
  enum BackgroundType typeFunction[4][2] = { { SINGLE_COLOR_TYPE, IMAGE_TYPE },
    { GRADIENT_TYPE, GRADIENT_TYPE }, // gradient has precedence over image
    { SINGLE_COLOR_TYPE, IMAGE_TYPE }, { SKYBOX_TYPE, IMAGE_TYPE } };
  enum BackgroundType newType = typeFunction[this->Internal->PreviousType][imageValue];
  fireGradientAndImageChanged(this->Internal->PreviousType, newType);
  this->Internal->BackgroundType->setCurrentIndex(newType);
}

bool pqBackgroundEditorWidget::skyboxBackground() const
{
  return this->Internal->BackgroundType->currentIndex() == SKYBOX_TYPE;
}

void pqBackgroundEditorWidget::setSkyboxBackground(bool skyboxValue)
{
  enum BackgroundType typeFunction[4][2] = { { SINGLE_COLOR_TYPE, SKYBOX_TYPE },
    { GRADIENT_TYPE, GRADIENT_TYPE }, // gradient has precedence over skybox
    { IMAGE_TYPE, IMAGE_TYPE },       // image has precedence over skybox
    { SINGLE_COLOR_TYPE, SKYBOX_TYPE } };
  enum BackgroundType newType = typeFunction[this->Internal->PreviousType][skyboxValue];
  fireGradientAndImageChanged(this->Internal->PreviousType, newType);
  this->Internal->BackgroundType->setCurrentIndex(newType);
}

bool pqBackgroundEditorWidget::environmentLighting() const
{
  return this->Internal->EnvLighting->isChecked();
}

void pqBackgroundEditorWidget::setEnvironmentLighting(bool envValue)
{
  this->Internal->EnvLighting->setChecked(envValue);
}

void pqBackgroundEditorWidget::fireGradientAndImageChanged(int oldType, int newType)
{
  if (oldType != newType)
  {
    if (oldType == GRADIENT_TYPE || newType == GRADIENT_TYPE)
    {
      Q_EMIT gradientBackgroundChanged();
    }
    if (oldType == IMAGE_TYPE || newType == IMAGE_TYPE)
    {
      Q_EMIT imageBackgroundChanged();
    }
    if (oldType == SKYBOX_TYPE || newType == SKYBOX_TYPE)
    {
      Q_EMIT skyboxBackgroundChanged();
    }
  }
}

void pqBackgroundEditorWidget::clickedRestoreDefaultColor()
{
  if (!this->Internal->ForEnvironment)
  {
    this->changeColor(COLOR_PROPERTY);
  }
  else
  {
    this->changeColor(ENV_COLOR_PROPERTY);
  }
}

void pqBackgroundEditorWidget::clickedRestoreDefaultColor2()
{
  if (!this->Internal->ForEnvironment)
  {
    this->changeColor(COLOR2_PROPERTY);
  }
  else
  {
    this->changeColor(ENV_COLOR2_PROPERTY);
  }
}

void pqBackgroundEditorWidget::changeColor(const char* propertyName)
{
  vtkSMProperty* _property = this->propertyGroup()->GetProperty(propertyName);
  BEGIN_UNDO_SET("Restore Default Color");
  _property->ResetToDefault();
  Q_EMIT this->changeFinished();
  END_UNDO_SET();
}
