Class TCastleScene

Unit

Declaration

type TCastleScene = class(TCastleSceneCore)

Description

Complete loading, processing and rendering of a scene. This is a descendant of TCastleSceneCore that adds efficient rendering.

Hierarchy

Overview

Fields

Public InternalIgnoreFrustum: boolean;
Public InternalVisibilityTest: TTestShapeVisibility;

Methods

Protected function CreateShape(const AGeometry: TAbstractGeometryNode; const AState: TX3DGraphTraverseState; const ParentInfo: PTraversingInfo): TShape; override;
Protected procedure InvalidateBackground; override;
Protected procedure LocalRender(const Params: TRenderParams); override;
Protected procedure LocalRenderShadowVolume( ShadowVolumeRenderer: TBaseShadowVolumeRenderer; const ParentTransformIsIdentity: boolean; const ParentTransform: TMatrix4); override;
Public constructor Create(AOwner: TComponent); override;
Public destructor Destroy; override;
Public procedure GLContextClose; override;
Public procedure PrepareResources(const Options: TPrepareResourcesOptions; const ProgressStep: boolean; const Params: TPrepareParams); override;
Public procedure BeforeNodesFree(const InternalChangedAll: boolean = false); override;
Public procedure Setup2D;
Public procedure FreeResources(Resources: TSceneFreeResources); override;
Public function Attributes: TSceneRenderingAttributes;
Public procedure UpdateGeneratedTextures( const RenderFunc: TRenderFromViewFunction; const ProjectionNear, ProjectionFar: Single); override;
Public procedure ViewChangedSuddenly; override;
Public procedure VisibleChangeNotification(const Changes: TVisibleChanges); override;
Public procedure CameraChanged(const ACamera: TCastleCamera); override;
Public function ScreenEffects(Index: Integer): TGLSLProgram;
Public function ScreenEffectsCount: Integer;
Public function ScreenEffectsNeedDepth: boolean;
Public function Clone(const AOwner: TComponent): TCastleScene;

Properties

Public property BackgroundSkySphereRadius: Single read FBackgroundSkySphereRadius write SetBackgroundSkySphereRadius default 1;
Public property FrustumCulling: TFrustumCulling read FFrustumCulling write SetFrustumCulling default fcBox; deprecated 'use simpler ShapeFrustumCulling';
Public property OctreeFrustumCulling: TFrustumCulling read FOctreeFrustumCulling write SetOctreeFrustumCulling default fcBox; deprecated 'use simpler ShapeFrustumCulling';
Published property ShapeFrustumCulling: Boolean read FShapeFrustumCulling write SetShapeFrustumCulling default true;
Published property SceneFrustumCulling: Boolean read FSceneFrustumCulling write FSceneFrustumCulling default true;
Published property ReceiveShadowVolumes: boolean read FReceiveShadowVolumes write FReceiveShadowVolumes default true;
Published property DistanceCulling: Single read FDistanceCulling write SetDistanceCulling default 0;

Description

Fields

Public InternalIgnoreFrustum: boolean;

Internal hack to avoid checking frustum at rendering in some situations.

Public InternalVisibilityTest: TTestShapeVisibility;

Internal override test visibility.

Methods

Protected function CreateShape(const AGeometry: TAbstractGeometryNode; const AState: TX3DGraphTraverseState; const ParentInfo: PTraversingInfo): TShape; override;
 
Protected procedure InvalidateBackground; override;
 
Protected procedure LocalRender(const Params: TRenderParams); override;
 
Protected procedure LocalRenderShadowVolume( ShadowVolumeRenderer: TBaseShadowVolumeRenderer; const ParentTransformIsIdentity: boolean; const ParentTransform: TMatrix4); override;

Render shadow volume (sides and caps) of this scene, for shadow volume algorithm. Uses ShadowVolumeRenderer for rendering, and to detect if rendering is necessary at all. It will calculate current bounding box (looking at ParentTransform, ParentTransformIsIdentity and LocalBoundingBox method).

It always uses silhouette optimization. This is the usual, fast method of rendering shadow volumes. Will not do anything (treat scene like not casting shadows, like CastShadowVolumes = false) if the model is not perfect 2-manifold, i.e. has some BorderEdges (although we could handle some BorderEdges for some points of view, this could leading to rendering artifacts).

All shadow quads are generated from scene triangles transformed by ParentTransform. We must be able to correctly detect front and back facing triangles with respect to light position, so ShadowVolumeRenderer.LightPosition and "this scene transformed by ParentTransform" must be in the same coordinate system. If ParentTransformIsIdentity then ParentTransform value is ignored and everything works like ParentTransform = identity matrix (and is a little faster in this special case).

Uses TrianglesListShadowCasters and ManifoldEdges and BorderEdges (so you may prefer to prepare it before, e.g. by calling PrepareResources with prShadowVolume included).

We look at some Attributes, like Attributes.Blending, because transparent triangles have to be handled a little differently, and when Attributes.Blending = false then all triangles are forced to be opaque. In other words, this takes Attributes into account, to cooperate with our Render method.

ShadowVolumeRenderer.LightPosition is the light position. ShadowVolumeRenderer.LightPosition[3] must be 1 (to indicate positional light) or 0 (a directional light). It's expected that ShadowVolumeRenderer is already initialized by ShadowVolumeRenderer.InitFrustumAndLight.

Faces (both shadow quads and caps) are rendered such that CCW <=> you're looking at it from outside (i.e. it's considered front face of this shadow volume).

Public constructor Create(AOwner: TComponent); override;
 
Public destructor Destroy; override;
 
Public procedure GLContextClose; override;

Destroy any associations of this object with current OpenGL context. For example, release any allocated texture names.

Generally speaking, destroys everything that is allocated by PrepareResources call. It's harmless to call this method when there are already no associations with current OpenGL context. This is called automatically from the destructor.

Public procedure PrepareResources(const Options: TPrepareResourcesOptions; const ProgressStep: boolean; const Params: TPrepareParams); override;
 
Public procedure BeforeNodesFree(const InternalChangedAll: boolean = false); override;
 
Public procedure Setup2D;

Adjust parameters for rendering 2D scenes. Sets BlendingSort := bs2D, which is good when your transparent objects have proper order along the Z axis (useful e.g. for Spine animations).

Public procedure FreeResources(Resources: TSceneFreeResources); override;
 
Public function Attributes: TSceneRenderingAttributes;

Rendering attributes.

You are free to change them all at any time. Although note that changing some attributes (the ones defined in base TRenderingAttributes class) may be a costly operation (next PrepareResources with prRenderSelf, or Render call, may need to recalculate some things).

Public procedure UpdateGeneratedTextures( const RenderFunc: TRenderFromViewFunction; const ProjectionNear, ProjectionFar: Single); override;
 
Public procedure ViewChangedSuddenly; override;
 
Public procedure VisibleChangeNotification(const Changes: TVisibleChanges); override;
 
Public procedure CameraChanged(const ACamera: TCastleCamera); override;
 
Public function ScreenEffects(Index: Integer): TGLSLProgram;

Screen effects information, used by TCastleViewport.ScreenEffects. ScreenEffectsCount may actually prepare screen effects.

Public function ScreenEffectsCount: Integer;
 
Public function ScreenEffectsNeedDepth: boolean;
 
Public function Clone(const AOwner: TComponent): TCastleScene;

Create a scene with the same contents (X3D scene graph) as this one. The created scene has exactly the same class as this one (we use ClassType.Create to call a virtual constructor).

Note that this does not copy other scene attributes, like ProcessEvents or Spatial or rendering attributes in Attributes.

Properties

Public property BackgroundSkySphereRadius: Single read FBackgroundSkySphereRadius write SetBackgroundSkySphereRadius default 1;
 
Public property FrustumCulling: TFrustumCulling read FFrustumCulling write SetFrustumCulling default fcBox; deprecated 'use simpler ShapeFrustumCulling';

Warning: this symbol is deprecated: use simpler ShapeFrustumCulling

What kind of per-shape frustum culling do when ShapeFrustumCulling is True, and we don't have octree (ssRendering is not included in TCastleSceneCore.Spatial).

Public property OctreeFrustumCulling: TFrustumCulling read FOctreeFrustumCulling write SetOctreeFrustumCulling default fcBox; deprecated 'use simpler ShapeFrustumCulling';

Warning: this symbol is deprecated: use simpler ShapeFrustumCulling

What kind of per-shape frustum culling do when ShapeFrustumCulling is True, and we have octree (ssRendering is included in TCastleSceneCore.Spatial).

Published property ShapeFrustumCulling: Boolean read FShapeFrustumCulling write SetShapeFrustumCulling default true;

Improve performance of rendering by checking for each shape whether it is inside frustum (camera pyramid of view) before rendering.

This is almost always a good idea. Exception may be when, in the most common scene position, all the shapes are inside the frustum, or all the shapes are outside the frustum. In this case this check is wasting time, and it matters if you have a lot of shapes. In such case, SceneFrustumCulling will be enough.

Published property SceneFrustumCulling: Boolean read FSceneFrustumCulling write FSceneFrustumCulling default true;

Improve performance of rendering by checking for the whole scene whether it is inside frustum (camera pyramid of view) before rendering.

This is almost always a good idea. Exception may be when the scene is almost always within the frustum, and you have a lot of scenes. In such case, this check may be a waste of time.

Published property ReceiveShadowVolumes: boolean read FReceiveShadowVolumes write FReceiveShadowVolumes default true;

Does this scene receive shadows by shadow volumes.

Published property DistanceCulling: Single read FDistanceCulling write SetDistanceCulling default 0;

Cull shapes farther than this distance. Ignored if <= 0.


Generated by PasDoc 0.15.0.