Helper to evaluate an attribute value in a rendering context, according to texture/shading variable. More...

Public Member Functions
void	set_attribute (const OfAttr &attr)
	Set the attribute to evaluate.

void	set_attribute (const OfAttr *attr)
	Set the attribute to evaluate.

void	resync_attribute ()
	Take attribute new properties into account.

const OfAttr *	get_attribute () const

const bool &	is_bound_to_shading_variable () const

bool	is_textured () const

ModuleTexture *	get_texture () const

CORE_FORCE_INLINE bool	eval_attr_value_vec (const CtxEval &ctx_eval, CtxShader &ctx_shader, GMathVec4f &c) const
	Evaluate the attribute as a color on this particular rendering context.

CORE_FORCE_INLINE bool	eval_attr_value_out (const CtxEval &ctx_eval, CtxShader &ctx_shader, TextureOutput &out) const
	Evaluate the attribute as a texture output on this particular rendering context.

CORE_FORCE_INLINE bool	eval_attr_value_double (const CtxEval &ctx_eval, CtxShader &ctx_shader, double &value) const
	Evaluate the attribute as a double on this particular rendering context.

CORE_FORCE_INLINE bool	sample_attr_value_vec (const CtxEval &ctx_eval, CtxShader &ctx_shader, GMathVec4f &c) const
	Sample the attribute as a color on this particular rendering context.

CORE_FORCE_INLINE bool	sample_attr_value_out (const CtxEval &ctx_eval, CtxShader &ctx_shader, TextureOutput &out) const
	Sample the attribute as a texture output on this particular rendering context.

CORE_FORCE_INLINE bool	sample_attr_value_double (const CtxEval &ctx_eval, CtxShader &ctx_shader, double &value) const
	Sample the attribute as a double on this particular rendering context.

CORE_FORCE_INLINE bool	eval (const CtxEval &ctx_eval, CtxShader &ctx_shader, GMathVec4f &c) const

CORE_FORCE_INLINE bool	eval (const CtxEval &ctx_eval, CtxShader &ctx_shader, TextureOutput &out) const

CORE_FORCE_INLINE bool	eval (const CtxEval &ctx_eval, CtxShader &ctx_shader, double &value) const

CORE_FORCE_INLINE bool	sample (const CtxEval &ctx_eval, CtxShader &ctx_shader, GMathVec4f &c) const

CORE_FORCE_INLINE bool	sample (const CtxEval &ctx_eval, CtxShader &ctx_shader, TextureOutput &out) const

CORE_FORCE_INLINE bool	sample (const CtxEval &ctx_eval, CtxShader &ctx_shader, double &value) const

bool	eval_attr_value_string (const CtxEval &ctx_eval, CtxShader &ctx_shader, UniqueString &out) const
	Evaluate the attribute as a string on this particular rendering context.

const UniqueString &	eval_shading_variable_value_string (const CtxEval &ctx_eval, CtxShader &ctx_shader, bool &status) const
	Evaluate the attribute shading variable value as a string on this particular rendering context.

Detailed Description

Helper to evaluate an attribute value in a rendering context, according to texture/shading variable.

Member Function Documentation

CORE_FORCE_INLINE bool OfAttrDynEvaluator::eval	(	const CtxEval &	ctx_eval,
		CtxShader &	ctx_shader,
		GMathVec4f &	c
	)		const

inline

See Also: eval_attr_value_vec

CORE_FORCE_INLINE bool OfAttrDynEvaluator::eval	(	const CtxEval &	ctx_eval,
		CtxShader &	ctx_shader,
		TextureOutput &	out
	)		const

inline

See Also: eval_attr_value_out

CORE_FORCE_INLINE bool OfAttrDynEvaluator::eval	(	const CtxEval &	ctx_eval,
		CtxShader &	ctx_shader,
		double &	value
	)		const

inline

See Also: eval_attr_value_double

CORE_FORCE_INLINE bool OfAttrDynEvaluator::eval_attr_value_double	(	const CtxEval &	ctx_eval,
		CtxShader &	ctx_shader,
		double &	value
	)		const

inline

Evaluate the attribute as a double on this particular rendering context.

Parameters

[in]	ctx_eval	The evaluation context.
[in]	ctx_shader	The shader context.
[out]	out	Evaluated double.

Note: This method returns true if the double is not null.

CORE_FORCE_INLINE bool OfAttrDynEvaluator::eval_attr_value_out	(	const CtxEval &	ctx_eval,
		CtxShader &	ctx_shader,
		TextureOutput &	out
	)		const

inline

Evaluate the attribute as a texture output on this particular rendering context.

Parameters

[in]	ctx_eval	The evaluation context.
[in]	ctx_shader	The shader context.
[out]	out	Evaluated texture output.

Note: This method returns true if the output is not filled with null values.

bool OfAttrDynEvaluator::eval_attr_value_string	(	const CtxEval &	ctx_eval,
		CtxShader &	ctx_shader,
		UniqueString &	out
	)		const

Evaluate the attribute as a string on this particular rendering context.

Parameters

[in]	ctx_eval	The evaluation context.
[in]	ctx_shader	The shader context.
[out]	string	Evaluated string.

Note: This method returns true if the string is not empty.

CORE_FORCE_INLINE bool OfAttrDynEvaluator::eval_attr_value_vec	(	const CtxEval &	ctx_eval,
		CtxShader &	ctx_shader,
		GMathVec4f &	c
	)		const

inline

Evaluate the attribute as a color on this particular rendering context.

Parameters

[in]	ctx_eval	The evaluation context.
[in]	ctx_shader	The shader context.
[out]	c	Evaluated color.

Note: This method returns true if the color is not filled with null values.

const UniqueString & OfAttrDynEvaluator::eval_shading_variable_value_string	(	const CtxEval &	ctx_eval,
		CtxShader &	ctx_shader,
		bool &	status
	)		const

Evaluate the attribute shading variable value as a string on this particular rendering context.

Parameters

[in]	ctx_eval	The evaluation context.
[in]	ctx_shader	The shader context.
[out]	status	True if the returned value is valid, false otherwise.

Note: This method returns the shading variable value.

void OfAttrDynEvaluator::resync_attribute ( )

Take attribute new properties into account.

Note: Call this method when the attribute has been modified.

CORE_FORCE_INLINE bool OfAttrDynEvaluator::sample	(	const CtxEval &	ctx_eval,
		CtxShader &	ctx_shader,
		GMathVec4f &	c
	)		const

inline

See Also: sample_attr_value_vec

CORE_FORCE_INLINE bool OfAttrDynEvaluator::sample	(	const CtxEval &	ctx_eval,
		CtxShader &	ctx_shader,
		TextureOutput &	out
	)		const

inline

See Also: sample_attr_value_out

CORE_FORCE_INLINE bool OfAttrDynEvaluator::sample	(	const CtxEval &	ctx_eval,
		CtxShader &	ctx_shader,
		double &	value
	)		const

inline

See Also: sample_attr_value_double

CORE_FORCE_INLINE bool OfAttrDynEvaluator::sample_attr_value_double	(	const CtxEval &	ctx_eval,
		CtxShader &	ctx_shader,
		double &	value
	)		const

inline

Sample the attribute as a double on this particular rendering context.

Parameters

[in]	ctx_eval	The evaluation context.
[in]	ctx_shader	The shader context.
[out]	out	Evaluated double.

Note: Similar to eval_attr_value_double method, but will not use the texture cache of the CtxEval.

CORE_FORCE_INLINE bool OfAttrDynEvaluator::sample_attr_value_out	(	const CtxEval &	ctx_eval,
		CtxShader &	ctx_shader,
		TextureOutput &	out
	)		const

inline

Sample the attribute as a texture output on this particular rendering context.

Parameters

[in]	ctx_eval	The evaluation context.
[in]	ctx_shader	The shader context.
[out]	out	Evaluated texture output.

Note: Similar to eval_attr_value_out method, but will not use the texture cache of the CtxEval.

CORE_FORCE_INLINE bool OfAttrDynEvaluator::sample_attr_value_vec	(	const CtxEval &	ctx_eval,
		CtxShader &	ctx_shader,
		GMathVec4f &	c
	)		const

inline

Sample the attribute as a color on this particular rendering context.

Parameters

[in]	ctx_eval	The evaluation context.
[in]	ctx_shader	The shader context.
[out]	c	Evaluated color.

Note: Similar to eval_attr_value_vec method, but will not use the texture cache of the CtxEval.

void OfAttrDynEvaluator::set_attribute ( const OfAttr & attr )

inline

Set the attribute to evaluate.

Parameters

[in] attr The attribute to evaluate.

Note: This method automaticaly call the resync_attribute one.

void OfAttrDynEvaluator::set_attribute ( const OfAttr * attr )

inline

Set the attribute to evaluate.

Parameters

[in] attr The pointer to the attribute to evaluate.

Note: This method automaticaly call the resync_attribute one.

Public Member Functions

Detailed Description

Member Function Documentation