Class TFogNode

Description

Hierarchy

Fields

Methods

Properties

Unit

X3DNodes

Declaration

type TFogNode = class(TAbstractBindableNode)

Description

Simulate atmospheric fog effects (for the whole scene) by blending with the fog colour, based on the distance from the viewer.

Hierarchy

Overview

Methods

	`constructor Create(const AX3DName: String = ''; const ABaseUrl: String = ''); override;`
	`function TransformationChange: TNodeTransformationChange; override;`
	`function FogTypeOrNone: TFogTypeOrNone;`
	`procedure ApplyFog(var Color: TVector3; const Position, VertexPos: TVector3; const AFogType: TFogTypeOrNone);`
	`procedure CreateNode; override;`
	`class function ClassX3DType: string; override;`

Properties

	`property FdColor: TSFColor read FFdColor;`
	`property Color: TCastleColorRGB read GetColor write SetColor;`
	`property FdFogType: TSFStringEnum read FFdFogType;`
	`property FogType: TFogType read GetFogType write SetFogType;`
	`property FdVisibilityRange: TSFFloat read FFdVisibilityRange;`
	`property VisibilityRange: Single read GetVisibilityRange write SetVisibilityRange;`
	`property FdVolumetric: TSFBool read FFdVolumetric;`
	`property Volumetric: Boolean read GetVolumetric write SetVolumetric;`
	`property FdVolumetricDirection: TSFVec3f read FFdVolumetricDirection;`
	`property VolumetricDirection: TVector3 read GetVolumetricDirection write SetVolumetricDirection;`
	`property FdVolumetricVisibilityStart: TSFFloat read FFdVolumetricVisibilityStart;`
	`property VolumetricVisibilityStart: Single read GetVolumetricVisibilityStart write SetVolumetricVisibilityStart;`

Description

Methods

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.

	`function TransformationChange: TNodeTransformationChange; override;`
This item has no description.

	`function FogTypeOrNone: TFogTypeOrNone;`
Fog type, but may also return ftNone if we are `Nil` (checks Self <> nil) or visibilityRange = 0.

procedure ApplyFog(var Color: TVector3; const Position, VertexPos: TVector3; const AFogType: TFogTypeOrNone);

Apply fog to the color of the vertex.

This can be used by software renderers (ray-tracers etc.) to calculate pixel color following VRML/X3D specifications. After all the lighting is summed up (see TX3DGraphTraverseState.Emission and TLightInstance.Contribution), process color by this method to apply fog.

Does nothing if AFogType = ftNone. In this special case, it's also allowed to call this on Nil instance.

procedure CreateNode; override;

This item has no description. Showing description inherited from TAbstractBindableNode.CreateNode.

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

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

	`property FdColor: TSFColor read FFdColor;`
Internal wrapper for property Color. This wrapper API may change, we advise to access simpler Color instead.

	`property Color: TCastleColorRGB read GetColor write SetColor;`
This item has no description.

	`property FdFogType: TSFStringEnum read FFdFogType;`
Internal wrapper for property FogType. This wrapper API may change, we advise to access simpler FogType instead.

	`property FogType: TFogType read GetFogType write SetFogType;`
This item has no description.

	`property FdVisibilityRange: TSFFloat read FFdVisibilityRange;`
Internal wrapper for property VisibilityRange. This wrapper API may change, we advise to access simpler VisibilityRange instead.

	`property VisibilityRange: Single read GetVisibilityRange write SetVisibilityRange;`
This item has no description.

	`property FdVolumetric: TSFBool read FFdVolumetric;`
Internal wrapper for property Volumetric. This wrapper API may change, we advise to access simpler Volumetric instead.

	`property Volumetric: Boolean read GetVolumetric write SetVolumetric;`
Activate `volumetric` fog, see https://castle-engine.io/x3d_extensions.php

	`property FdVolumetricDirection: TSFVec3f read FFdVolumetricDirection;`
Internal wrapper for property VolumetricDirection. This wrapper API may change, we advise to access simpler VolumetricDirection instead.

	`property VolumetricDirection: TVector3 read GetVolumetricDirection write SetVolumetricDirection;`
This item has no description.

	`property FdVolumetricVisibilityStart: TSFFloat read FFdVolumetricVisibilityStart;`
Internal wrapper for property VolumetricVisibilityStart. This wrapper API may change, we advise to access simpler VolumetricVisibilityStart instead.

	`property VolumetricVisibilityStart: Single read GetVolumetricVisibilityStart write SetVolumetricVisibilityStart;`
This item has no description.

Generated by PasDoc 0.16.0-snapshot.

API Reference

Class TFogNode

Unit

Declaration

Description

Hierarchy

Overview

Methods

Properties

Description

Methods

Properties