RenderMaterial.h

Go to the documentation of this file.

/*
Copyright 2007-2025. Algoryx Simulation AB.
 
All AGX source code, intellectual property, documentation, sample code,
tutorials, scene files and technical white papers, are copyrighted, proprietary
and confidential material of Algoryx Simulation AB. You may not download, read,
store, distribute, publish, copy or otherwise disseminate, use or expose this
material unless having a written signed agreement with Algoryx Simulation AB, or having been
advised so by Algoryx Simulation AB for a time limited evaluation, or having purchased a
valid commercial license from Algoryx Simulation AB.
 
Algoryx Simulation AB disclaims all responsibilities for loss or damage caused
from using this software, unless otherwise stated in written agreements with
Algoryx Simulation AB.
*/
 
#pragma once
 
#include <agx/agxPhysics_export.h>
#include <agx/Referenced.h>
#include <agx/Vec4.h>
#include <agxStream/Serializable.h>
#include <agxCollide/TextureData.h>
 
namespace agxCollide
{
 
   AGX_DECLARE_POINTER_TYPES(RenderMaterial);
 
  class AGXPHYSICS_EXPORT RenderMaterial : public agx::Referenced, public agxStream::Serializable
  {
    public:
 
      enum TextureMode
      {
        DIFFUSE_TEXTURE=0,
        NORMALMAP_TEXTURE = 1,
        HEIGHTMAP_TEXTURE = 2,
        ROUGHNESS_TEXTURE = 3,
        METALLIC_TEXTURE = 4,
        NUM_TEXTURE_MODES=5
      };
 
    RenderMaterial();
 
    void setName( const agx::String& name );
 
    agx::String getName() const;
 
    void setTransparency( float transparency );
 
    bool hasTransparency() const;
 
    float getTransparency() const;
 
    void setRoughness( float roughness );
 
    bool hasRoughness() const;
 
    float getShininess() const;
 
    float getRoughness() const;
 
    void setMetallic( float metallic );
 
    bool hasMetallic() const;
 
    float getMetallic() const;
 
    void setDiffuseColor( const agx::Vec4f& color );
 
    bool hasDiffuseColor() const;
 
    agx::Vec4f getDiffuseColor() const;
 
    void setSpecularColor( const agx::Vec4f& color );
 
    bool hasSpecularColor() const;
 
    agx::Vec4f getSpecularColor() const;
 
    void setAmbientColor( const agx::Vec4f& color );
 
    bool hasAmbientColor() const;
 
    agx::Vec4f getAmbientColor() const;
 
    void setEmissiveColor( const agx::Vec4f& color );
 
    bool hasEmissiveColor() const;
 
    agx::Vec4f getEmissiveColor() const;
 
    void setMaterialSpecification( const agx::String& material );
 
    agx::String getMaterialSpecification() const;
 
    bool hasMaterialSpecification() const;
 
 
    void setTexturePath( const agx::String& path,  TextureMode mode = DIFFUSE_TEXTURE);
 
    agx::String getTexturePath(TextureMode mode = DIFFUSE_TEXTURE) const;
 
    bool hasTexturePath(TextureMode mode = DIFFUSE_TEXTURE) const;
 
    void setTextureData(TextureDataRef data, TextureMode mode = DIFFUSE_TEXTURE);
 
    TextureDataRef getTextureData(TextureMode mode = DIFFUSE_TEXTURE) const;
 
    bool hasTextureData(TextureMode mode = DIFFUSE_TEXTURE) const;
 
#ifndef SWIG
      AGXSTREAM_DECLARE_SERIALIZABLE(agxCollide::RenderMaterial );
#endif
 
      bool equal(const RenderMaterial& other) const;
 
      bool operator ==(const RenderMaterial& other) const;
 
 
      int compare(const RenderMaterial& other) const;
 
 
      agx::UInt32 getHash() const;
 
      RenderMaterial* clone() const;
 
    protected:
 
      agx::String toString() const;
 
      virtual ~RenderMaterial();
 
      agx::String m_materialSpecification;
      agx::Vec4f m_diffuseColor;
      agx::Vec4f m_specularColor;
      agx::Vec4f m_ambientColor;
      agx::Vec4f m_emissiveColor;
      float m_transparency;
      float m_roughness;
      float m_metallic;
      agx::String m_name;
      agx::StringVector m_texturePaths;
      agx::Vector<TextureDataRef> m_textureDatas;
  };
 
 
  typedef agx::HashTable<agx::UInt32, RenderMaterialRef> RenderMaterialValueHashTable;
}