vtkOSPRayMaterialLibrary.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkOSPRayMaterialLibrary.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkOSPRayMaterialLibrary_h
#define vtkOSPRayMaterialLibrary_h
 
#include "vtkObject.h"
#include "vtkRenderingRayTracingModule.h" // For export macro
 
#include <initializer_list> //for initializer_list!
#include <map>              //for map!
#include <set>              //for set!
#include <string>           //for string!
#include <vector>           //for vector!
 
class vtkOSPRayMaterialLibraryInternals;
class vtkTexture;
struct TextureInfo;
 
class VTKRENDERINGRAYTRACING_EXPORT vtkOSPRayMaterialLibrary : public vtkObject
{
public:
  static vtkOSPRayMaterialLibrary* New();
  vtkTypeMacro(vtkOSPRayMaterialLibrary, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void Fire();
 
  bool ReadFile(const char* FileName);
 
  const char* WriteBuffer(bool writeImageInline = true);
 
  void WriteFile(const std::string& filename, bool writeImageInline = false);
 
  bool ReadBuffer(const char* Buffer);
 
  std::set<std::string> GetMaterialNames();
 
  std::string LookupImplName(const std::string& nickname);
 
  std::vector<std::string> GetDoubleShaderVariableList(const std::string& nickname);
 
  std::vector<double> GetDoubleShaderVariable(
    const std::string& nickname, const std::string& varname);
 
  std::vector<std::string> GetTextureList(const std::string& nickname);
 
  vtkTexture* GetTexture(const std::string& nickname, const std::string& varname);
 
  const TextureInfo* GetTextureInfo(const std::string& nickname, const std::string& varname);
 
  std::string GetTextureName(const std::string& nickname, const std::string& varname);
 
  std::string GetTextureFilename(const std::string& nickname, const std::string& varname);
 
  void AddMaterial(const std::string& nickname, const std::string& implname);
 
  void RemoveMaterial(const std::string& nickname);
 
  void AddTexture(const std::string& nickname, const std::string& varname, vtkTexture* tex,
    const std::string& texturename = "unnamedTexture", const std::string& filename = "");
 
  void RemoveTexture(const std::string& nickname, const std::string& varname);
 
  void RemoveAllTextures(const std::string& nickname);
 
  void AddShaderVariable(
    const std::string& nickname, const std::string& variablename, int numVars, const double* x);
  void AddShaderVariable(const std::string& nickname, const std::string& variablename,
    const std::initializer_list<double>& data)
  {
    this->AddShaderVariable(nickname, variablename, static_cast<int>(data.size()), data.begin());
  }
  void RemoveShaderVariable(const std::string& nickname, const std::string& variablename);
 
  void RemoveAllShaderVariables(const std::string& nickname);
 
  enum class ParameterType : unsigned char
  {
    FLOAT,
    NORMALIZED_FLOAT,
    FLOAT_DATA,
    VEC3,
    COLOR_RGB,
    BOOLEAN,
    TEXTURE,
    VEC2,
    VEC4
  };
 
  using ParametersMap = std::map<std::string, ParameterType>;
 
  static const std::map<std::string, ParametersMap>& GetParametersDictionary();
 
protected:
  vtkOSPRayMaterialLibrary();
  ~vtkOSPRayMaterialLibrary() override;
 
  bool InternalParse(const char* name, bool IsFile);
  bool InternalParseJSON(const char* name, bool IsFile, std::istream* doc);
  bool InternalParseMTL(const char* name, bool IsFile, std::istream* doc);
  bool ReadTextureFileOrData(const std::string& texFilenameOrData, bool fromfile,
    const std::string& parentDir, vtkTexture* textr, std::string& textureName,
    std::string& textureFilename);
 
private:
  vtkOSPRayMaterialLibrary(const vtkOSPRayMaterialLibrary&) = delete;
  void operator=(const vtkOSPRayMaterialLibrary&) = delete;
 
  vtkOSPRayMaterialLibraryInternals* Internal;
};
 
#endif