AnimationCell.h

Go to the documentation of this file.

// -*- mode: c++; c-file-style: "linux"; c-basic-offset: 2; indent-tabs-mode: nil -*-
//
//  Copyright (C) 2007-2015 Andrej Vodopivec <andrej.vodopivec@gmail.com>
//            (C) 2014-2016 Gunter Königsmann <wxMaxima@physikbuch.de>
//
//  This program 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.
//
//  This program 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 for more details.
//
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
//  SPDX-License-Identifier: GPL-2.0+
 
#ifndef ANIMATIONCELL_H
#define ANIMATIONCELL_H
 
#include "Cell.h"
#include "Image.h"
#include "ImgCellBase.h"
#include <memory>
#include <wx/image.h>
#include <wx/timer.h>
 
#include <wx/fs_arc.h>
#include <wx/mstream.h>
#include <wx/wfstream.h>
 
#include <vector>
 
class AnimationCell final : public ImgCellBase
{
public:
  AnimationCell(GroupCell *group, Configuration *config,
                const AttachmentSource &attachments, double framerate = -1);
  AnimationCell(GroupCell *group, Configuration *config, double framerate = -1);
  AnimationCell(GroupCell *group, const AnimationCell &cell);
  AnimationCell(GroupCell *group, Configuration *config, const wxMemoryBuffer &image, const wxString &type);
  AnimationCell(GroupCell *group, Configuration *config, const wxString &image, bool remove);
  std::unique_ptr<Cell> Copy(GroupCell *group) const override;
  void operator=(const AnimationCell&) = delete;
  AnimationCell(const AnimationCell&) = delete;
 
  void SetConfiguration(Configuration *config) override;
  int GetPPI() const override {if(IsOk()) return m_images.at(m_displayed)->GetPPI(); else return 0;}
  size_t GetOriginalWidth() const override {
    if(IsOk())return m_images.at(m_displayed)->GetOriginalWidth(); else return 0;}
  size_t GetOriginalHeight() const override {
    if(IsOk())return m_images.at(m_displayed)->GetOriginalHeight(); else return 0;}
  void TallyImageLoadFailures(int &dataUnavailable, int &decodeFailed) const override {
    for (const auto &image : m_images) {
      if (!image) continue;
      switch (image->GetLoadFailureKind()) {
      case Image::LoadFailureKind::DataUnavailable: dataUnavailable++; break;
      case Image::LoadFailureKind::DecodeFailed: decodeFailed++; break;
      default: break;
      }
    }
  }
  wxString GetExtension() const override
    { if (IsOk())return m_images.at(m_displayed)->GetExtension(); else return wxEmptyString; }
 
  const CellTypeInfo &GetInfo() override;
  ~AnimationCell() override;
  int Length() const {return m_images.size();}
  void LoadImages(const wxMemoryBuffer& imageData);
  void LoadImages(const wxString& imageFile);
  void SetPPI(int ppi) override;
  static wxDataFormat m_gifFormat;
 
  bool CanExportSVG() const override {return (m_images.at(m_displayed) != nullptr) && m_images.at(m_displayed)->CanExportSVG();}
 
  class GifDataObject : public wxCustomDataObject
  {
  public:
    explicit GifDataObject(const wxMemoryOutputStream &str);
 
    GifDataObject();
 
  private:
    wxCharBuffer m_databuf;
  };
 
  bool IsOk() const;
 
  const wxString GetToolTip(wxPoint point) const override;
 
  void ClearCache() override;
 
  void LoadImages(wxArrayString images, bool deleteRead);
 
  int GetDisplayedIndex() const { return m_displayed; }
 
  wxImage GetBitmap(int n) const
    { return m_images.at(n)->GetUnscaledBitmap().ConvertToImage(); }
 
  void SetDisplayedIndex(int ind);
 
  wxSize ToImageFile(wxString file) override;
 
  wxSize ToGif(const wxString& file);
 
  bool CopyToClipboard() const override;
 
  bool CopyAnimationToClipboard();
 
  double GetFrameRate() const;
 
  void ReloadTimer();
 
  void StopTimer();
 
  double SetFrameRate(double Freq);
 
  bool AnimationRunning() const { return m_animationRunning; }
  void AnimationRunning(bool run);
  void ToggleAnimationRunning(){AnimationRunning(!AnimationRunning());}
  bool CanPopOut() const override
    { return m_images.at(m_displayed) && (m_images.at(m_displayed)->HasGnuplotSource()); }
 
  void GnuplotSource(int image, wxString gnuplotFilename, wxString dataFilename,
                     const AttachmentSource &attachments)
    { m_images.at(image)->GnuplotSource(std::move(gnuplotFilename),
                                     std::move(dataFilename), attachments); }
  void CompressedGnuplotSource(int image, wxString gnuplotFilename, wxString dataFilename,
                               const AttachmentSource &attachments)
    { m_images.at(image)->CompressedGnuplotSource(std::move(gnuplotFilename),
                                               std::move(dataFilename),
                                               attachments); }
 
  wxString GnuplotSource() const override
    {
      if (!m_images.at(m_displayed))
        return wxEmptyString;
      else
        return m_images.at(m_displayed)->GnuplotSource();
    }
 
private:
  ViewCellPointers *const m_viewCellPointers = GetViewCellPointers(); // must come before m_timer (!)
  std::unique_ptr<wxTimer> m_timer;
  std::vector<std::shared_ptr<Image>> m_images;
 
  double m_framerate = -1;
  int m_displayed = 0;
  int m_imageBorderWidth = 0;
 
//** Bitfield objects (1 bytes)
//**
  bool m_animationRunning : 1 = true;
  bool m_drawBoundingBox : 1 = false;
  AttachmentSource m_attachments;
 
  int GetImageBorderWidth() const override { return m_imageBorderWidth; }
 
  void Recalculate(const AFontSize fontsize) const override;
 
  using Cell::SetCurrentPoint;
  void SetCurrentPoint(wxPoint point) const override;
  void Draw(wxDC *dc, wxDC *antialiassingDC) override;
 
  wxString ToMatlab() const override;
  wxString ToMathML() const override;
  wxString ToRTF() const override;
  wxString ToString() const override;
  wxString ToTeX() const override;
  wxString ToXML() const override;
 
  wxCoord GetMaxWidth() const override;
  wxCoord GetHeightList() const override { return m_height; }
  void SetMaxWidth(wxCoord width) override;
  double GetUserScale() const override;
  void SetUserScale(double scale) override;
  bool GetFitToWindow() const override;
  void SetFitToWindow(bool fit) override;
  void SetMaxHeight(wxCoord height) override;
 
  void DrawBoundingBox(wxDC &WXUNUSED(dc), bool WXUNUSED(all) = false)  override
    { m_drawBoundingBox = true; }
};
 
#endif // ANIMATIONCELL_H