Class TAbstractPunctualLightNode

Description

Hierarchy

Fields

Methods

Properties

Unit

X3DNodes

Declaration

type TAbstractPunctualLightNode = class(TAbstractLightNode)

Description

Base class for all "punctual" light nodes (that have a position and/or direction).

Source: src/scene/x3d/x3dnodes_standard_lighting.inc (line 99).

Hierarchy

TObject
TPersistent
TX3DFileItem
TX3DNode
TAbstractNode
TAbstractChildNode
TAbstractLightNode
TAbstractPunctualLightNode

Overview

Methods

	`function GetProjectionLocationLocal: TVector3; virtual;`
	`procedure SetProjectionLocationLocal(const Value: TVector3); virtual;`
	`function GetProjectionDirectionLocal: TVector3; virtual;`
	`procedure SetProjectionDirectionLocal(const Value: TVector3); virtual;`
	`function ProjectionMatrix: TMatrix4; virtual;`
	`function ModelviewMatrix: TMatrix4; virtual;`
	`function ModelviewRotationMatrix: TMatrix4; virtual;`
	`function GetProjectorMatrix: TMatrix4;`
	`procedure GetView(out Pos, Dir, Side, Up: TVector3); overload;`
	`procedure GetView(out View: TViewVectors); overload;`
	`procedure Box3DDistances(const Box: TBox3D; out MinDistance, MaxDistance: Single); virtual; abstract;`
	`function PositionAndDirection: TVector4; virtual; abstract;`
	`procedure CreateNode; override;`
	`class function ClassX3DType: String; override;`

Properties

	`property ProjectionLocationLocal: TVector3 read GetProjectionLocationLocal write SetProjectionLocationLocal;`
	`property ProjectionDirectionLocal: TVector3 read GetProjectionDirectionLocal write SetProjectionDirectionLocal;`
	`property ProjectionWorldLocation: TVector3 read GetProjectionWorldLocation write SetProjectionWorldLocation;`
	`property ProjectionWorldDirection: TVector3 read GetProjectionWorldDirection write SetProjectionWorldDirection;`
	`property FdShadows: TSFBool read FFdShadows;`
	`property Shadows: Boolean read GetShadows write SetShadows;`
	`property FdShadowVolumesMain: TSFBool read FFdShadowVolumesMain;`
	`property ShadowVolumesMain: Boolean read GetShadowVolumesMain write SetShadowVolumesMain;`
	`property FdShowProxyGeometry: TSFBool read FFdShowProxyGeometry;`
	`property ShowProxyGeometry: Boolean read GetShowProxyGeometry write SetShowProxyGeometry;`
	`property FdProjectionNear: TSFFloat read FFdProjectionNear;`
	`property ProjectionNear: Single read GetProjectionNear write SetProjectionNear;`
	`property FdProjectionFar: TSFFloat read FFdProjectionFar;`
	`property ProjectionFar: Single read GetProjectionFar write SetProjectionFar;`
	`property FdUp: TSFVec3f read FFdUp;`
	`property Up: TVector3 read GetUp write SetUp;`
	`property FdDefaultShadowMap: TSFNode read FFdDefaultShadowMap;`
	`property DefaultShadowMap: TGeneratedShadowMapNode read GetDefaultShadowMap write SetDefaultShadowMap;`

Description

Methods

function GetProjectionLocationLocal: TVector3; virtual;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_lighting.inc (line 106).

procedure SetProjectionLocationLocal(const Value: TVector3); virtual;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_lighting.inc (line 107).

function GetProjectionDirectionLocal: TVector3; virtual;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_lighting.inc (line 108).

procedure SetProjectionDirectionLocal(const Value: TVector3); virtual;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_lighting.inc (line 109).

function ProjectionMatrix: TMatrix4; virtual;

Matrices for rendering shadow map from this light. Identity in this class, override for subclasses able to do shadow mapping.

Source: src/scene/x3d/x3dnodes_standard_lighting.inc (line 114).

function ModelviewMatrix: TMatrix4; virtual;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_lighting.inc (line 115).

function ModelviewRotationMatrix: TMatrix4; virtual;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_lighting.inc (line 116).

function GetProjectorMatrix: TMatrix4;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_lighting.inc (line 117).

procedure GetView(out Pos, Dir, Side, Up: TVector3); overload;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_lighting.inc (line 147).

procedure GetView(out View: TViewVectors); overload;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_lighting.inc (line 148).

procedure Box3DDistances(const Box: TBox3D; out MinDistance, MaxDistance: Single); virtual; abstract;

Calculate distances between the given Box and this light source. This is intended to capture the depth distances where the box resides, useful for calculating e.g. depth ranges to capture in the shadow maps. Depending on light source type, various distance measures may be used, appropriate to light sources projection.

Always MinDistance <= MaxDistance. They may be negative when we measure along the light's direction.

Exceptions raised

EBox3DEmpty: When used with an empty box.

Source: src/scene/x3d/x3dnodes_standard_lighting.inc (line 162).

function PositionAndDirection: TVector4; virtual; abstract;

Position and direction expressed in homogeneous coordinates. For positional lights, the last component is always 1. For directional lights, the last component is always 0.

Note that this is expressed in the local light node coordinate system.

Source: src/scene/x3d/x3dnodes_standard_lighting.inc (line 170).

procedure CreateNode; override;

Create node fields and events.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_x3dpunctuallightnode.inc (line 43).

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.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_x3dpunctuallightnode.inc (line 44).

Properties

property ProjectionLocationLocal: TVector3 read GetProjectionLocationLocal write SetProjectionLocationLocal;

Light location, direction and up vectors, for projection. Useful when you think of lights as cameras (for shadow maps).

ProjectionDirectionLocal will always be exactly zero for a PointLight (that doesn't have a direction).

The GetView returns vectors in global (scene) space. It guarantees that Direction, Side and Up are normalized and orthogonal to each other.

Source: src/scene/x3d/x3dnodes_standard_lighting.inc (line 131).

property ProjectionDirectionLocal: TVector3 read GetProjectionDirectionLocal write SetProjectionDirectionLocal;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_lighting.inc (line 135).

property ProjectionWorldLocation: TVector3 read GetProjectionWorldLocation write SetProjectionWorldLocation;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_lighting.inc (line 139).

property ProjectionWorldDirection: TVector3 read GetProjectionWorldDirection write SetProjectionWorldDirection;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_lighting.inc (line 143).

property FdShadows: TSFBool read FFdShadows;

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

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_x3dpunctuallightnode.inc (line 48).

property Shadows: Boolean read GetShadows write SetShadows;

This item has no description.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_x3dpunctuallightnode.inc (line 50).

property FdShadowVolumesMain: TSFBool read FFdShadowVolumesMain;

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

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_x3dpunctuallightnode.inc (line 54).

property ShadowVolumesMain: Boolean read GetShadowVolumesMain write SetShadowVolumesMain;

Does this light determine shadows (when using shadow volumes). Ignored if not ShadowVolumes.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_x3dpunctuallightnode.inc (line 56).

property FdShowProxyGeometry: TSFBool read FFdShowProxyGeometry;

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

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_x3dpunctuallightnode.inc (line 60).

property ShowProxyGeometry: Boolean read GetShowProxyGeometry write SetShowProxyGeometry;

InstantReality extension, see [http://instant-reality.com/documentation/nodetype/Light/].

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_x3dpunctuallightnode.inc (line 62).

property FdProjectionNear: TSFFloat read FFdProjectionNear;

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

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_x3dpunctuallightnode.inc (line 66).

property ProjectionNear: Single read GetProjectionNear write SetProjectionNear;

Projection near, for shadow maps. See https://castle-engine.io/x3d_extensions_shadow_maps.php

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_x3dpunctuallightnode.inc (line 68).

property FdProjectionFar: TSFFloat read FFdProjectionFar;

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

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_x3dpunctuallightnode.inc (line 72).

property ProjectionFar: Single read GetProjectionFar write SetProjectionFar;

Projection far, for shadow maps. See https://castle-engine.io/x3d_extensions_shadow_maps.php

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_x3dpunctuallightnode.inc (line 74).

property FdUp: TSFVec3f read FFdUp;

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

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_x3dpunctuallightnode.inc (line 78).

property Up: TVector3 read GetUp write SetUp;

View up vector, for shadow maps. See https://castle-engine.io/x3d_extensions_shadow_maps.php

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_x3dpunctuallightnode.inc (line 80).

property FdDefaultShadowMap: TSFNode read FFdDefaultShadowMap;

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

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_x3dpunctuallightnode.inc (line 84).

property DefaultShadowMap: TGeneratedShadowMapNode read GetDefaultShadowMap write SetDefaultShadowMap;

Shadow map used by this light source. See https://castle-engine.io/x3d_extensions_shadow_maps.php

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_x3dpunctuallightnode.inc (line 86).

Generated by PasDoc 0.17.0.snapshot.