Class TAbstractBackgroundNode

Unit

Declaration

type TAbstractBackgroundNode = class(TAbstractBindableNode)

Description

Abstract type from which all backgrounds inherit.

Hierarchy

Overview

Methods

Protected function DirectEnumerateActive(Func: TEnumerateChildrenFunction): Pointer; override;
Public constructor Create(const AX3DName: string = ''; const ABaseUrl: string = ''); override;
Public function TransformRotation: TVector4;
Public procedure CreateNode; override;
Public class function ClassX3DType: string; override;
Public procedure SetShaders(const Value: array of TAbstractShaderNode);
Public procedure SetEffects(const Value: array of TEffectNode);

Properties

Public property FdShaders: TMFNode read FFdShaders;
Public property FdEffects: TMFNode read FFdEffects;

Description

Methods

Protected function DirectEnumerateActive(Func: TEnumerateChildrenFunction): Pointer; override;

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

Enumerate all active child nodes of given node.

"Active nodes" are the ones affecting current look or collisions, e.g. from Switch node only one child will be enumerated. See Traverse for more precise definition.

"Direct" means that this enumerates only direct descendants, i.e. this is not recursive. See methods like Traverse or EnumerateNodes if you want recursive behavior.

This can enumerate both VRML1Children nodes and nodes within TSFNode and TMFNode fields.

Default implementation in this class enumerates all Children nodes of VRML 1.0. If you need to remove some children for VRML 1.0 (e.g. for Switch or LOD nodes) or add some children for VRML 2.0 you have to override this. You do not need to call inherited when overriding this — in fact, you should not, if you want to omit some nodes.

Stops and returns immediately if Func returns non-nil for some child.

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 function TransformRotation: TVector4;

Extract only rotation (axis-angle format) from the transformation.

Public procedure CreateNode; override;

Automatically generated node properties.

Do not edit this file manually! To add new properties: - add them to the text files in tools/internal/x3d-nodes-to-pascal/nodes-specification/ , - and regenerate include files by running x3d-nodes-to-pascal

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.

Public procedure SetShaders(const Value: array of TAbstractShaderNode);

Shaders used to render background geometry.

Public procedure SetEffects(const Value: array of TEffectNode);

Shader effects (see https://castle-engine.io/compositing_shaders.php) used to render background geometry.

Properties

Public property FdShaders: TMFNode read FFdShaders;

Internal wrapper for property Shaders. This wrapper API may change, we advise to access simpler Shaders instead.

Public property FdEffects: TMFNode read FFdEffects;

Internal wrapper for property Effects. This wrapper API may change, we advise to access simpler Effects instead.


Generated by PasDoc 0.16.0.