API Reference

Class TGeneratedShadowMapNode

Description
Hierarchy
Fields
Methods
Properties

Unit

X3DNodes

Declaration

type TGeneratedShadowMapNode = class(TAbstractSingleTextureNode)

Description

Generate texture by rendering a depth (shadow) map. See https://castle-engine.io/x3d_extensions_shadow_maps.php

Hierarchy

Overview

Fields

Public nested const DefaultSize = 128;
Public nested const DefaultScale = 4.0;
Public nested const DefaultBias = 4.0;

Methods

Public constructor Create(const AX3DName: String = ''; const ABaseUrl: String = ''); override;
Public procedure CreateNode; override;
Public class function ClassX3DType: String; override;

Properties

Public property FdUpdate: TSFStringEnum read FFdUpdate;
Public property Update: TTextureUpdate read GetUpdate write SetUpdate;
Public property FdSize: TSFInt32 read FFdSize;
Public property Size: Integer read GetSize write SetSize;
Public property FdLight: TSFNode read FFdLight;
Public property Light: TAbstractPunctualLightNode read GetLight write SetLight;
Public property FdScale: TSFFloat read FFdScale;
Public property Scale: Single read GetScale write SetScale;
Public property FdBias: TSFFloat read FFdBias;
Public property Bias: Single read GetBias write SetBias;
Public property FdCompareMode: TSFStringEnum read FFdCompareMode;
Public property CompareMode: TShadowMapCompareMode read GetCompareMode write SetCompareMode;

Description

Fields

Public nested const DefaultSize = 128;

This item has no description.

Public nested const DefaultScale = 4.0;

This item has no description.

Public nested const DefaultBias = 4.0;

This item has no description.

Methods

Public constructor Create(const AX3DName: String = ''; const ABaseUrl: String = ''); override;

This item has no description. Showing description inherited from TX3DNode.Create.

Constructor. Initializes various properties:

  • Name, BaseUrl are initialized from given parameters.

  • The Fields, Events lists are filled in every descendant, to have all the fields/events defined by the specification.

  • DefaultContainerField, and other node-specific stuff, is filled in descendants. This is actually implemented in CreateNode, that is called at the end of this constructor.

Public procedure CreateNode; override;

Create node fields and events.

Public class function ClassX3DType: String; override;

This item has no description. Showing description inherited from TX3DNode.ClassX3DType.

Node type name in VRML/X3D, for this class. Normal VRML/X3D node classes should override this to return something non-empty, and then X3DType automatically will return the same value.

Empty for classes that don't have a hardcoded VRML/X3D node name, like a special TX3DUnknownNode. Such special classes should override then X3DType to return actual non-empty name there.

You usually should call X3DType. The only use of this method is that it works on classes (it's "class function"), without needing at actual instance.

Properties

Public property FdUpdate: TSFStringEnum read FFdUpdate;

Internal wrapper for property Update. This wrapper API may change, we advise to access simpler Update instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property Update: TTextureUpdate read GetUpdate write SetUpdate;

When to update the texture contents.

Public property FdSize: TSFInt32 read FFdSize;

Internal wrapper for property Size. This wrapper API may change, we advise to access simpler Size instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property Size: Integer read GetSize write SetSize;

This item has no description.

Public property FdLight: TSFNode read FFdLight;

Internal wrapper for property Light. This wrapper API may change, we advise to access simpler Light instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property Light: TAbstractPunctualLightNode read GetLight write SetLight;

Warning: this symbol is deprecated.

This field is only used internally by the engine now. You should never specify any light source here. The light source associated with the shadow map is implicit: it is the parent node of this GeneratedShadowMap node, that defined this GeneratedShadowMap node in defaultShadowMap field.

Public property FdScale: TSFFloat read FFdScale;

Internal wrapper for property Scale. This wrapper API may change, we advise to access simpler Scale instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property Scale: Single read GetScale write SetScale;

This item has no description.

Public property FdBias: TSFFloat read FFdBias;

Internal wrapper for property Bias. This wrapper API may change, we advise to access simpler Bias instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property Bias: Single read GetBias write SetBias;

This item has no description.

Public property FdCompareMode: TSFStringEnum read FFdCompareMode;

Internal wrapper for property CompareMode. This wrapper API may change, we advise to access simpler CompareMode instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property CompareMode: TShadowMapCompareMode read GetCompareMode write SetCompareMode;

Warning: this symbol is deprecated.

This is ignored now. It was unportable and complicated to maintain.

Generated by PasDoc 0.16.0-snapshot.

Copyright Michalis Kamburelis and Castle Game Engine Contributors.

This webpage is also open-source and we welcome pull requests to improve it.

We use cookies for analytics. See our privacy policy.