vtkUniforms.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkUniforms_h
#define vtkUniforms_h

#include "vtkObject.h"
#include "vtkRenderingCoreModule.h" // For export macro
#include <string>                   // member function parameters
#include <vector>                   // member function parameters

VTK_ABI_NAMESPACE_BEGIN
class vtkMatrix3x3;
class vtkMatrix4x4;

class VTKRENDERINGCORE_EXPORT vtkUniforms : public vtkObject
{
public:
  static vtkUniforms* New();
  vtkTypeMacro(vtkUniforms, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual vtkMTimeType GetUniformListMTime();


  enum TupleType
  {
    TupleTypeInvalid = 0,
    TupleTypeScalar,
    TupleTypeVector,
    TupleTypeMatrix,
    NumberOfTupleTypes
  };


  static std::string TupleTypeToString(TupleType tt);
  static TupleType StringToTupleType(const std::string& s);


  static std::string ScalarTypeToString(int scalarType);
  static int StringToScalarType(const std::string& s);

  virtual void RemoveUniform(const char* name);

  virtual void RemoveAllUniforms();


  virtual void SetUniform(
    const char* name, vtkUniforms::TupleType tt, int nbComponents, const std::vector<int>& value);
  virtual void SetUniform(
    const char* name, vtkUniforms::TupleType tt, int nbComponents, const std::vector<float>& value);
  virtual bool GetUniform(const char* name, std::vector<int>& value);
  virtual bool GetUniform(const char* name, std::vector<float>& value);


  virtual void SetUniformi(const char* name, int v);
  virtual void SetUniformf(const char* name, float v);
  virtual void SetUniform2i(const char* name, const int v[2]);
  virtual void SetUniform2f(const char* name, const float v[2]);
  virtual void SetUniform3f(const char* name, const float v[3]);
  virtual void SetUniform4f(const char* name, const float v[4]);
  virtual void SetUniformMatrix3x3(const char* name, float* v);
  virtual void SetUniformMatrix4x4(const char* name, float* v);


  virtual void SetUniform1iv(const char* name, int count, const int* f);
  virtual void SetUniform1fv(const char* name, int count, const float* f);
  virtual void SetUniform2fv(const char* name, int count, const float (*f)[2]);
  virtual void SetUniform3fv(const char* name, int count, const float (*f)[3]);
  virtual void SetUniform4fv(const char* name, int count, const float (*f)[4]);
  virtual void SetUniformMatrix4x4v(const char* name, int count, float* v);


  virtual void SetUniform3f(const char* name, const double v[3]);
  virtual void SetUniform3uc(const char* name, const unsigned char v[3]); // maybe remove
  virtual void SetUniform4uc(const char* name, const unsigned char v[4]); // maybe remove
  virtual void SetUniformMatrix(const char* name, vtkMatrix3x3* v);
  virtual void SetUniformMatrix(const char* name, vtkMatrix4x4* v);


  virtual bool GetUniformi(const char* name, int& v);
  virtual bool GetUniformf(const char* name, float& v);
  virtual bool GetUniform2i(const char* name, int v[2]);
  virtual bool GetUniform2f(const char* name, float v[2]);
  virtual bool GetUniform3f(const char* name, float v[3]);
  virtual bool GetUniform4f(const char* name, float v[4]);
  virtual bool GetUniformMatrix3x3(const char* name, float* v);
  virtual bool GetUniformMatrix4x4(const char* name, float* v);


  virtual bool GetUniform3f(const char* name, double v[3]);
  virtual bool GetUniform3uc(const char* name, unsigned char v[3]);
  virtual bool GetUniform4uc(const char* name, unsigned char v[4]);
  virtual bool GetUniformMatrix(const char* name, vtkMatrix3x3* v);
  virtual bool GetUniformMatrix(const char* name, vtkMatrix4x4* v);


  virtual bool GetUniform1iv(const char* name, std::vector<int>& f);
  virtual bool GetUniform1fv(const char* name, std::vector<float>& f);
  virtual bool GetUniform2fv(const char* name, std::vector<float>& f);
  virtual bool GetUniform3fv(const char* name, std::vector<float>& f);
  virtual bool GetUniform4fv(const char* name, std::vector<float>& f);
  virtual bool GetUniformMatrix4x4v(const char* name, std::vector<float>& f);

  virtual int GetNumberOfUniforms();

  virtual const char* GetNthUniformName(vtkIdType uniformIndex);

  virtual int GetUniformScalarType(const char* name);

  virtual TupleType GetUniformTupleType(const char* name);

  virtual int GetUniformNumberOfComponents(const char* name);

  virtual int GetUniformNumberOfTuples(const char* name);

protected:
  vtkUniforms() = default;
  ~vtkUniforms() override = default;

private:
  vtkUniforms(const vtkUniforms&) = delete;
  void operator=(const vtkUniforms&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif