class RED::ISoftRayContext

Returns true if approximated lighting can be used, false otherwise.

Parameters:

Returns:

Estimates the illumination due to caustics at a given point and orientation.

Parameters:

Returns:

Estimates the GI at a given point with the given orientation.

Parameters:

Returns:

Returns:

Gets the ray cutoff information.

Parameters:

Returns:

Gets the hit element of the hit object unique ID (UID).

The UID is the unique identifier for the hit element in the hit object. Two different triangles in a mesh have different UIDs. The two meshes objects themselves have different UIDs, returned by RED::ISoftRayContext::GetObjectUID.

If the hit primitive is a custom primitive, the returned hit element is -1.

Returns:

The returned object implements the RED::IGeometryDatabase interface. Note that when accessed from a RED::ISoftRayContext, we're in a threaded rendering, and the RED::IGeometryDatabase should be used using RED::ISoftRayContext::GetThreadID as calling thread number.

Gets a sampling direction for glossiness.

This method returns a normalized direction in the cone defined by the material glossiness angle parameter. Each time the method is called, a new sampling direction is returned.

Parameters:

Gets the parametric hit interval of the primitive on the ray or frustum.

For a ray propagation (ray bounces at depth > 0 for standard images), this method returns the parametric length of the hit point along the propagated ray. In this configuration, 'oTMin' and 'oTMax' are identical and set to this unique value.

For a frustum propagation (case of a pixel analytics query), this method returns the parametric boundaries (as a z-buffer depth) of the intersection of the primitive with the propagated frustum. 'oTMin' corresponds to the closest hit point of the hit primitive with the frustum; 'oTMax' corresponds to the farthest hit point of the same primitive with the frustum.

Parameters:

Gets the inverse transpose matrix of the last object hit on the ray stack. The result can be NULL if the object has no matrix.

Returns:

Gets the index of refraction (IOR) of the hit material.

Returns:

Retrieves the current light to be rendered.

Parameters:

Returns:

Gets the transformation matrix of the last object hit on the ray stack. The result can be NULL if the object has no matrix.

Returns:

Gets the index of refraction (IOR) of the next material in the ray tree.

Returns:

Checks the facing of the eye vector against the hit triangle normal.

Returns:

Retrieves the hit element mesh indices in the hit object.

This method returns the hit element indices in the hit object. For a triangle, this means the triangle three vertex indices [ oI0, oI1, oI2 ]; for a line strip or segment, this means two vertex indices [ oI0, oI1, -1 ]; for a point, only one vertex index is returned: [ oI0, -1, -1 ].

In the case of a custom primitive hit, the returned element indices are all -1.

Parameters:

Retrieves the number of the hit element in the hit object.

The returned number is either the number of the triangle, line segment, line strip or point in the hit shape instance.

If the hit primitive is a custom primitive, the returned hit element number is -1.

Returns:

Retrieves the hit element mesh intersection UVs in the hit object.

This method returns the hit element intersection UVs in the hit object. For a triangle, this means that these UVs can be used to reconstruct the hit point, using P0 + oU*P0P1 + oV*P0P2. For a line element, the reconstruction is P0 + oU*P0P1; oV is undefined. For a point, oU and oV are undefined. In the case of a custom primitve, the returned values are undefined.

Parameters:

Retrieves the WCS vertices of the hit element in the hit object.

This method directly returns the WCS positions of the vertices that define the hit element in the hit object. The third vertex is set to [ 0.0 ] for a line and the second and third vertices are set to [ 0.0 ] for a point.

In the case of a custom primitive hit, all element hit coordinates are set to 0.0.

Parameters:

Retrieves the shape RED::LayerSet for this instance of the hit object.

The returned layerset is the last layerset found on the path from the root of the scene down to the hit object instance, according to the inheritance rules in use for the scene graph.

In the case of a custom primitive hit, the returned layerset is NULL.

Returns:

Retrieves the shape material for this instance of the hit object.

Retrieve the material to use to display the hit object. The material being returned is calculated based on the DAG hierarchy in the scene and material inheritance rules. The last material on the path from the root of the scene down to the object instance is returned.

In the case of a custom primitive hit, the returned material address is the one that was returned by the SOFT_RAY_PROCESSING_SHADING_CALLBACK.

Returns:

Retrieves the shape matrix for this instance of the hit object.

The returned matrix is the cumulated matrix on the path from the root of the scene down to the hit object instance.

In the case of a custom primitive hit, the returned matrix is NULL.

Returns:

Retrieves the shape object of the hit object.

In the case of a custom primitive hit, the returned shape address is NULL.

Returns:

Retrieves the shape path of the hit object.

In the case of a custom primitive hit, the returned shape path is empty.

Returns:

Gets the object unique ID (UID) of the hit object.

The UID is the unique identifier for the hit object. This means that two instances of the same shape object have different unique IDs assigned by the engine. If the hit primitive is a custom primitive, then there's no valid UID stored in the engine database for the hit object. In this case, the returned UID is -1.

Returns:

Gets the coordinates of the pixel through which the first ray of the stack has been sent.

Parameters:

Gets the geometrical frustum defined by a pixel.

This method returns the geometrical coordinates of a primary pixel frustum. The frustum is the truncated pyramid fired from the camera eye that cover the pixel screen. It's illustrated in the image below:

Definition of a primary pixel beam.

Parameters:

Gets the color of the reflection ray.

Parameters:

Gets the distance to the reflected surface.

The distance is returned in model units. If no surface is reflected DBL_MAX is returned.

Parameters:

Gets the color of the refraction ray.

Parameters:

Gets the distance to the refracted surface.

The distance is returned in model units. If no surface is refracted DBL_MAX is returned.

Parameters:

Casts a shadow ray from the hit point toward another point.

The ray is cast along the specified path (from the light source position or iSamplePos to the current hit position) until it gets fully blocked by a shadow caster or until it reaches its destination. The result color is in 4d.

Parameters:

Returns:

Returns the ray differentials in x and y.

Parameters:

Gets the WCS hit point.

Converts the ray hit point in WCS and return it. The result vector is in 4d.

Parameters:

Returns the incoming vector.

This is the vector from the ray origin to the ray intersection in World Coordinate Space (WCS).

Parameters:

Gets the WCS normal at the hit point.

Interpolates the 'iChannel' channel at the hit point coordinates and turns it in WCS using the hit instance matrix. The result vector is in 4d.

Parameters:

Gets the WCS tangent at the hit point.

Interpolates the 'iChannel' channel at the hit point coordinates and turns it in WCS using the hit instance matrix.

Parameters:

Returns:

Calculates interpolated mesh parameters at the current hit point.

This method may renormalize resulting interpolated values based on the 'iRenderCode' specification.

If we're shading a custom geometry, then we have no mesh and the geometrical data input is sourced from the shading callback in use (see the RED::SOFT_RAY_PROCESSING_SHADING_CALLBACK). In this case, any channel renormalization can't be done by the interpolate method and it must be done beforehand in the shading callback.

Parameters:

Calculates interpolated mesh parameters at the current hit point.

This method does not renormalize resulting interpolated values.

If we're shading a custom geometry, then we have no mesh and the geometrical data input is sourced from the shading callback in use (see the RED::SOFT_RAY_PROCESSING_SHADING_CALLBACK). In this case, any channel renormalization can't be done by the interpolate method and it must be done beforehand in the shading callback.

Parameters:

Are we in a global illumination calculation phase?

Returns:

Returns:

Queries for the ray reflection shader to return glossiness values only.

If this method returns true, then the shader must return the glossiness angles to be used.

Returns:

Queries for the ray direction shader to return the IOR.

Calling this method disables the IOR only flag automatically.

Returns:

Queries for normal direction composites to return a non bumpy normal only.

If this method returns true, then the next normal calculation must ignore any bump mapping contribution.

Calling this method disables the 'no bump normal' flag automatically.

Returns:

Queries for the ray direction shader to return the shading normal.

The shading normal is the interpolated normal at the current intersection point after having applied bump or displacement transformations.

Calling this method disables the shading normal only flag automatically.

Returns:

Queries for normal direction composites to return a tangent vector.

If this method returns true, then the next normal calculation must return the tangent vector at the calculated point.

Calling this method disables the 'tangent only' flag automatically.

Returns:

Prepares lights for the rendering at a given point in space by precomputing some values and discarding meaningless lights.

This call is mandatory before calling RED::ISoftRayContext::GetLights. It setups all lights, lighting parameters and culling functions needed to shade the point defined by 'iPoint' and 'iNormal'.

Parameters:

Returns:

Returns:

Returns:

Background image texture sampling.

See RED::IViewpointRenderList::SetBackgroundImages for the detail on all sampling configurations. The source pixel coordinates used to sample the 2D background image are directly sourced from RED::ISoftRayContext::GetPixelCoordinates, that are set on the ray launch.

Parameters:

Samples a text glyph texture.

This method can be used to sample a text's font glyph texture. The current hit primitive must be a text using the RED::FNT_TEXTURE rendering mode.

Parameters:

Samples a normal map or a displacement map. Returns the WCS normal vector.

If there's no normal map texture or if there's no displacement map, the method will return the interpolated world space normal.

Parameters:

Samples a texture.

Parameters:

Samples a color or a texture.

If the texture is valid, the method will sample it using the provided interpolation channel. Otherwise, the color is returned. The method handles composite textures as well.

Parameters:

Samples a color or a texture.

If the texture is valid, the method will sample it using the provided interpolation channel. Otherwise, the color is returned. The method handles composite textures as well.

Parameters:

Samples a color or a texture.

If the texture is valid, the method will sample it using the provided uv coordinates. Otherwise, the color is returned. The method handles composite textures as well.

Parameters:

Samples a texture.

Parameters: