Unit CastleScene

Description

Uses

Classes, Interfaces, Objects and Records

Functions and Procedures

Types

Constants

Variables

Description

Rendering of scenes (TCastleScene).

Uses

SysUtils
Classes
Generics.Collections
GL
GLExt
CastleVectors
CastleBoxes
X3DNodes
CastleClassUtils
CastleFonts
CastleUtils
CastleSceneCore
CastleInternalRenderer
CastleInternalBackgroundRenderer
CastleGLUtils
CastleInternalShapeOctree
CastleInternalGLShadowVolumes
X3DFields
CastleTriangles
CastleShapes
CastleFrustum
CastleTransform
CastleGLShaders
CastleRectangles
CastleCameras
CastleRendererInternalShader
CastleColors
CastleSceneInternalShape
CastleSceneInternalOcclusion
CastleSceneInternalBlending
CastleInternalBatchShapes
CastleRenderOptions
CastleTimeUtils
CastleImages
CastleBehaviors

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;

TCastleSceneClass = class of TCastleScene;

TTriangle4List = specialize TStructList<TTriangle4>;

TUseHeadlight = (...);

TPrimitiveMaterial = (...);

Constants

prRenderSelf = CastleTransform.prRenderSelf;

prRenderClones = CastleTransform.prRenderClones;

prBackground = CastleTransform.prBackground;

prBoundingBox = CastleTransform.prBoundingBox;

prShadowVolume = CastleTransform.prShadowVolume;

bsNone = CastleRenderOptions.bsNone;

bs2D = CastleRenderOptions.bs2D;

bs3D = CastleRenderOptions.bs3D;

weNormal = CastleRenderOptions.weNormal;

weWireframeOnly = CastleRenderOptions.weWireframeOnly;

weSolidWireframe = CastleRenderOptions.weSolidWireframe;

weSilhouette = CastleRenderOptions.weSilhouette;

paDefault = CastleSceneCore.paDefault;

paForceLooping = CastleSceneCore.paForceLooping;

paForceNotLooping = CastleSceneCore.paForceNotLooping;

paLooping = CastleSceneCore.paLooping;

paNotLooping = CastleSceneCore.paNotLooping;

ssRendering = CastleSceneCore.ssRendering;

ssDynamicCollisions = CastleSceneCore.ssDynamicCollisions;

ssVisibleTriangles = CastleSceneCore.ssVisibleTriangles;

ssStaticCollisions = CastleSceneCore.ssStaticCollisions;

Variables

GLContextCache: TGLRendererContextCache;

InternalEnableRendering: Boolean = true;

DynamicBatching: Boolean = false;

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.

TSceneRenderingAttributes = TCastleRenderOptions deprecated 'use TCastleRenderOptions';

Warning: this symbol is deprecated: use TCastleRenderOptions

This item has no description.

TPrepareResourcesOption = CastleTransform.TPrepareResourcesOption;

This item has no description.

TPrepareResourcesOptions = CastleTransform.TPrepareResourcesOptions;

This item has no description.

TCastleSceneClass = class of TCastleScene;

This item has no description.

TTriangle4List = specialize TStructList<TTriangle4>;

This item has no description.

TUseHeadlight = (...);

Possible value of TCastleRootTransform.UseHeadlight.

Values

hlOn: Always show a headlight. The headlight properties (color, intensity, shape) are taken from TCastleRootTransform.HeadlightNode.
hlOff: Never show a headlight.
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.

TPrimitiveMaterial = (...);

Primitive material type, used by TCastleAbstractPrimitive.Material.

Values

pmPhysical
pmPhong
pmUnlit

Constants

prRenderSelf = CastleTransform.prRenderSelf;

This item has no description.

prRenderClones = CastleTransform.prRenderClones;

This item has no description.

prBackground = CastleTransform.prBackground;

This item has no description.

prBoundingBox = CastleTransform.prBoundingBox;

This item has no description.

prShadowVolume = CastleTransform.prShadowVolume;

This item has no description.

bsNone = CastleRenderOptions.bsNone;

We recommend using CastleRenderOptions unit to get these types. But for backward compatibility, they are also available here.

bs2D = CastleRenderOptions.bs2D;

This item has no description.

bs3D = CastleRenderOptions.bs3D;

This item has no description.

weNormal = CastleRenderOptions.weNormal;

This item has no description.

weWireframeOnly = CastleRenderOptions.weWireframeOnly;

This item has no description.

weSolidWireframe = CastleRenderOptions.weSolidWireframe;

This item has no description.

weSilhouette = CastleRenderOptions.weSilhouette;

This item has no description.

paDefault = CastleSceneCore.paDefault;

This item has no description.

paForceLooping = CastleSceneCore.paForceLooping;

This item has no description.

paForceNotLooping = CastleSceneCore.paForceNotLooping;

This item has no description.

paLooping = CastleSceneCore.paLooping;

This item has no description.

paNotLooping = CastleSceneCore.paNotLooping;

This item has no description.

ssRendering = CastleSceneCore.ssRendering;

This item has no description.

ssDynamicCollisions = CastleSceneCore.ssDynamicCollisions;

This item has no description.

ssVisibleTriangles = CastleSceneCore.ssVisibleTriangles;

This item has no description.

ssStaticCollisions = CastleSceneCore.ssStaticCollisions;

This item has no description.

Variables

GLContextCache: TGLRendererContextCache;

Global OpenGL context cache. This caches common things, like textures, shapes, and much more. Our OpenGL resources are currently shared across all OpenGL contexts, and they all automatically share this cache.

InternalEnableRendering: Boolean = true;

This item has no description.

DynamicBatching: Boolean = false;

Combine (right before rendering) multiple shapes with a similar appearance into one. This can drastically reduce the number of "draw calls", making rendering much faster.

Generated by PasDoc 0.16.0-snapshot.

API Reference

Unit CastleScene

Description

Uses

Overview

Classes, Interfaces, Objects and Records

Types

Constants

Variables

Description

Types

Values

Values

Constants

Variables