VTK  9.6.20260704
vtkOSPRayMaterialLibrary.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
20
21#ifndef vtkOSPRayMaterialLibrary_h
22#define vtkOSPRayMaterialLibrary_h
23
25#include "vtkRenderingRayTracingModule.h" // For export macro
26
27VTK_ABI_NAMESPACE_BEGIN
28
29class VTKRENDERINGRAYTRACING_EXPORT vtkOSPRayMaterialLibrary : public vtkRenderMaterialLibrary
30{
31public:
34 void PrintSelf(ostream& os, vtkIndent indent) override;
35
42 void AddMaterial(const std::string& nickname, const std::string& implname) override;
43
52 void AddTexture(const std::string& nickname, const std::string& varname, vtkTexture* tex,
53 const std::string& texturename = "unnamedTexture", const std::string& filename = "") override;
54
60 void AddShaderVariable(const std::string& nickname, const std::string& variablename, int numVars,
61 const double* x) override;
63
67 std::vector<double> GetDoubleShaderVariable(
68 const std::string& nickname, const std::string& varname) const override;
69
73 const TextureInfo* GetTextureInfo(
74 const std::string& nickname, const std::string& varname) const override;
75
79 const std::map<std::string, ParametersMap>& GetParametersDictionary() const override;
80
81protected:
85 bool InternalParseJSON(const char* filename, bool fromfile, std::istream* doc) override;
86
91 bool ReadTextureFileOrData(const std::string& texFilenameOrData, bool fromfile,
92 const std::string& parentDir, vtkTexture* textr, std::string& textureName,
93 std::string& textureFilename) override;
95 ~vtkOSPRayMaterialLibrary() override = default;
96
97 const char* GetFamilyName() const override { return "OSPRay"; }
98 const char* GetAcceptedFamilyName() const override { return "OSPRay"; }
99
100private:
102 void operator=(const vtkOSPRayMaterialLibrary&) = delete;
103};
104
105VTK_ABI_NAMESPACE_END
106#endif
a simple class to control print indentation
Definition vtkIndent.h:108
a collection of materials for OSPRay-based rendering
bool InternalParseJSON(const char *filename, bool fromfile, std::istream *doc) override
Parse JSON material file with OSPRay-specific backward compatibility handling.
bool ReadTextureFileOrData(const std::string &texFilenameOrData, bool fromfile, const std::string &parentDir, vtkTexture *textr, std::string &textureName, std::string &textureFilename) override
Load texture from file or inline XML data.
void AddTexture(const std::string &nickname, const std::string &varname, vtkTexture *tex, const std::string &texturename="unnamedTexture", const std::string &filename="") override
Add Texture Given a material nickname and a shader variable varname, set its data to a specific textu...
const TextureInfo * GetTextureInfo(const std::string &nickname, const std::string &varname) const override
Returns the texture information, resolving OSPRay parameter name aliases.
void AddShaderVariable(const std::string &nickname, const std::string &variablename, int numVars, const double *x) override
Add control variable Adds a new control variable validated against the OSPRay parameter dictionary.
~vtkOSPRayMaterialLibrary() override=default
std::vector< double > GetDoubleShaderVariable(const std::string &nickname, const std::string &varname) const override
Returns a uniform variable, resolving OSPRay parameter name aliases.
const char * GetFamilyName() const override
static vtkOSPRayMaterialLibrary * New()
const std::map< std::string, ParametersMap > & GetParametersDictionary() const override
Get the dictionary of all possible materials based on OSPRay documentation.
const char * GetAcceptedFamilyName() const override
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkOSPRayMaterialLibrary()=default
void AddMaterial(const std::string &nickname, const std::string &implname) override
Add Material Adds a new material nickname to the set of known materials.
virtual void AddShaderVariable(const std::string &nickname, const std::string &variablename, int numVars, const double *x)
Add a shader variable to a material.
handles properties associated with a texture map
Definition vtkTexture.h:168