COM_CompositorContext.h

Go to the documentation of this file.

/*
 * 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.
 *
 * Copyright 2011, Blender Foundation.
 */
 
#pragma once
 
#include "BLI_rect.h"
 
#include "COM_Enums.h"
 
#include "DNA_color_types.h"
#include "DNA_node_types.h"
#include "DNA_scene_types.h"
 
#include <string>
#include <vector>
 
namespace blender::compositor {
 
class CompositorContext {
 private:
  bool m_rendering;
 
  eCompositorQuality m_quality;
 
  Scene *m_scene;
 
  RenderData *m_rd;
 
  bNodeTree *m_bnodetree;
 
  bNodeInstanceHash *m_previews;
 
  bool m_hasActiveOpenCLDevices;
 
  bool m_fastCalculation;
 
  /* \brief color management settings */
  const ColorManagedViewSettings *m_viewSettings;
  const ColorManagedDisplaySettings *m_displaySettings;
 
  const char *m_viewName;
 
 public:
  CompositorContext();
 
  void setRendering(bool rendering)
  {
    this->m_rendering = rendering;
  }
 
  bool isRendering() const
  {
    return this->m_rendering;
  }
 
  void setRenderData(RenderData *rd)
  {
    this->m_rd = rd;
  }
 
  void setbNodeTree(bNodeTree *bnodetree)
  {
    this->m_bnodetree = bnodetree;
  }
 
  const bNodeTree *getbNodeTree() const
  {
    return this->m_bnodetree;
  }
 
  const RenderData *getRenderData() const
  {
    return this->m_rd;
  }
 
  void setScene(Scene *scene)
  {
    m_scene = scene;
  }
  Scene *getScene() const
  {
    return m_scene;
  }
 
  void setPreviewHash(bNodeInstanceHash *previews)
  {
    this->m_previews = previews;
  }
 
  bNodeInstanceHash *getPreviewHash() const
  {
    return this->m_previews;
  }
 
  void setViewSettings(const ColorManagedViewSettings *viewSettings)
  {
    this->m_viewSettings = viewSettings;
  }
 
  const ColorManagedViewSettings *getViewSettings() const
  {
    return this->m_viewSettings;
  }
 
  void setDisplaySettings(const ColorManagedDisplaySettings *displaySettings)
  {
    this->m_displaySettings = displaySettings;
  }
 
  const ColorManagedDisplaySettings *getDisplaySettings() const
  {
    return this->m_displaySettings;
  }
 
  void setQuality(eCompositorQuality quality)
  {
    this->m_quality = quality;
  }
 
  eCompositorQuality getQuality() const
  {
    return this->m_quality;
  }
 
  int getFramenumber() const;
 
  bool getHasActiveOpenCLDevices() const
  {
    return this->m_hasActiveOpenCLDevices;
  }
 
  void setHasActiveOpenCLDevices(bool hasAvtiveOpenCLDevices)
  {
    this->m_hasActiveOpenCLDevices = hasAvtiveOpenCLDevices;
  }
 
  const char *getViewName() const
  {
    return this->m_viewName;
  }
 
  void setViewName(const char *viewName)
  {
    this->m_viewName = viewName;
  }
 
  int getChunksize() const
  {
    return this->getbNodeTree()->chunksize;
  }
 
  void setFastCalculation(bool fastCalculation)
  {
    this->m_fastCalculation = fastCalculation;
  }
  bool isFastCalculation() const
  {
    return this->m_fastCalculation;
  }
  bool isGroupnodeBufferEnabled() const
  {
    return (this->getbNodeTree()->flag & NTREE_COM_GROUPNODE_BUFFER) != 0;
  }
 
  float getRenderPercentageAsFactor() const
  {
    return m_rd->size * 0.01f;
  }
};
 
}  // namespace blender::compositor