DefaultScatterComponent< ParameterType, ShaderHelper > Class Template Reference
[Scatter Passes]

#include <adskComponent.h>

List of all members.

---

Detailed Description

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

Scatter component.

This component computes the scattered light arriving at the shading point.

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
	DefaultScatterComponent (miState *pState, ParameterType *pParameters)
	Component constructor.
	~DefaultScatterComponent ()
	Component destructor.
miColor	operator() (miState *pState, ParameterType *pParameters, ShaderHelper &pHelper, void **pScatterData)
	Function object operator.

---

Constructor & Destructor Documentation

template<typename ParameterType, typename ShaderHelper>

DefaultScatterComponent< ParameterType, ShaderHelper >::DefaultScatterComponent	(	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 DefaultScatterComponent< ParameterType, ShaderHelper >::operator()	(	miState *	pState,
		ParameterType *	pParameters,
		ShaderHelper &	pHelper,
		void **	pScatterData
	)			[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,out]	pScatterData	Pointer to memory area for scatter data

Returns:

The color corresponding to this component.