Helper class for rasterization, illumination and shading and raytracing. More...

Classes
class	FilterResolveMaterialData

Public Types
typedef void(*	LeafRayHitNearestSceneObjectCallback )(ModuleSceneObject *scene_object, const CtxEval &eval_ctx, GeometryRaytraceCtx &raytrace_ctx)

typedef void(*	LeafRayHitNearestLightCallback )(ModuleLight *light, const CtxEval &eval_ctx, GeometryRaytraceCtx &raytrace_ctx)

Static Public Member Functions
static bool	filter_resolve_material_callback (const CtxEval &eval_ctx, const GeometryRaytraceCtx &raytrace_ctx, const unsigned int &ray_index, GeometryIntersection &intersection, GeometryRaytraceCtx::FilterData &data)

static ModuleMaterial *	resolve_material_switch (const CtxEval &eval_ctx, GeometryIntersection &intersection)

static ModuleMaterial *	resolve_material (const CtxEval &eval_ctx, GeometryIntersection &intersection, const DefaultMaterialConfig &default_materials)

static void	shade (const CtxEval &eval_ctx, CtxShader &shader_ctx, GMathVec3f &color, GMathVec3f &opacity, const bool &aovs_only=false, const bool &disable_clamping=false)
	Shade the current fragment set in the shader context.

static void	shade (GMathVec3f &color, GMathVec3f &opacity, const CtxEval &eval_ctx, CtxShader &shader_ctx, const CtxRaytrace &ray_ctx, const unsigned int &path_index, const bool &disable_clamping=false)
	Shade a path of intersections and composite them.

static void	shade_opacity (GMathVec3f &opacity, const CtxEval &eval_ctx, CtxShader &shader_ctx, const CtxRaytrace &ray_ctx, const unsigned int &path_index, const bool &shade_transparency=true)
	Compute the composited opacity of a path of intersections.

static bool	raytrace (GMathVec3f &color, GMathVec3f &opacity, const CtxEval &eval_ctx, CtxShader &shader_ctx, const GMathRay<> &ray, const double &tnear=gmath_epsilon, const double &tfar=gmath_infinity, const bool &disable_clamping=false)
	Raytrace the current scene with full shading/illumination evaluation.

static bool	raytrace_opacity (GMathVec3f &opacity, const CtxEval &eval_ctx, CtxShader &ctx, const GMathRay<> &ray, const double &tnear=gmath_epsilon, const double &tfar=gmath_infinity, const bool &shade_transparency=true)
	Raytrace the current scene and compute only the resulting opacity.

static void	raytrace (GMathVec3f colors, GMathVec3f opacities, const CtxEval &eval_ctx, CtxShader &shader_ctx, CtxRaytrace &ray_ctx, const bool &disable_clamping=false, const bool &use_packet=true)
	Raytrace the current scene with full shading/illumination evaluation.

static void	raytrace_opacity (GMathVec3f *opacities, const CtxEval &eval_ctx, CtxShader &shader_ctx, CtxRaytrace &ray_ctx, const bool &shade_transparency=true, const bool &use_packet=true)
	Raytrace the current scene and compute only the resulting opacities.

static void	clip (GMathVec3d &direction, const GMathVec3d &clip_plane_normal)

static double	reflect (const GMathVec3d &i, const GMathVec3d &n, GMathVec3d &r)

static double	refract (const GMathVec3d &i, const GMathVec3d &n, const double &ior, GMathVec3d &t)

static double	refract (const GMathVec3d &i, const GMathVec3d &n, const double &eta_i, const double &eta_t, GMathVec3d &t)

static void	reflect_and_refract (const GMathVec3d &i, const GMathVec3d &n, const double &ior, GMathVec3d &r, GMathVec3d &t, double &cos_i, double &cos_t)

static double	fresnel_dielectric (const double &cos_i, const double &cos_t, const double &eta_i, const double &eta_t)

static double	fresnel_dielectric (const double &cos_i, const double &cos_t, const double &ior)

static double	fresnel_dielectric (const GMathVec3d &wi, const GMathVec3d &normal, const double &ior)

static double	fresnel_conductor (const double &cos_i, const double &eta, const double &k)

static float	luminance (const GMathVec3f &rgb)

static float	luminance (const GMathVec4f &rgba)

static double	luminance (const GMathVec3d &rgb)

static double	luminance (const GMathVec4d &rgba)

static double	compute_reflection_ray (const CtxEval &eval_ctx, const CtxShader &ctx, GMathRay<> &r_ray)
	Compute the reflection ray using fragment information from the input CtxShader.

static double	compute_refraction_ray (const CtxEval &eval_ctx, const CtxShader &ctx, const double &ior, GMathRay<> &t_ray)
	Compute the refraction ray using fragment information from the input CtxShader.

static void	compute_reflection_and_refraction_rays (const CtxEval &eval_ctx, const CtxShader &ctx, const double &ior, GMathRay<> &r_ray, GMathRay<> &t_ray, double &cos_i, double &cos_t)
	Compute both reflection and refraction rays using fragment information from the input CtxShader.

static bool	create_shader_ctx (const CtxEval &eval_ctx, CtxShader &ctx, const ModuleLayerScene &layer)
	Creates a minimal valid shader context. Once you are done using the ctx, you MUST call a cleanup_shader_ctx otherwise, you will get memory leaks. Assume the camera is of class CameraPerspective.

static bool	create_shader_ctx (const CtxEval &eval_ctx, CtxShader &ctx, const ModuleRenderScene &render_scene)
	Creates a minimal valid shader context. Once you are done using the ctx, you MUST call a cleanup_shader_ctx otherwise, you will get memory leaks. Assume the camera is of class CameraPerspective.

static void	cleanup_shader_ctx (CtxShader &ctx)
	Cleanup a valid shader context.

static bool	raycast (GeometryIntersection &intersection, GMathRay<> &ray, const CtxEval &eval_ctx, CtxShader &ctx, const double &x, const double &y, const unsigned int &width, const unsigned int &height, float alpha_threshold=0, const CoreVector< ModuleSceneItem * > *items=0, bool exclude=true, bool filter_unpickable=false, bool raycast_light=false)
	Cast a ray for the specified pixel and return the intersection if any.

static void	compute_bump_normal (GMathVec3d &normal, const CtxEval &eval_ctx, CtxShader &ctx, const ModuleTexture &texture, const bool &smoothed=true, const double &factor=1.0, const bool &use_texture_space=true)
	Compute bump normal from a texture.

static void	compute_normal_from_map (GMathVec3d &normal, const CtxEval &eval_ctx, CtxShader &ctx, const ModuleTexture &texture, const bool &smoothed=true, const double &factor=1.0, const bool &use_tangent_space=true)
	Compute normal from a normal map texture.

static bool	ray_hit (const CtxEval &eval_ctx, CtxShader &shader_ctx, const GMathRay<> &ray, const double &tnear=gmath_epsilon, const double &tfar=gmath_infinity)
	Cast a ray and test if it hits something.

static void	ray_hit (const CtxEval &eval_ctx, CtxShader &shader_ctx, CtxRaytrace &ray_ctx, const bool &use_packet=true)
	Cast rays and test if they hit something.

static void	ray_hit_nearest (const CtxEval &eval_ctx, CtxShader &shader_ctx, CtxRaytrace &ray_ctx, const bool &use_packet=true)
	Cast rays and and search for the nearest intersection.

static void	decimate_points (OfObjectFactory &factory, CoreVector< GMathVec3d > &points, const double &decimate_value, ModuleTexture *decimate_texture=0, const unsigned int &decimate_seed=0)

static void	merge_fragments (float &cm, float &am, const float &c1, const float &a1, const float &c2, const float &a2)

static void	merge_fragments (GMathVec3f &cm, GMathVec3f &am, const GMathVec3f &c1, const GMathVec3f &a1, const GMathVec3f &c2, const GMathVec3f &a2)

static void	merge_fragments (GMathVec3f &c1, GMathVec3f &a1, const GMathVec3f &c2, const GMathVec3f &a2)

static bool	evaluate_support_material (const GeometryPointCloud &point_cloud, const ModuleMaterial &material, CoreBasicArray< GMathVec3f > &colors, CoreBasicArray< GMathVec3f > &opacities, ModuleLayer3d layer=nullptr, AppProgressBar progress_bar=nullptr)

static bool	evaluate_support_texture (const GeometryPointCloud &point_cloud, const ModuleTexture &texture, CoreBasicArray< GMathVec4f > &colors, ModuleLayer3d layer=nullptr, AppProgressBar progress_bar=nullptr)

static bool	evaluate_vertices_texture (ModuleGeometry &geometry, const CoreBasicArray< unsigned int > &vertex_indices, const ModuleTexture &texture, CoreBasicArray< GMathVec4f > &colors, ModuleLayer3d layer=nullptr, AppProgressBar progress_bar=nullptr)

static void	gas_leaf_ray_hit_nearest (const CtxEval &eval_ctx, CtxShader &shader_ctx, GeometryRaytraceCtx &raytrace_ctx, LeafRayHitNearestSceneObjectCallback leaf_callback, const GMathMatrix4x4d &m, const GMathMatrix4x4d &inv_m, const unsigned int &leaf_index, ModuleSceneObject leaf_module, GeometryOverride leaf_override=0)

static void	gas_leaf_ray_hit_nearest_motion (const CtxEval &eval_ctx, CtxShader &shader_ctx, GeometryRaytraceCtx &raytrace_ctx, LeafRayHitNearestSceneObjectCallback leaf_callback, const CoreBasicArray< GMathMatrix4x4d > &matrices, const unsigned int &leaf_index, ModuleSceneObject leaf_module, GeometryOverride leaf_override=0)

static void	gas_leaf_ray_hit_nearest (const CtxEval &eval_ctx, CtxShader &shader_ctx, GeometryRaytraceCtx &raytrace_ctx, LeafRayHitNearestLightCallback leaf_callback, const GMathMatrix4x4d &m, const GMathMatrix4x4d &inv_m, const unsigned int &leaf_index, ModuleLight *leaf_module)

static void	gas_leaf_ray_hit_nearest_motion (const CtxEval &eval_ctx, CtxShader &shader_ctx, GeometryRaytraceCtx &raytrace_ctx, LeafRayHitNearestLightCallback leaf_callback, const CoreBasicArray< GMathMatrix4x4d > &matrices, const unsigned int &leaf_index, ModuleLight *leaf_module)

Detailed Description

Helper class for rasterization, illumination and shading and raytracing.

Useful shading static method collection.

Member Function Documentation

void ShaderHelpers::cleanup_shader_ctx ( CtxShader & ctx )

static

Cleanup a valid shader context.

Parameters

ctx	shader context to cleanup

void ShaderHelpers::compute_bump_normal	(	GMathVec3d &	normal,
		const CtxEval &	eval_ctx,
		CtxShader &	ctx,
		const ModuleTexture &	texture,
		const bool &	smoothed = `true`,
		const double &	factor = `1.0`,
		const bool &	use_texture_space = `true`
	)

static

Compute bump normal from a texture.

Parameters

ctx	valid shader context
texture	texture that gets evaluated (3 times) at the surrounding of the wpos of the CtxShader
factor	bump factor

void ShaderHelpers::compute_normal_from_map	(	GMathVec3d &	normal,
		const CtxEval &	eval_ctx,
		CtxShader &	ctx,
		const ModuleTexture &	texture,
		const bool &	smoothed = `true`,
		const double &	factor = `1.0`,
		const bool &	use_tangent_space = `true`
	)

static

Compute normal from a normal map texture.

Parameters

ctx	valid shader context
texture	texture that gets evaluated
factor	normal map factor

void ShaderHelpers::compute_reflection_and_refraction_rays	(	const CtxEval &	eval_ctx,
		const CtxShader &	ctx,
		const double &	ior,
		GMathRay<> &	r_ray,
		GMathRay<> &	t_ray,
		double &	cos_i,
		double &	cos_t
	)

static

Compute both reflection and refraction rays using fragment information from the input CtxShader.

Parameters

eval_ctx	valid evaluation context
ctx	valid shader context
ior	index of refraction of the surface
r_ray	reflected ray
t_ray	transmitted ray
cos_i	the cosine of the angle between the incident/reflected ray and the normal
cos_t	the cosine of the angle between the transmitted ray and the normal

double ShaderHelpers::compute_reflection_ray	(	const CtxEval &	eval_ctx,
		const CtxShader &	ctx,
		GMathRay<> &	r_ray
	)

static

Compute the reflection ray using fragment information from the input CtxShader.

Parameters

eval_ctx	valid evaluation context
ctx	valid shader context
r_ray	reflected ray

Returns: the cosine of the angle between the incident/reflected rays and the normal

double ShaderHelpers::compute_refraction_ray	(	const CtxEval &	eval_ctx,
		const CtxShader &	ctx,
		const double &	ior,
		GMathRay<> &	t_ray
	)

static

Compute the refraction ray using fragment information from the input CtxShader.

Parameters

eval_ctx	valid evaluation context
ctx	valid shader context
ior	index of refraction of the surface
t_ray	transmitted ray

Returns: the cosine of the angle between the transmitted ray and the normal

bool ShaderHelpers::create_shader_ctx	(	const CtxEval &	eval_ctx,
		CtxShader &	ctx,
		const ModuleLayerScene &	layer
	)

static

Creates a minimal valid shader context. Once you are done using the ctx, you MUST call a cleanup_shader_ctx otherwise, you will get memory leaks. Assume the camera is of class CameraPerspective.

Parameters

ctx	resulting valid shader context
layer	3D layer the shader context is supposed to be used for render

Returns: false if the creation failed (imcomplete layer such as no camera...)

bool ShaderHelpers::create_shader_ctx	(	const CtxEval &	eval_ctx,
		CtxShader &	ctx,
		const ModuleRenderScene &	render_scene
	)

static

Creates a minimal valid shader context. Once you are done using the ctx, you MUST call a cleanup_shader_ctx otherwise, you will get memory leaks. Assume the camera is of class CameraPerspective.

Parameters

ctx	resulting valid shader context
render_scene	the scene the shader context is supposed to be used for render

Returns: false if the creation failed (imcomplete scene such as no camera...)

bool ShaderHelpers::evaluate_support_material	(	const GeometryPointCloud &	point_cloud,
		const ModuleMaterial &	material,
		CoreBasicArray< GMathVec3f > &	colors,
		CoreBasicArray< GMathVec3f > &	opacities,
		ModuleLayer3d *	layer = `nullptr`,
		AppProgressBar *	progress_bar = `nullptr`
	)

static

Evaluate the material color for each points of the point cloud, using the point cloud support geometry.

Parameters

[in]	point_cloud	The point cloud to evaluate.
[in]	material	The material to evaluate on the point cloud support primitives.
[out]	colors	Evaluated material colors, one for each point.
[out]	opacities	Evaluated material opacities, one for each point.
[in]	layer	Optional layer, if NULL rays will be set along the surface normal and raytracing will be disabled.
[in]	progress_bar	Optional progress bar.Created if not specified.

Returns: True on success. False if point_count has no support geometry, or if colors or opacities size don't match point count.

bool ShaderHelpers::evaluate_support_texture	(	const GeometryPointCloud &	point_cloud,
		const ModuleTexture &	texture,
		CoreBasicArray< GMathVec4f > &	colors,
		ModuleLayer3d *	layer = `nullptr`,
		AppProgressBar *	progress_bar = `nullptr`
	)

static

Evaluate the texture color for each points of the point cloud, using the point cloud support geometry.

Parameters

[in]	point_cloud	The point cloud to evaluate.
[in]	texture	The texture to evaluate on the point cloud support primitives.
[out]	colors	Evaluated texture colors, one for each point.
[in]	layer	Optional layer, if NULL rays will be set along the surface normal and raytracing will be disabled.
[in]	progress_bar	Optional progress bar. Created if not specified.

Returns: True on success. False if point_count has no support geometry, or if colors size doesn't match point count.

bool ShaderHelpers::evaluate_vertices_texture	(	ModuleGeometry &	geometry,
		const CoreBasicArray< unsigned int > &	vertex_indices,
		const ModuleTexture &	texture,
		CoreBasicArray< GMathVec4f > &	colors,
		ModuleLayer3d *	layer = `nullptr`,
		AppProgressBar *	progress_bar = `nullptr`
	)

static

Evaluate the texture color for vertices of a geometry.

Parameters

[in]	geometry	The geometry to evaluate.
[in]	vertex_indices	The indices of the vertices to evaluate.
[in]	texture	The texture to evaluate on the point cloud support primitives.
[out]	colors	Evaluated texture colors, one for each point.
[in]	layer	Optional layer, if NULL rays will be set along the surface normal and raytracing will be disabled.
[in]	progress_bar	Optional progress bar. Created if not specified.

Returns: True on success. False if colors size doesn't match vertex count.

bool ShaderHelpers::ray_hit	(	const CtxEval &	eval_ctx,
		CtxShader &	shader_ctx,
		const GMathRay<> &	ray,
		const double &	tnear = `gmath_epsilon`,
		const double &	tfar = `gmath_infinity`
	)

static

Cast a ray and test if it hits something.

Parameters

eval_ctx	valid evaluation context
shader_ctx	valid shader context
tnear	near clip value
tfar	far clip value

Returns: true if the ray hit something, else false

void ShaderHelpers::ray_hit	(	const CtxEval &	eval_ctx,
		CtxShader &	shader_ctx,
		CtxRaytrace &	ray_ctx,
		const bool &	use_packet = `true`
	)

static

Cast rays and test if they hit something.

Parameters

eval_ctx	valid evaluation context
shader_ctx	valid shader context
ray_ctx	raytracing context to use

void ShaderHelpers::ray_hit_nearest	(	const CtxEval &	eval_ctx,
		CtxShader &	shader_ctx,
		CtxRaytrace &	ray_ctx,
		const bool &	use_packet = `true`
	)

static

Cast rays and and search for the nearest intersection.

Parameters

eval_ctx	valid evaluation context
shader_ctx	valid shader context
ray_ctx	raytracing context to use

bool ShaderHelpers::raycast	(	GeometryIntersection &	intersection,
		GMathRay<> &	ray,
		const CtxEval &	eval_ctx,
		CtxShader &	shader_ctx,
		const double &	x,
		const double &	y,
		const unsigned int &	width,
		const unsigned int &	height,
		float	alpha_threshold = `0`,
		const CoreVector< ModuleSceneItem * > *	items = `0`,
		bool	exclude = `true`,
		bool	filter_unpickable = `false`,
		bool	raycast_light = `false`
	)

static

Cast a ray for the specified pixel and return the intersection if any.

Parameters

intersection	resulting intersection on the hit object
ray	resulting cast ray
ctx	valid shader context
x	x coordinate of the pixel to raycast from (in pixel space)
y	y coordinate of the pixel to raycast from (in pixel space)
width	width of the film plane
height	height of the film plane
alpha_threshold	optional value under which an object is considered transparent therefore ignored
items	optional array of modules to care about
exclude	optional argument to specify whether items provided are the ones to ignore or to consider
filter_unpickable	care about 'display_pickable' attribute

Returns: true if an object has been hit, else false

bool ShaderHelpers::raytrace	(	GMathVec3f &	color,
		GMathVec3f &	opacity,
		const CtxEval &	eval_ctx,
		CtxShader &	ctx,
		const GMathRay<> &	ray,
		const double &	tnear = `gmath_epsilon`,
		const double &	tfar = `gmath_infinity`,
		const bool &	disable_clamping = `false`
	)

static

Raytrace the current scene with full shading/illumination evaluation.

Parameters

color	resulting raytraced color (r,g,b)
opacity	resulting opacity of the color
ctx	valid shader context
tnear	near clip value
tfar	far clip value
disable_clamping	when true, the color clamping that is configured in the shader context is ignored

void ShaderHelpers::raytrace	(	GMathVec3f *	colors,
		GMathVec3f *	opacities,
		const CtxEval &	eval_ctx,
		CtxShader &	shader_ctx,
		CtxRaytrace &	ray_ctx,
		const bool &	disable_clamping = `false`,
		const bool &	use_packet = `true`
	)

static

Raytrace the current scene with full shading/illumination evaluation.

Parameters

colors	resulting raytraced colors (r,g,b)
opacity	resulting opacities of each color
eval_ctx	valid evaluation context
shader_ctx	valid shader context
ray_ctx	raytracing context to use
disable_clamping	when true, the color clamping that is configured in the shader context is ignored
use_packet	when true, packet tracing is enabled

bool ShaderHelpers::raytrace_opacity	(	GMathVec3f &	opacity,
		const CtxEval &	eval_ctx,
		CtxShader &	ctx,
		const GMathRay<> &	ray,
		const double &	tnear = `gmath_epsilon`,
		const double &	tfar = `gmath_infinity`,
		const bool &	shade_transparency = `true`
	)

static

Raytrace the current scene and compute only the resulting opacity.

Parameters

opacity	resulting opaciy
ctx	valid shader context
tnear	near clip value
tfar	far clip value
shade_transparency	when true, the material of objects is evaluated in order to know their opacity

void ShaderHelpers::raytrace_opacity	(	GMathVec3f *	opacities,
		const CtxEval &	eval_ctx,
		CtxShader &	shader_ctx,
		CtxRaytrace &	ray_ctx,
		const bool &	shade_transparency = `true`,
		const bool &	use_packet = `true`
	)

static

Raytrace the current scene and compute only the resulting opacities.

Parameters

opacity	resulting opacities of each ray
eval_ctx	valid evaluation context
shader_ctx	valid shader context
ray_ctx	raytracing context to use
sample_inc	increment to apply to the sample index at each ray
shade_transparency	when true, the material of objects is evaluated in order to know their opacity
use_packet	when true, packet tracing is enabled

void ShaderHelpers::shade	(	const CtxEval &	eval_ctx,
		CtxShader &	shader_ctx,
		GMathVec3f &	color,
		GMathVec3f &	opacity,
		const bool &	aovs_only = `false`,
		const bool &	disable_clamping = `false`
	)

static

Shade the current fragment set in the shader context.

Parameters

eval_ctx	a valid evaluation context
shader_ctx	a valid shader context
output	material evaluation output
aovs_only	when true, only the aovs are computed
disable_clamping	when true, the color clamping that is configured in the shader context is ignored

void ShaderHelpers::shade	(	GMathVec3f &	color,
		GMathVec3f &	opacity,
		const CtxEval &	eval_ctx,
		CtxShader &	shader_ctx,
		const CtxRaytrace &	ray_ctx,
		const unsigned int &	path_index,
		const bool &	disable_clamping = `false`
	)

static

Shade a path of intersections and composite them.

Parameters

color	resulting composited color (r,g,b)
opacity	resulting composited opacity
eval_ctx	a valid evaluation context
shader_ctx	a valid shader context
ray_ctx	the raytracing context containing the path of intersection to shade
path_index	the index of the path in the raytracing context to shade
disable_clamping	when true, the color clamping that is configured in the shader context is ignored

void ShaderHelpers::shade_opacity	(	GMathVec3f &	opacity,
		const CtxEval &	eval_ctx,
		CtxShader &	shader_ctx,
		const CtxRaytrace &	ray_ctx,
		const unsigned int &	path_index,
		const bool &	shade_transparency = `true`
	)

static

Compute the composited opacity of a path of intersections.

Parameters

opacity	resulting composited opacity
eval_ctx	a valid evaluation context
ctx	a valid shader context
data	the raytrace data containing the result of a raytracing
path_index	the index of the path in the raytrace data to shade

Classes

Public Types

Static Public Member Functions

Detailed Description

Member Function Documentation