Unit CastleScene

Description

Uses

Classes, Interfaces, Objects and Records

Functions and Procedures

Types

Constants

Variables

Description

Rendering of scenes (TCastleScene).

Source: src/scene/castlescene.pas (line 17).

Uses

SysUtils
Classes
Generics.Collections
CastleGL
CastleVectors
CastleBoxes
X3DNodes
CastleClassUtils
CastleFonts
CastleUtils
CastleSceneCore
CastleInternalBackgroundRenderer
CastleGLUtils
CastleInternalShapeOctree
CastleInternalGLShadowVolumes
X3DFields
CastleTriangles
CastleShapes
CastleFrustum
CastleTransform
CastleGLShaders
CastleRectangles
CastleCameras
CastleRendererInternalShader
CastleColors
CastleSceneInternalShape
CastleInternalFileMonitor
CastleRenderOptions
CastleTimeUtils
CastleImages
CastleBehaviors
CastleInternalShapesRenderer
CastleSceneInternalBlending
CastleInternalPrimitiveMaterial

Overview

Classes, Interfaces, Objects and Records

Name	Description
Class `TCastleScene`	Complete loading, processing and rendering of a scene.
Class `TCastleSceneList`
Class `TCastleRootTransform`	Root of transformations and scenes (tree of TCastleTransform and TCastleScene).
Class `TCastleAbstractPrimitive`	Base class to express primitives that can be easily added and adjusted inside TCastleViewport.
Class `TCastleText`	Text that is displayed and transformed as TCastleTransform, inside TCastleViewport, and can be manipulated in 3D.
Class `TCastleBox`	Box with configurable size, position and material.
Class `TCastleSphere`	Sphere with configurable size, position and material.
Class `TCastlePlane`	Plane with configurable size, position and material.
Class `TCastleCone`	Cone with configurable size, position and material.
Class `TCastleCylinder`	Cylinder with configurable size, position and material.
Class `TCastleImageTransform`	Image (that you can place within TCastleViewport) with configurable size and repeat.
Class `TCastleBackground`	Background, a skybox with a color gradient to represent sky and ground behind.
Class `TCastleFog`	Control fog in 3D world.
Class `TCastleAbstractLight`	Base class to express lights that can be easily added and adjusted inside TCastleViewport.
Class `TCastlePunctualLight`	Ancestor class for all punctual lights: point, spot, directional.
Class `TCastlePointLight`	Point light is a point in 3D space that shines uniformly in all directions.
Class `TCastleDirectionalLight`	Directional light shines along a direction in 3D space, simulating a light source far away (like a sun).
Class `TCastleSpotLight`	Spot light shines a cone of light, from a given location, along a direction (-Z in local coordinates).

Types

TBeforeShapeRenderProc = procedure (Shape: TShape) of object;

TRenderingAttributesEvent = TCastleRenderOptionsEvent deprecated 'use TCastleRenderOptionsEvent';

TSceneRenderingAttributes = TCastleRenderOptions deprecated 'use TCastleRenderOptions';

TPrepareResourcesOption = CastleTransform.TPrepareResourcesOption;

TPrepareResourcesOptions = CastleTransform.TPrepareResourcesOptions;

TTransformOptimization = (...);

TCastleSceneClass = class of TCastleScene;

TTriangle4List = specialize TStructList<TTriangle4>;

TUseHeadlight = (...);

Constants

prRenderSelf = CastleTransform.prRenderSelf;

prRenderClones = CastleTransform.prRenderClones;

prBackground = CastleTransform.prBackground;

prBoundingBox = CastleTransform.prBoundingBox;

prShadowVolume = CastleTransform.prShadowVolume;

weNormal = CastleRenderOptions.weNormal;

weWireframeOnly = CastleRenderOptions.weWireframeOnly;

weSolidWireframe = CastleRenderOptions.weSolidWireframe;

weSilhouette = CastleRenderOptions.weSilhouette;

Variables

InternalEnableRendering: Boolean = true;

DynamicBatching: Boolean = false
    deprecated 'use TCastleViewport.DynamicBatching';

Description

Types

TBeforeShapeRenderProc = procedure (Shape: TShape) of object;

This item has no description.

TRenderingAttributesEvent = TCastleRenderOptionsEvent deprecated 'use TCastleRenderOptionsEvent';

Warning: this symbol is deprecated: use TCastleRenderOptionsEvent

This item has no description.

Source: src/scene/castlescene.pas (line 57).

TSceneRenderingAttributes = TCastleRenderOptions deprecated 'use TCastleRenderOptions';

Warning: this symbol is deprecated: use TCastleRenderOptions

This item has no description.

Source: src/scene/castlescene.pas (line 58).

TPrepareResourcesOption = CastleTransform.TPrepareResourcesOption;

This item has no description.

Source: src/scene/castlescene.pas (line 60).

TPrepareResourcesOptions = CastleTransform.TPrepareResourcesOptions;

This item has no description.

Source: src/scene/castlescene.pas (line 61).

TTransformOptimization = (...);

Possible values for TCastleScene.TransformOptimization.

Values

toAutomatic: Automatically decide whether the transformation of this scene changes often enough to prefer optimizations for toStatic or toDynamic case.
Right now, this behaves like toDynamic when the scene is present multiple times in the TCastleAbstractRootTransform hierarchy, for example when using TCastleTransformReference to render the same scene many times. Otherwise this behaves like toStatic.
This automatic detection may make unoptimal decision, which is why you can set TCastleScene.TransformOptimization explicitly to toStatic or toDynamic if you "know better". Examples when it makes sense to manually select optimization:
- When the scene is present multiple times in the TCastleAbstractRootTransform hierarchy (e.g. when using TCastleTransformReference) but all these occurrences are very close to each other, thus are within radiuses of the same lights.
  In this case, automatic detection makes unoptimal decision to behave like toDynamic, which means shaders calculate more light sources. Setting TCastleScene.TransformOptimization to toStatic in this case is better.
- When the scene is present only once in the TCastleAbstractRootTransform hierarchy, but you know that you will change the scene translation very often (e.g. almost every frame) and the translation change will be large enough to make the scene affected by different light sources. Or maybe you know you will change the light's positions or radiuses very often by large values.
  In this case, automatic detection makes unoptimal decision to behave like toStatic, which means that shaders will be often recreated when the scene (or light sources) move. Setting TCastleScene.TransformOptimization to toDynamic in this case is better, it means that shaders for this shape will not change.
Source: src/scene/castlescene.pas (line 107).
toStatic: Choose optimizations that are beneficial for TCastleScene instances whose world transformation (translation, rotation, scale of this and all parents) never changes, or rarely changes, or changes only by a very small amount.
Source: src/scene/castlescene.pas (line 113).
toDynamic: Choose optimizations that are beneficial for TCastleScene instances whose world transformation (translation, rotation, scale of this and all parents) changes often and by large values.
Source: src/scene/castlescene.pas (line 118).

Source: src/scene/castlescene.pas (line 64).

TCastleSceneClass = class of TCastleScene;

This item has no description.

Source: src/scene/castlescene.pas (line 625).

TTriangle4List = specialize TStructList<TTriangle4>;

This item has no description.

Source: src/scene/castlescene.pas (line 630).

TUseHeadlight = (...);

Possible value of TCastleRootTransform.UseHeadlight.

Values

hlOn: Always show a headlight. The headlight properties (color, intensity, shape) are taken from TCastleRootTransform.HeadlightNode.
Source: src/scene/castlescene_roottransform.inc (line 27).
hlOff: Never show a headlight.
Source: src/scene/castlescene_roottransform.inc (line 30).
hlMainScene: Show a headlight following the TCastleRootTransform.MainScene properties.
If TCastleRootTransform.MainScene is Nil, there is no headlight.
If TCastleRootTransform.MainScene is assigned, the headlight is shown if MainScene.HeadlightOn is True. MainScene.HeadlightOn in turn is configutable, and by default looks at X3D NavigationInfo.headlight field. (If no NavigationInfo node is present, the headlight is shown, as NavigationInfo.headlight is True by default.)
The headlight properties (color, intensity, shape) follow MainScene.CustomHeadlight, which can be customized in an X3D file using https://castle-engine.io/x3d_implementation_navigation_extensions.php#section_ext_headlight . If no MainScene.CustomHeadlight is set, we use TCastleRootTransform.HeadlightNode.
Source: src/scene/castlescene_roottransform.inc (line 53).

Source: src/scene/castlescene_roottransform.inc (line 23).

Constants

prRenderSelf = CastleTransform.prRenderSelf;

This item has no description.

Source: src/scene/castlescene.pas (line 46).

prRenderClones = CastleTransform.prRenderClones;

This item has no description.

Source: src/scene/castlescene.pas (line 47).

prBackground = CastleTransform.prBackground;

This item has no description.

Source: src/scene/castlescene.pas (line 48).

prBoundingBox = CastleTransform.prBoundingBox;

This item has no description.

Source: src/scene/castlescene.pas (line 49).

prShadowVolume = CastleTransform.prShadowVolume;

This item has no description.

Source: src/scene/castlescene.pas (line 50).

weNormal = CastleRenderOptions.weNormal;

This item has no description.

Source: src/scene/castlescene.pas (line 666).

weWireframeOnly = CastleRenderOptions.weWireframeOnly;

This item has no description.

Source: src/scene/castlescene.pas (line 667).

weSolidWireframe = CastleRenderOptions.weSolidWireframe;

This item has no description.

Source: src/scene/castlescene.pas (line 668).

weSilhouette = CastleRenderOptions.weSilhouette;

This item has no description.

Source: src/scene/castlescene.pas (line 669).

Variables

InternalEnableRendering: Boolean = true;

This item has no description.

Source: src/scene/castlescene.pas (line 656).

DynamicBatching: Boolean = false
    deprecated 'use TCastleViewport.DynamicBatching';

Warning: this symbol is deprecated: use TCastleViewport.DynamicBatching

This item has no description.

Source: src/scene/castlescene.pas (line 658).

Generated by PasDoc 0.17.0.snapshot.

API Reference

Unit CastleScene

Description

Uses

Overview

Classes, Interfaces, Objects and Records

Types

Constants

Variables

Description

Types

Values

Values

Constants

Variables