#include <Engine/Data/PlainMaterial.hpp>

Inheritance diagram for Ra::Engine::Data::PlainMaterial:

Collaboration diagram for Ra::Engine::Data::PlainMaterial:

Public Member Functions
	PlainMaterial (const std::string &instanceName)

	~PlainMaterial () override=default

void	updateFromParameters () override
	Update the attributes of the ShaderParameterProvider to their actual values stored in the renderParameters.

nlohmann::json	getParametersMetadata () const override
	Get a json containing metadata about the parameters.

Public Member Functions inherited from Ra::Engine::Data::SimpleMaterial
	SimpleMaterial (const std::string &instanceName, const std::string &materialName, MaterialAspect aspect=MaterialAspect::MAT_OPAQUE)
	Construct a named material.

void	updateGL () override final
	Update the openGL state of the material.

void	setColoredByVertexAttrib (bool state) override
	Makes the Material take its base color from the VERTEX_COLOR attribute of the rendered geometry.

bool	isColoredByVertexAttrib () const override
	Indicates if the material takes the VERTEX_COLOR attribute into account.

void	setColor (Core::Utils::Color c)

Public Member Functions inherited from Ra::Engine::Data::Material
virtual	~Material ()=default

const std::string &	getInstanceName () const

const std::string &	getMaterialName () const

void	setMaterialAspect (const MaterialAspect &aspect)

const MaterialAspect &	getMaterialAspect () const
	Get the aspect (MAT_OPAQUE or MAT_TRANSPARENT) of the material.

virtual bool	isTransparent () const

std::list< std::string >	getPropertyList () const override
	Get the list of properties the material migh use in a shader.

void	needUpdate ()
	Mark the Material as needing update before the next OpenGL call.

Public Member Functions inherited from Ra::Engine::Data::ShaderParameterProvider
virtual RenderParameters &	getParameters ()

virtual const RenderParameters &	getParameters () const

Public Member Functions inherited from Ra::Engine::Data::ParameterSetEditingInterface
Public Member Functions inherited from Ra::Engine::Data::MaterialTextureSet< TextureSemantics::SimpleMaterial >
void	addTexture (const TextureSemantics::SimpleMaterial &semantic, const TextureManager::TextureHandle &texture)

void	addTexture (const TextureSemantics::SimpleMaterial &semantic, const TextureParameters &texture)
	Add texture to TextureManager fisrt, then to the texture set.

Texture *	getTexture (const TextureSemantics::SimpleMaterial &semantic) const
	Texture getter from semantic.

Static Public Member Functions
static void	registerMaterial ()

static void	unregisterMaterial ()

Static Public Member Functions inherited from Ra::Engine::Data::ParameterSetEditingInterface
static void	loadMetaData (const std::string &basename, nlohmann::json &destination)
	Load the ParameterSet description.

Additional Inherited Members
Public Types inherited from Ra::Engine::Data::SimpleMaterial
using	TextureSemantic = TextureSemantics::SimpleMaterial

Public Types inherited from Ra::Engine::Data::Material
enum class	MaterialAspect { MAT_OPAQUE , MAT_TRANSPARENT , MAT_DENSITY }
	Identifies the type of the material. More...

Protected Member Functions inherited from Ra::Engine::Data::Material
	Material (const std::string &instanceName, const std::string &materialName, MaterialAspect aspect=MaterialAspect::MAT_OPAQUE)
	Creates a named material with the given aspect.

void	setMaterialName (std::string newName)
	Change the material name.

bool	isDirty ()
	Return dirty state.

void	setDirty ()
	Set dirty state to true.

void	setClean ()
	Set dirty state to false.

Static Protected Member Functions inherited from Ra::Engine::Data::SimpleMaterial
static void	loadMetaData (nlohmann::json &destination)
	Load the material parameter description.

Detailed Description

Implementation of the Plain Material BSDF. This material implements a flat color rendering. This material could not be loaded from a file and must be defined and associated to renderobjects programatically.

This Material is parameterized either globally, by setting the m_color base color or locally, by setting a vertex color attribute that define the per vertex color and setting m_perVertexColor to true.

Definition at line 19 of file PlainMaterial.hpp.

Constructor & Destructor Documentation

◆ PlainMaterial()

Ra::Engine::Data::PlainMaterial::PlainMaterial ( const std::string & instanceName )

explicit

Construct a named Plain material

Parameters

name	The name of the material

Definition at line 19 of file PlainMaterial.cpp.

◆ ~PlainMaterial()

Ra::Engine::Data::PlainMaterial::~PlainMaterial ( )

overridedefault

Destructor.

Note: The material does not have ownership on its texture nor its shaders. This destructor do not delete the associated textures and the corresponding shaders.

Member Function Documentation

◆ getParametersMetadata()

nlohmann::json Ra::Engine::Data::PlainMaterial::getParametersMetadata ( ) const

overridevirtual

Get a json containing metadata about the parameters.

Returns: the metadata in json format

Implements Ra::Engine::Data::ParameterSetEditingInterface.

Definition at line 68 of file PlainMaterial.cpp.

◆ registerMaterial()

void Ra::Engine::Data::PlainMaterial::registerMaterial ( )

static

Register the material in the material library. After registration, the material could be instantiated by any Radium system, renderer, plugin, ...

Definition at line 22 of file PlainMaterial.cpp.

Here is the call graph for this function:

◆ unregisterMaterial()

void Ra::Engine::Data::PlainMaterial::unregisterMaterial ( )

static

Remove the material from the material library. After removal, the material is no more available, ...

Definition at line 58 of file PlainMaterial.cpp.

◆ updateFromParameters()

void Ra::Engine::Data::PlainMaterial::updateFromParameters ( )

overridevirtual

Update the attributes of the ShaderParameterProvider to their actual values stored in the renderParameters.

Reimplemented from Ra::Engine::Data::ShaderParameterProvider.

Definition at line 62 of file PlainMaterial.cpp.