Represents a surface material of a Geometry. More...

#include <gz/rendering/Material.hh>

Public Member Functions
virtual	~Material ()
	Destructor. More...

virtual double	AlphaThreshold () const =0
	Get the alpha threshold. More...

virtual math::Color	Ambient () const =0
	Get the ambient color. More...

virtual bool	CastShadows () const =0
	Determine if this material casts shadows. More...

virtual void	ClearEmissiveMap ()=0
	Removes any emissive map mapped to this material. More...

virtual void	ClearEnvironmentMap ()=0
	Removes any environment map mapped to this material. More...

virtual void	ClearLightMap ()=0
	Removes any light map mapped to this material. More...

virtual void	ClearMetalnessMap ()=0
	Removes any metalness map mapped to this material. More...

virtual void	ClearNormalMap ()=0
	Removes any normal map mapped to this material. More...

virtual void	ClearRoughnessMap ()=0
	Removes any roughness map mapped to this material. More...

virtual void	ClearTexture ()=0
	Removes any texture mapped to this material. More...

virtual MaterialPtr	Clone (const std::string &_name="") const =0
	Clone this material. More...

virtual void	CopyFrom (const common::Material &_material)=0
	Copy properties from given Material. More...

virtual void	CopyFrom (ConstMaterialPtr _material)=0
	Copy properties from given Material. More...

virtual bool	DepthCheckEnabled () const =0
	Determine if depth buffer checking is enabled. More...

virtual bool	DepthWriteEnabled () const =0
	Determine if depth buffer writing is enabled. More...

virtual math::Color	Diffuse () const =0
	Get the diffuse color. More...

virtual math::Color	Emissive () const =0
	Get the emissive color. More...

virtual std::string	EmissiveMap () const =0
	Get the URI of the emissive map file. More...

virtual std::shared_ptr< const common::Image >	EmissiveMapData () const =0
	Get the emissive map data. More...

virtual std::string	EnvironmentMap () const =0
	Get the URI of the environment map file. More...

virtual std::shared_ptr< const common::Image >	EnvironmentMapData () const =0
	Get the environment map data. More...

virtual std::string	FragmentShader () const =0
	Get path to the fragment shader. More...

virtual ShaderParamsPtr	FragmentShaderParams ()=0
	Get params for the fragment shader. More...

virtual bool	HasEmissiveMap () const =0
	Determine if this material has an emissive map. More...

virtual bool	HasEnvironmentMap () const =0
	Determine if this material has a environment map. More...

virtual bool	HasLightMap () const =0
	Determine if this material has a light map. More...

virtual bool	HasMetalnessMap () const =0
	Determine if this material has a metalness map. More...

virtual bool	HasNormalMap () const =0
	Determine if this material has a normal map. More...

virtual bool	HasRoughnessMap () const =0
	Determine if this material has a roughness map. More...

virtual bool	HasTexture () const =0
	Determine if this material has a texture. More...

virtual bool	LightingEnabled () const =0
	Determine if lighting affects this material. More...

virtual std::string	LightMap () const =0
	Get the URI of the light map file. More...

virtual std::shared_ptr< const common::Image >	LightMapData () const =0
	Get the light map data. More...

virtual unsigned int	LightMapTexCoordSet () const =0
	Get the texture coordinate set used by lightmap. More...

virtual float	Metalness () const =0
	Get the metalness value of this material. More...

virtual std::string	MetalnessMap () const =0
	Get the URI of the metalness map file. More...

virtual std::shared_ptr< const common::Image >	MetalnessMapData () const =0
	Get the metalness map data. More...

virtual std::string	NormalMap () const =0
	Get the URI of the normal map file. More...

virtual std::shared_ptr< const common::Image >	NormalMapData () const =0
	Get the normal map data. More...

virtual bool	ReceiveShadows () const =0
	Determine if this material receives shadows. More...

virtual bool	ReflectionEnabled () const =0
	Determine if this material has a reflection. More...

virtual double	Reflectivity () const =0
	Get the reflectivity value. More...

virtual float	RenderOrder () const =0
	Get the render order value of this material. More...

virtual float	Roughness () const =0
	Get the roughness value of this material. More...

virtual std::string	RoughnessMap () const =0
	Get the URI of the roughness map file. More...

virtual std::shared_ptr< const common::Image >	RoughnessMapData () const =0
	Get the roughness map data. More...

virtual void	SetAlphaFromTexture (bool _enabled, double _alpha=0.5, bool _twoSided=true)=0
	Set the material to use the alpha channel from the textures. More...

virtual void	SetAmbient (const double _r, const double _g, const double _b, const double _a=1.0)=0
	Set the ambient color. More...

virtual void	SetAmbient (const math::Color &_color)=0
	Set the ambient color. More...

virtual void	SetCastShadows (const bool _castShadows)=0
	Specify if this material casts shadows. More...

virtual void	SetDepthCheckEnabled (bool _enabled)=0
	Specify if depth buffer checking is enabled. More...

virtual void	SetDepthMaterial (const double far, const double near)=0
	Configuration for Depth Material. More...

virtual void	SetDepthWriteEnabled (bool _enabled)=0
	Specify if depth buffer writing is enabled. More...

virtual void	SetDiffuse (const double _r, const double _g, const double _b, const double _a=1.0)=0
	Set the diffuse color. More...

virtual void	SetDiffuse (const math::Color &_color)=0
	Set the diffuse color. More...

virtual void	SetEmissive (const double _r, const double _g, const double _b, const double _a=1.0)=0
	Set the emissive color. More...

virtual void	SetEmissive (const math::Color &_color)=0
	Set the emissive color. More...

virtual void	SetEmissiveMap (const std::string &_emissiveMap)
	Set the material emissive map. More...

virtual void	SetEmissiveMap (const std::string &_emissiveMap, const std::shared_ptr< const common::Image > &_img)
	Set the material emissive map. More...

virtual void	SetEnvironmentMap (const std::string &_environmentMap)
	Set the material environment map. More...

virtual void	SetEnvironmentMap (const std::string &_environmentMap, const std::shared_ptr< const common::Image > &_img)
	Set the material environment map. More...

virtual void	SetFragmentShader (const std::string &_path)=0
	Set the fragment shader. More...

virtual void	SetLightingEnabled (const bool _enabled)=0
	Specify if lighting affects this material. More...

virtual void	SetLightMap (const std::string &_lightMap, const std::shared_ptr< const common::Image > &_img, unsigned int _uvSet=0)
	Set the material light map from an image loaded in memory. More...

virtual void	SetLightMap (const std::string &_lightMap, unsigned int _uvSet=0u)
	Set the material light map. More...

virtual void	SetMetalness (const float _metalness)=0
	Set the metalness value. Only affects material of type MT_PBS. More...

virtual void	SetMetalnessMap (const std::string &_metalnessMap)
	Set the material metalness map. More...

virtual void	SetMetalnessMap (const std::string &_metalnessMap, const std::shared_ptr< const common::Image > &_img)
	Set the material metalness map. More...

virtual void	SetNormalMap (const std::string &_normalMap)
	Set the material normal map. More...

virtual void	SetNormalMap (const std::string &_normalMap, const std::shared_ptr< const common::Image > &_img)
	Set the material normal map. More...

virtual void	SetReceiveShadows (const bool _receiveShadows)=0
	Specify if this material receives shadows. More...

virtual void	SetReflectionEnabled (const bool _enabled)=0
	Specify if this material has a reflection. More...

virtual void	SetReflectivity (const double _reflectivity)=0
	Set the reflectivity value. More...

virtual void	SetRenderOrder (const float _renderOrder)=0
	Set the render order. When polygons are coplanar, you can get problems with 'depth fighting' where the pixels from the two polys compete for the same screen pixel. This param help to avoid this problem. More...

virtual void	SetRoughness (const float _roughness)=0
	Set the roughness value. Only affects material of type MT_PBS. More...

virtual void	SetRoughnessMap (const std::string &_roughnessMap)
	Set the material roughness map. More...

virtual void	SetRoughnessMap (const std::string &_roughnessMap, const std::shared_ptr< const common::Image > &_img)
	Set the material roughness map. More...

virtual void	SetShaderType (enum ShaderType _type)=0
	Set the ShaderType value. More...

virtual void	SetShininess (const double _shininess)=0
	Set the shininess value. More...

virtual void	SetSpecular (const double _r, const double _g, const double _b, const double _a=1.0)=0
	Set the specular color. More...

virtual void	SetSpecular (const math::Color &_color)=0
	Set the specular color. More...

virtual void	SetTexture (const std::string &_texture)
	Set the material texture. More...

virtual void	SetTexture (const std::string &_texture, const std::shared_ptr< const common::Image > &_img)
	Set the material texture. More...

virtual void	SetTransparency (const double _transparency)=0
	Set the transparency value. More...

virtual void	SetVertexShader (const std::string &_path)=0
	Set the vertex shader. More...

virtual enum ShaderType	ShaderType () const =0
	Get the ShaderType value. More...

virtual double	Shininess () const =0
	Get the shininess value. More...

virtual math::Color	Specular () const =0
	Get the specular color. More...

virtual std::string	Texture () const =0
	Get the URI of the texture file. More...

virtual bool	TextureAlphaEnabled () const =0
	Get the enable alpha from textures. More...

virtual std::shared_ptr< const common::Image >	TextureData () const =0
	Get the texture data. More...

virtual double	Transparency () const =0
	Get the transparency value. More...

virtual bool	TwoSidedEnabled () const =0
	Get the enable two sided rendering value. More...

virtual enum MaterialType	Type () const =0
	Removes any metalness map mapped to this material. More...

virtual std::string	VertexShader () const =0
	Get path to the vertex shader. More...

virtual ShaderParamsPtr	VertexShaderParams ()=0
	Get params for the vertex shader. More...

Public Member Functions inherited from Object
virtual	~Object ()
	Destructor. More...

virtual void	Destroy ()=0
	Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More...

virtual unsigned int	Id () const =0
	Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...

virtual std::string	Name () const =0
	Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...

virtual void	PostRender ()=0
	Post process this object and any of its children after rendering. More...

virtual void	PreRender ()=0
	Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender. More...

virtual ScenePtr	Scene () const =0
	Get the Scene that created this object. More...

Detailed Description

Represents a surface material of a Geometry.

Constructor & Destructor Documentation

◆ ~Material()

virtual ~Material ( )

virtual

Destructor.

Member Function Documentation

◆ AlphaThreshold()

virtual double AlphaThreshold ( ) const

pure virtual

Get the alpha threshold.

Returns: The alpha threshold value

Implemented in BaseMaterial< T >.

◆ Ambient()

virtual math::Color Ambient ( ) const

pure virtual

Get the ambient color.

Returns: The ambient color

Implemented in BaseMaterial< T >, and OgreMaterial.

◆ CastShadows()

virtual bool CastShadows ( ) const

pure virtual

Determine if this material casts shadows.

Returns: True if this material casts shadows

Implemented in BaseMaterial< T >, and OgreMaterial.

◆ ClearEmissiveMap()

virtual void ClearEmissiveMap ( )

pure virtual

Removes any emissive map mapped to this material.

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and Ogre2Material.

◆ ClearEnvironmentMap()

virtual void ClearEnvironmentMap ( )

pure virtual

Removes any environment map mapped to this material.

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and Ogre2Material.

◆ ClearLightMap()

virtual void ClearLightMap ( )

pure virtual

Removes any light map mapped to this material.

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and Ogre2Material.

◆ ClearMetalnessMap()

virtual void ClearMetalnessMap ( )

pure virtual

Removes any metalness map mapped to this material.

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and Ogre2Material.

◆ ClearNormalMap()

virtual void ClearNormalMap ( )

pure virtual

Removes any normal map mapped to this material.

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, OgreMaterial, and Ogre2Material.

◆ ClearRoughnessMap()

virtual void ClearRoughnessMap ( )

pure virtual

Removes any roughness map mapped to this material.

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and Ogre2Material.

◆ ClearTexture()

virtual void ClearTexture ( )

pure virtual

Removes any texture mapped to this material.

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, OgreMaterial, and Ogre2Material.

◆ Clone()

virtual MaterialPtr Clone ( const std::string & _name = "" ) const

pure virtual

Clone this material.

Returns: New cloned material

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, and BaseMaterial< OgreObject >.

◆ CopyFrom() [1/2]

virtual void CopyFrom ( const common::Material & _material )

pure virtual

Copy properties from given Material.

Parameters

[in] _material Source Material to be copied from

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, and BaseMaterial< OgreObject >.

◆ CopyFrom() [2/2]

virtual void CopyFrom ( ConstMaterialPtr _material )

pure virtual

Copy properties from given Material.

Parameters

[in] _material Source Material to be copied from

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, and BaseMaterial< OgreObject >.

◆ DepthCheckEnabled()

virtual bool DepthCheckEnabled ( ) const

pure virtual

Determine if depth buffer checking is enabled.

Returns: True if depth check is enabled

Implemented in Ogre2Material, BaseMaterial< T >, and OgreMaterial.

◆ DepthWriteEnabled()

virtual bool DepthWriteEnabled ( ) const

pure virtual

Determine if depth buffer writing is enabled.

Returns: True if depth buffer writing is enabled

Implemented in Ogre2Material, BaseMaterial< T >, and OgreMaterial.

◆ Diffuse()

virtual math::Color Diffuse ( ) const

pure virtual

Get the diffuse color.

Returns: The diffuse color

Implemented in BaseMaterial< T >, OgreMaterial, and Ogre2Material.

◆ Emissive()

virtual math::Color Emissive ( ) const

pure virtual

Get the emissive color.

Returns: The emissive color

Implemented in BaseMaterial< T >, OgreMaterial, and Ogre2Material.

◆ EmissiveMap()

virtual std::string EmissiveMap ( ) const

pure virtual

Get the URI of the emissive map file.

Returns: URI of the emissive map file

Implemented in BaseMaterial< T >, and Ogre2Material.

◆ EmissiveMapData()

virtual std::shared_ptr<const common::Image> EmissiveMapData ( ) const

pure virtual

Get the emissive map data.

Returns: Pointer to the common::Image with the data if the texture was loaded from memory

Implemented in BaseMaterial< T >, and Ogre2Material.

◆ EnvironmentMap()

virtual std::string EnvironmentMap ( ) const

pure virtual

Get the URI of the environment map file.

Returns: URI of the environment map file

Implemented in BaseMaterial< T >, and Ogre2Material.

◆ EnvironmentMapData()

virtual std::shared_ptr<const common::Image> EnvironmentMapData ( ) const

pure virtual

Get the environment map data.

Returns: Pointer to the common::Image with the data if the texture was loaded from memory

Implemented in BaseMaterial< T >, and Ogre2Material.

◆ FragmentShader()

virtual std::string FragmentShader ( ) const

pure virtual

Get path to the fragment shader.

Returns: Path to fragment shader

Implemented in BaseMaterial< T >, Ogre2Material, and OgreMaterial.

◆ FragmentShaderParams()

virtual ShaderParamsPtr FragmentShaderParams ( )

pure virtual

Get params for the fragment shader.

Returns: editable parameters

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, Ogre2Material, and OgreMaterial.

◆ HasEmissiveMap()

virtual bool HasEmissiveMap ( ) const

pure virtual

Determine if this material has an emissive map.

Returns: True if this material has an emissive map

Implemented in BaseMaterial< T >, and Ogre2Material.

◆ HasEnvironmentMap()

virtual bool HasEnvironmentMap ( ) const

pure virtual

Determine if this material has a environment map.

Returns: True if this material has a environment map

Implemented in BaseMaterial< T >, and Ogre2Material.

◆ HasLightMap()

virtual bool HasLightMap ( ) const

pure virtual

Determine if this material has a light map.

Returns: True if this material has a light map

Implemented in BaseMaterial< T >, and Ogre2Material.

◆ HasMetalnessMap()

virtual bool HasMetalnessMap ( ) const

pure virtual

Determine if this material has a metalness map.

Returns: True if this material has a metalness map

Implemented in BaseMaterial< T >, and Ogre2Material.

◆ HasNormalMap()

virtual bool HasNormalMap ( ) const

pure virtual

Determine if this material has a normal map.

Returns: True if this material has a normal map

Implemented in BaseMaterial< T >, OgreMaterial, and Ogre2Material.

◆ HasRoughnessMap()

virtual bool HasRoughnessMap ( ) const

pure virtual

Determine if this material has a roughness map.

Returns: True if this material has a roughness map

Implemented in BaseMaterial< T >, and Ogre2Material.

◆ HasTexture()

virtual bool HasTexture ( ) const

pure virtual

Determine if this material has a texture.

Returns: True if this material has a texture

Implemented in BaseMaterial< T >, OgreMaterial, and Ogre2Material.

◆ LightingEnabled()

virtual bool LightingEnabled ( ) const

pure virtual

Determine if lighting affects this material.

Returns: True if lighting affects this material

Implemented in BaseMaterial< T >, and OgreMaterial.

◆ LightMap()

virtual std::string LightMap ( ) const

pure virtual

Get the URI of the light map file.

Returns: URI of the light map file

Implemented in BaseMaterial< T >, and Ogre2Material.

◆ LightMapData()

virtual std::shared_ptr<const common::Image> LightMapData ( ) const

pure virtual

Get the light map data.

Returns: Pointer to the common::Image with the data if the texture was loaded from memory

Implemented in BaseMaterial< T >, and Ogre2Material.

◆ LightMapTexCoordSet()

virtual unsigned int LightMapTexCoordSet ( ) const

pure virtual

Get the texture coordinate set used by lightmap.

Returns: texture coordinate set of the light map

Implemented in BaseMaterial< T >, and Ogre2Material.

◆ Metalness()

virtual float Metalness ( ) const

pure virtual

Get the metalness value of this material.

Returns: Material metalness

Implemented in BaseMaterial< T >, and Ogre2Material.

◆ MetalnessMap()

virtual std::string MetalnessMap ( ) const

pure virtual

Get the URI of the metalness map file.

Returns: URI of the metalness map file

Implemented in BaseMaterial< T >, and Ogre2Material.

◆ MetalnessMapData()

virtual std::shared_ptr<const common::Image> MetalnessMapData ( ) const

pure virtual

Get the metalness map data.

Returns: Pointer to the common::Image with the data if the texture was loaded from memory

Implemented in BaseMaterial< T >, and Ogre2Material.

◆ NormalMap()

virtual std::string NormalMap ( ) const

pure virtual

Get the URI of the normal map file.

Returns: URI of the normal map file

Implemented in BaseMaterial< T >, OgreMaterial, and Ogre2Material.

◆ NormalMapData()

virtual std::shared_ptr<const common::Image> NormalMapData ( ) const

pure virtual

Get the normal map data.

Returns: Pointer to the common::Image with the data if the texture was loaded from memory

Implemented in BaseMaterial< T >, OgreMaterial, and Ogre2Material.

◆ ReceiveShadows()

virtual bool ReceiveShadows ( ) const

pure virtual

Determine if this material receives shadows.

Returns: True if this material receives shadows

Implemented in BaseMaterial< T >, OgreMaterial, and Ogre2Material.

◆ ReflectionEnabled()

virtual bool ReflectionEnabled ( ) const

pure virtual

Determine if this material has a reflection.

Returns: True if this material has a reflection

Implemented in BaseMaterial< T >, and OgreMaterial.

◆ Reflectivity()

virtual double Reflectivity ( ) const

pure virtual

Get the reflectivity value.

Returns: The reflectivity value

Implemented in BaseMaterial< T >, and OgreMaterial.

◆ RenderOrder()

virtual float RenderOrder ( ) const

pure virtual

Get the render order value of this material.

Returns: Material render order

Implemented in BaseMaterial< T >, OgreMaterial, and Ogre2Material.

◆ Roughness()

virtual float Roughness ( ) const

pure virtual

Get the roughness value of this material.

Returns: Material roughness

Implemented in BaseMaterial< T >, and Ogre2Material.

◆ RoughnessMap()

virtual std::string RoughnessMap ( ) const

pure virtual

Get the URI of the roughness map file.

Returns: URI of the roughness map file

Implemented in BaseMaterial< T >, and Ogre2Material.

◆ RoughnessMapData()

virtual std::shared_ptr<const common::Image> RoughnessMapData ( ) const

pure virtual

Get the roughness map data.

Returns: Pointer to the common::Image with the data if the texture was loaded from memory

Implemented in BaseMaterial< T >, and Ogre2Material.

◆ SetAlphaFromTexture()

virtual void SetAlphaFromTexture	(	bool	_enabled,
		double	_alpha = `0.5`,
		bool	_twoSided = `true`
	)

pure virtual

Set the material to use the alpha channel from the textures.

Parameters

[in]	_enabled	Enable alpha channel based rendering
[in]	_alpha	Set the alpha threshold value
[in]	_twoSided	Enable two sided rendering

Implemented in OgreMaterial, Ogre2Material, BaseMaterial< T >, BaseMaterial< Ogre2Object >, and BaseMaterial< OgreObject >.

◆ SetAmbient() [1/2]

virtual void SetAmbient	(	const double	_r,
		const double	_g,
		const double	_b,
		const double	_a = `1.0`
	)

pure virtual

Set the ambient color.

Parameters

[in]	_r	Red value
[in]	_g	Green value
[in]	_b	Blue value
[in]	_a	Alpha value

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, and BaseMaterial< OgreObject >.

◆ SetAmbient() [2/2]

virtual void SetAmbient ( const math::Color & _color )

pure virtual

Set the ambient color.

Parameters

[in] _color New ambient color

Implemented in OgreMaterial, BaseMaterial< T >, BaseMaterial< Ogre2Object >, and BaseMaterial< OgreObject >.

◆ SetCastShadows()

virtual void SetCastShadows ( const bool _castShadows )

pure virtual

Specify if this material casts shadows.

Parameters

[in] _castShadows True if this material casts shadows

Implemented in OgreMaterial, BaseMaterial< T >, BaseMaterial< Ogre2Object >, and BaseMaterial< OgreObject >.

◆ SetDepthCheckEnabled()

virtual void SetDepthCheckEnabled ( bool _enabled )

pure virtual

Specify if depth buffer checking is enabled.

Parameters

[in] _enabled True if depth check is enabled

Implemented in Ogre2Material, BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and OgreMaterial.

◆ SetDepthMaterial()

virtual void SetDepthMaterial	(	const double	far,
		const double	near
	)

pure virtual

Configuration for Depth Material.

Parameters

[in]	far	Far distance for normalized output
[in]	near	Near distance for normalized output

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and OgreMaterial.

◆ SetDepthWriteEnabled()

virtual void SetDepthWriteEnabled ( bool _enabled )

pure virtual

Specify if depth buffer writing is enabled.

Parameters

[in] _enabled True if depth buffer writing is enabled

Implemented in Ogre2Material, BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and OgreMaterial.

◆ SetDiffuse() [1/2]

virtual void SetDiffuse	(	const double	_r,
		const double	_g,
		const double	_b,
		const double	_a = `1.0`
	)

pure virtual

Set the diffuse color.

Parameters

[in]	_r	Red value
[in]	_g	Green value
[in]	_b	Blue value
[in]	_a	Alpha value

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, and BaseMaterial< OgreObject >.

◆ SetDiffuse() [2/2]

virtual void SetDiffuse ( const math::Color & _color )

pure virtual

Set the diffuse color.

Parameters

[in] _color New diffuse color

Implemented in OgreMaterial, Ogre2Material, BaseMaterial< T >, BaseMaterial< Ogre2Object >, and BaseMaterial< OgreObject >.

◆ SetEmissive() [1/2]

virtual void SetEmissive	(	const double	_r,
		const double	_g,
		const double	_b,
		const double	_a = `1.0`
	)

pure virtual

Set the emissive color.

Parameters

[in]	_r	Red value
[in]	_g	Green value
[in]	_b	Blue value
[in]	_a	Alpha value

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, and BaseMaterial< OgreObject >.

◆ SetEmissive() [2/2]

virtual void SetEmissive ( const math::Color & _color )

pure virtual

Set the emissive color.

Parameters

[in] _color New emissive color

Implemented in OgreMaterial, Ogre2Material, BaseMaterial< T >, BaseMaterial< Ogre2Object >, and BaseMaterial< OgreObject >.

◆ SetEmissiveMap() [1/2]

virtual void SetEmissiveMap ( const std::string & _emissiveMap )

inlinevirtual

Set the material emissive map.

Parameters

[in] _emissiveMap Map URI of the new emissive map file

◆ SetEmissiveMap() [2/2]

virtual void SetEmissiveMap	(	const std::string &	_emissiveMap,
		const std::shared_ptr< const common::Image > &	_img
	)

inlinevirtual

Set the material emissive map.

Parameters

[in]	_emissiveMap	Map URI of the new emissive map file, or identifying name if map was set from raw data
[in]	_img	Image data, nullptr if the image should be loaded from a file

Reimplemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and Ogre2Material.

◆ SetEnvironmentMap() [1/2]

virtual void SetEnvironmentMap ( const std::string & _environmentMap )

inlinevirtual

Set the material environment map.

Parameters

[in] _environmentMap URI of the new environment map file

◆ SetEnvironmentMap() [2/2]

virtual void SetEnvironmentMap	(	const std::string &	_environmentMap,
		const std::shared_ptr< const common::Image > &	_img
	)

inlinevirtual

Set the material environment map.

Parameters

[in]	_environmentMap	URI of the new environment map file, or identifying name if map was set from raw data
[in]	_img	Image data, nullptr if the image should be loaded from a file

Reimplemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and Ogre2Material.

◆ SetFragmentShader()

virtual void SetFragmentShader ( const std::string & _path )

pure virtual

Set the fragment shader.

Parameters

[in] _path path to a file containing a glsl shader

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, Ogre2Material, and OgreMaterial.

◆ SetLightingEnabled()

virtual void SetLightingEnabled ( const bool _enabled )

pure virtual

Specify if lighting affects this material.

Parameters

[in] _enabled True if lighting affects this material

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and OgreMaterial.

◆ SetLightMap() [1/2]

virtual void SetLightMap	(	const std::string &	_lightMap,
		const std::shared_ptr< const common::Image > &	_img,
		unsigned int	_uvSet = `0`
	)

inlinevirtual

Set the material light map from an image loaded in memory.

Parameters

[in]	_lightMap	URI of the new light map file
[in]	_img	Image data, nullptr if the image should be loaded from a file
[in]	_uvSet	Texture coordinate set to use

Reimplemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and Ogre2Material.

◆ SetLightMap() [2/2]

virtual void SetLightMap	(	const std::string &	_lightMap,
		unsigned int	_uvSet = `0u`
	)

inlinevirtual

Set the material light map.

Parameters

[in]	_lightMap	URI of the new light map file
[in]	_uvSet	Texture coordinate set to use

◆ SetMetalness()

virtual void SetMetalness ( const float _metalness )

pure virtual

Set the metalness value. Only affects material of type MT_PBS.

Parameters

[in] _metalness Metalness to set to

Implemented in Ogre2Material, BaseMaterial< T >, BaseMaterial< Ogre2Object >, and BaseMaterial< OgreObject >.

◆ SetMetalnessMap() [1/2]

virtual void SetMetalnessMap ( const std::string & _metalnessMap )

inlinevirtual

Set the material metalness map.

Parameters

[in] _metalnessMap URI of the new metalness map file

◆ SetMetalnessMap() [2/2]

virtual void SetMetalnessMap	(	const std::string &	_metalnessMap,
		const std::shared_ptr< const common::Image > &	_img
	)

inlinevirtual

Set the material metalness map.

Parameters

[in]	_metalnessMap	URI of the new metalness map file, or identifying name if map was set from raw data
[in]	_img	Image data, nullptr if the image should be loaded from a file

Reimplemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and Ogre2Material.

◆ SetNormalMap() [1/2]

virtual void SetNormalMap ( const std::string & _normalMap )

inlinevirtual

Set the material normal map.

Parameters

[in] _normalMap URI of the new normal map file

◆ SetNormalMap() [2/2]

virtual void SetNormalMap	(	const std::string &	_normalMap,
		const std::shared_ptr< const common::Image > &	_img
	)

inlinevirtual

Set the material normal map.

Parameters

[in]	_normalMap	URI of the new normal map file, or identifying name if map was set from raw data
[in]	_img	Image data, nullptr if the image should be loaded from a file

Reimplemented in OgreMaterial, BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and Ogre2Material.

◆ SetReceiveShadows()

virtual void SetReceiveShadows ( const bool _receiveShadows )

pure virtual

Specify if this material receives shadows.

Parameters

[in] _receiveShadows True if this material receives shadows

Implemented in OgreMaterial, BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and Ogre2Material.

◆ SetReflectionEnabled()

virtual void SetReflectionEnabled ( const bool _enabled )

pure virtual

Specify if this material has a reflection.

Parameters

[in] _enabled True if this material has a reflection

Implemented in OgreMaterial, BaseMaterial< T >, BaseMaterial< Ogre2Object >, and BaseMaterial< OgreObject >.

◆ SetReflectivity()

virtual void SetReflectivity ( const double _reflectivity )

pure virtual

Set the reflectivity value.

Parameters

[in] _reflectivity New reflectivity value

Implemented in BaseMaterial< T >, OgreMaterial, BaseMaterial< Ogre2Object >, and BaseMaterial< OgreObject >.

◆ SetRenderOrder()

virtual void SetRenderOrder ( const float _renderOrder )

pure virtual

Set the render order. When polygons are coplanar, you can get problems with 'depth fighting' where the pixels from the two polys compete for the same screen pixel. This param help to avoid this problem.

Parameters

[in] _renderOrder Render order to set to

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, OgreMaterial, and Ogre2Material.

◆ SetRoughness()

virtual void SetRoughness ( const float _roughness )

pure virtual

Set the roughness value. Only affects material of type MT_PBS.

Parameters

[in] _roughness Roughness to set to

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and Ogre2Material.

◆ SetRoughnessMap() [1/2]

virtual void SetRoughnessMap ( const std::string & _roughnessMap )

inlinevirtual

Set the material roughness map.

Parameters

[in] _roughnessMap URI of the new roughness map file

◆ SetRoughnessMap() [2/2]

virtual void SetRoughnessMap	(	const std::string &	_roughnessMap,
		const std::shared_ptr< const common::Image > &	_img
	)

inlinevirtual

Set the material roughness map.

Parameters

[in]	_roughnessMap	URI of the new roughness map file, or identifying name if map was set from raw data
[in]	_img	Image data, nullptr if the image should be loaded from a file

Reimplemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and Ogre2Material.

◆ SetShaderType()

virtual void SetShaderType ( enum ShaderType _type )

pure virtual

Set the ShaderType value.

Parameters

[in] _type New ShaderType value

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and OgreMaterial.

◆ SetShininess()

virtual void SetShininess ( const double _shininess )

pure virtual

Set the shininess value.

Parameters

[in] _shininess New shininess value

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and OgreMaterial.

◆ SetSpecular() [1/2]

virtual void SetSpecular	(	const double	_r,
		const double	_g,
		const double	_b,
		const double	_a = `1.0`
	)

pure virtual

Set the specular color.

Parameters

[in]	_r	Red value
[in]	_g	Green value
[in]	_b	Blue value
[in]	_a	Alpha value

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, and BaseMaterial< OgreObject >.

◆ SetSpecular() [2/2]

virtual void SetSpecular ( const math::Color & _color )

pure virtual

Set the specular color.

Parameters

[in] _color New specular color

Implemented in OgreMaterial, Ogre2Material, BaseMaterial< T >, BaseMaterial< Ogre2Object >, and BaseMaterial< OgreObject >.

◆ SetTexture() [1/2]

virtual void SetTexture ( const std::string & _texture )

inlinevirtual

Set the material texture.

Parameters

[in] _texture URI of the new texture file or identifying name if _img is set

◆ SetTexture() [2/2]

virtual void SetTexture	(	const std::string &	_texture,
		const std::shared_ptr< const common::Image > &	_img
	)

inlinevirtual

Set the material texture.

Parameters

[in]	_texture	URI of the new texture file or identifying name if _img is set
[in]	_img	Image data, nullptr if the image should be loaded from a file

Reimplemented in OgreMaterial, BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, and Ogre2Material.

◆ SetTransparency()

virtual void SetTransparency ( const double _transparency )

pure virtual

Set the transparency value.

Parameters

[in] _transparency New transparency value

Implemented in OgreMaterial, Ogre2Material, BaseMaterial< T >, BaseMaterial< Ogre2Object >, and BaseMaterial< OgreObject >.

◆ SetVertexShader()

virtual void SetVertexShader ( const std::string & _path )

pure virtual

Set the vertex shader.

Parameters

[in] _path path to a file containing a glsl shader

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, Ogre2Material, and OgreMaterial.

◆ ShaderType()

virtual enum ShaderType ShaderType ( ) const

pure virtual

Get the ShaderType value.

Returns: The ShaderType value

Implemented in BaseMaterial< T >, and OgreMaterial.

◆ Shininess()

virtual double Shininess ( ) const

pure virtual

Get the shininess value.

Returns: The shininess value

Implemented in BaseMaterial< T >, and OgreMaterial.

◆ Specular()

virtual math::Color Specular ( ) const

pure virtual

Get the specular color.

Returns: The specular color

Implemented in BaseMaterial< T >, OgreMaterial, and Ogre2Material.

◆ Texture()

virtual std::string Texture ( ) const

pure virtual

Get the URI of the texture file.

Returns: URI of the texture file

Implemented in BaseMaterial< T >, OgreMaterial, and Ogre2Material.

◆ TextureAlphaEnabled()

virtual bool TextureAlphaEnabled ( ) const

pure virtual

Get the enable alpha from textures.

Returns: The enable alpha value

Implemented in BaseMaterial< T >.

◆ TextureData()

virtual std::shared_ptr<const common::Image> TextureData ( ) const

pure virtual

Get the texture data.

Returns: Pointer to the common::Image with the data if the texture was loaded from memory

Implemented in BaseMaterial< T >, OgreMaterial, and Ogre2Material.

◆ Transparency()

virtual double Transparency ( ) const

pure virtual

Get the transparency value.

Returns: The transparency value

Implemented in BaseMaterial< T >, and OgreMaterial.

◆ TwoSidedEnabled()

virtual bool TwoSidedEnabled ( ) const

pure virtual

Get the enable two sided rendering value.

Returns: The enable two sided rendering value

Implemented in BaseMaterial< T >.

◆ Type()

virtual enum MaterialType Type ( ) const

pure virtual

Removes any metalness map mapped to this material.

Implemented in BaseMaterial< T >, and Ogre2Material.

◆ VertexShader()

virtual std::string VertexShader ( ) const

pure virtual

Get path to the vertex shader.

Returns: Path to vertex shader

Implemented in BaseMaterial< T >, Ogre2Material, and OgreMaterial.

◆ VertexShaderParams()

virtual ShaderParamsPtr VertexShaderParams ( )

pure virtual

Get params for the vertex shader.

Returns: editable parameters

Implemented in BaseMaterial< T >, BaseMaterial< Ogre2Object >, BaseMaterial< OgreObject >, Ogre2Material, and OgreMaterial.

The documentation for this class was generated from the following file:

gz/rendering/Material.hh

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~Material()

Member Function Documentation

◆ AlphaThreshold()

◆ Ambient()

◆ CastShadows()

◆ ClearEmissiveMap()

◆ ClearEnvironmentMap()

◆ ClearLightMap()

◆ ClearMetalnessMap()

◆ ClearNormalMap()

◆ ClearRoughnessMap()

◆ ClearTexture()

◆ Clone()

◆ CopyFrom() [1/2]

◆ CopyFrom() [2/2]

◆ DepthCheckEnabled()

◆ DepthWriteEnabled()

◆ Diffuse()

◆ Emissive()

◆ EmissiveMap()

◆ EmissiveMapData()

◆ EnvironmentMap()

◆ EnvironmentMapData()

◆ FragmentShader()

◆ FragmentShaderParams()

◆ HasEmissiveMap()

◆ HasEnvironmentMap()

◆ HasLightMap()

◆ HasMetalnessMap()

◆ HasNormalMap()

◆ HasRoughnessMap()

◆ HasTexture()

◆ LightingEnabled()

◆ LightMap()

◆ LightMapData()

◆ LightMapTexCoordSet()

◆ Metalness()

◆ MetalnessMap()

◆ MetalnessMapData()

◆ NormalMap()

◆ NormalMapData()

◆ ReceiveShadows()

◆ ReflectionEnabled()

◆ Reflectivity()

◆ RenderOrder()

◆ Roughness()

◆ RoughnessMap()

◆ RoughnessMapData()

◆ SetAlphaFromTexture()

◆ SetAmbient() [1/2]

◆ SetAmbient() [2/2]

◆ SetCastShadows()

◆ SetDepthCheckEnabled()

◆ SetDepthMaterial()

◆ SetDepthWriteEnabled()

◆ SetDiffuse() [1/2]

◆ SetDiffuse() [2/2]

◆ SetEmissive() [1/2]

◆ SetEmissive() [2/2]

◆ SetEmissiveMap() [1/2]

◆ SetEmissiveMap() [2/2]

◆ SetEnvironmentMap() [1/2]

◆ SetEnvironmentMap() [2/2]

◆ SetFragmentShader()

◆ SetLightingEnabled()

◆ SetLightMap() [1/2]

◆ SetLightMap() [2/2]

◆ SetMetalness()

◆ SetMetalnessMap() [1/2]

◆ SetMetalnessMap() [2/2]

◆ SetNormalMap() [1/2]

◆ SetNormalMap() [2/2]

◆ SetReceiveShadows()

◆ SetReflectionEnabled()

◆ SetReflectivity()

◆ SetRenderOrder()

◆ SetRoughness()