DefaultRefractionComponent< ParameterType, ShaderHelper > Class Template Reference
[Refraction Passes]

#include <adskComponent.h>

List of all members.

---

Detailed Description

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

Refraction component.

This component computes the refracted light arriving at the shading point. Also fills in transparency.

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
	DefaultRefractionComponent (miState *pState, ParameterType *pParameters)
	Component constructor.
	~DefaultRefractionComponent ()
	Component destructor.
miColor	operator() (miState *pState, ParameterType *pParameters, ShaderHelper &pHelper, miColor &pResultTransparency, miColor &pTransparency, miBoolean pHideSource, miBoolean pRefractions, unsigned int pNumberOfFrameBuffers, FrameBufferInfo *pFrameBufferInfo, PassTypeInfo *pPassTypeInfo, const miScalar &pFrameBufferScale)
	Function object operator.

---

Constructor & Destructor Documentation

template<typename ParameterType, typename ShaderHelper>

DefaultRefractionComponent< ParameterType, ShaderHelper >::DefaultRefractionComponent	(	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 DefaultRefractionComponent< ParameterType, ShaderHelper >::operator()	(	miState *	pState,
		ParameterType *	pParameters,
		ShaderHelper &	pHelper,
		miColor &	pResultTransparency,
		miColor &	pTransparency,
		miBoolean	pHideSource,
		miBoolean	pRefractions,
		unsigned int	pNumberOfFrameBuffers,
		FrameBufferInfo *	pFrameBufferInfo,
		PassTypeInfo *	pPassTypeInfo,
		const miScalar &	pFrameBufferScale
	)			[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.
[out]	pResultTransparency	The transparency result
[in,out]	pTransparency	The transparency at the point
[in]	pHideSource	Is the source object hidden
[in]	pRefractions	Are refractions activated
[in]	pNumberOfFrameBuffers	The number of frame buffers
[in,out]	pFrameBufferInfo	The array of frame buffer states
[in]	pPassTypeInfo	The array of render pass type information
[in]	pFrameBufferScale	Scale factor applied to frame buffer contributions

Returns:

The color corresponding to this component.