Class TClassicRayTracer

This item is declared in ancestor TRayTracer.

Spatial structure (that contains geometry with materials) to render. You can create it using e.g. CreateOctreeVisibleTrianglesForScene for TCastleScene. Must be set before calling Execute.

Source: scene/castleraytracer.pas (line 58).

This item is declared in ancestor TRayTracer.

Image where the ray-tracer result will be stored. Must be set before calling Execute.

We will not resize given here Image. Instead we will use it's current size — so you just have to set Image size as appropriate before calling this method.

For every pixel, we calculate it's color and store it by TCastleImage.Color[X, Y, 0] := xxx method. We don't modify alpha channel of the image.

Using TRGBFloatImage class is advised if you want the full color information. Otherwise color precision is lost beyond 8 bits, and values above 1.0 are clamped.

Source: scene/castleraytracer.pas (line 74).

This item is declared in ancestor TRayTracer.

Camera view. CamDirection and CamUp do not have to be normalized — we will correct them here if needed. CamUp will be automatically corrected to be orthogonal to CamDirection if necessary, you only make sure it's not parallel to CamDirection.

Source: scene/castleraytracer.pas (line 82).

This item is declared in ancestor TRayTracer.

Camera view. CamDirection and CamUp do not have to be normalized — we will correct them here if needed. CamUp will be automatically corrected to be orthogonal to CamDirection if necessary, you only make sure it's not parallel to CamDirection.

Source: scene/castleraytracer.pas (line 82).

This item is declared in ancestor TRayTracer.

Camera view. CamDirection and CamUp do not have to be normalized — we will correct them here if needed. CamUp will be automatically corrected to be orthogonal to CamDirection if necessary, you only make sure it's not parallel to CamDirection.

Source: scene/castleraytracer.pas (line 82).

This item is declared in ancestor TRayTracer.

Camera projection properties.

Source: scene/castleraytracer.pas (line 85).

This item is declared in ancestor TRayTracer.

Default background color, if scene doesn't have Background node with skyColor.

Source: scene/castleraytracer.pas (line 88).

This item is declared in ancestor TRayTracer.

Scene Background node.

Source: scene/castleraytracer.pas (line 91).

This item is declared in ancestor TRayTracer.

Callback notified (if assigned) about writing each image pixel. This way you can display somewhere, or store to file, partially generated image. This callback gets information (in PixelsMadeCount) about how many pixels were generated (this includes also pixels skipped in case FirstPixel > 0).

The pixels are written in the order of TSwapScanCurve for TClassicRayTracer, and in order dependent on TPathTracer.SFCurveClass for TPathTracer. When shadow cache will be implemented to TClassicRayTracer, then configurable SFCurveClass may be done also for TClassicRayTracer.

Remember that pixels not done yet have the same content as they had when you Execute method started. In other words, if you set PixelsMadeNotifier <> nil, then often it's desirable to initialize Image content with some color (e.g. black) before calling Execute. Otherwise at the time of Execute call, the pixels not done yet will have undefined colors.

Source: scene/castleraytracer.pas (line 110).

This item is declared in ancestor TRayTracer.

This item has no description.

Source: scene/castleraytracer.pas (line 111).

This item is declared in ancestor TRayTracer.

Initial pixel to start rendering from. By setting this to something > 0, you can (re-)start rendering from the middle. Useful to finish the job of a previous terminated ray-tracer process.

Must be in [0 .. Image.Width * Image.Height] range. Setting to Image.Width * Image.Height makes the ray-tracer do nothing.

Source: scene/castleraytracer.pas (line 120).

This item is declared in ancestor TRayTracer.

Do ray-tracing, like Execute, additionally gathering some statistics. The statistics will be added to the given string list.

Source: scene/castleraytracer.pas (line 128).