Custom volume shaders

When using custom volume shaders, you should make your shader compatible with the Maya volume engine. This is the best way to make volume shaders work correctly with render passes, Maya light shaders and other Maya features.

To do so, use the following data structure for the shader result rather than a simple miColor:

typedef struct VolumeShader_R {
miColor color;
miColor glowColor;
miColor matteOpacity;
miColor transparency;
} VolumeShader_R; 

The volume is considered opaque unless the transparency field of the structure is set to a non-zero value. The volume engine takes care of integrating and compositing volume samples, so the volume shader only needs to take care of computing the raw color value and transparency for the current sample.

To retrieve the start and end points of the current volume ray segment, use the following code:

miVector orgObj, pointObj;
mi_point_to_object(state, &orgObj, &state->org);
mi_point_to_object(state, &pointObj, &state->point);

Then, to get the traversed length, in object space, do the following:

miScalar length = mi_vector_dist(&orgObj, &pointObj);

miCreateDefaultNodes();
select mentalrayGlobals;
addAttr -ln useVolumeEngine -at bool;
setAttr mentalrayGlobals.useVolumeEngine false;