DefaultDiffuseComponent< ParameterType, ShaderHelper > Class Template Reference
[Diffuse Passes]

#include <adskComponent.h>

List of all members.

---

Detailed Description

template<typename ParameterType, typename ShaderHelper>
class DefaultDiffuseComponent< ParameterType, ShaderHelper >

Default diffuse component.

The diffuse component computes the contribution of the diffuse material color given the direct lighting in the scene.

Template Parameters:

	ParameterType	The structure used in the shader declaration to represent the shader parameters.
	ShaderHelper	The class used in the shader declaration to represent the shader helper. See ShaderHelper for details on the required methods.

Public Member Functions
	DefaultDiffuseComponent (miState *pState, ParameterType *pParameters)
	Component constructor.
	~DefaultDiffuseComponent ()
	Component destructor.
miColor	operator() (miState *pState, ParameterType *pParameters, ShaderHelper &pHelper, miColor &pMaterialColor, miVector &pLightDirection, miScalar pDotNL, void *pLightBlindData)
	Function object operator.

---

Constructor & Destructor Documentation

template<typename ParameterType, typename ShaderHelper>

DefaultDiffuseComponent< ParameterType, ShaderHelper >::DefaultDiffuseComponent	(	miState *	pState,
		ParameterType *	pParameters
	)			[inline]

Component constructor.

Parameters:

[in,out]	pState	The mental ray rendering state.
[in]	pParameters	The shader parameters.

---

Member Function Documentation

template<typename ParameterType, typename ShaderHelper>

miColor DefaultDiffuseComponent< ParameterType, ShaderHelper >::operator()	(	miState *	pState,
		ParameterType *	pParameters,
		ShaderHelper &	pHelper,
		miColor &	pMaterialColor,
		miVector &	pLightDirection,
		miScalar	pDotNL,
		void *	pLightBlindData
	)			[inline]

Function object operator.

Parameters:

[in,out]	pState	The mental ray rendering state.
[in,out]	pParameters	The shader parameters.
[in,out]	pHelper	The shader helper for this shader.
[in]	pMaterialColor	The material color
[in]	pLightDirection	The direction of the light
[in]	pDotNL	The dot product of the light direction and surface normal at the shading point.
[in]	pLightBlindData	The light blind data for the current light

Returns:

The color corresponding to this component.