API Reference

Class TAbstract3DBackgroundNode

Description
Hierarchy
Fields
Methods
Properties

Unit

X3DNodes

Declaration

type TAbstract3DBackgroundNode = class(TAbstractBackgroundNode)

Description

Abstract type from which 3D backgrounds inherit.

Hierarchy

Overview

Methods

Public function TransformationChange: TNodeTransformationChange; override;
Public function Texture(const Side: TBackgroundSide): TAbstractTextureNode; virtual; abstract;
Public procedure CreateNode; override;
Public class function ClassX3DType: String; override;
Public procedure SetGroundAngle(const Value: array of Single); overload;
Public procedure SetGroundAngle(const Value: TSingleList); overload;
Public procedure SetGroundColor(const Value: array of TCastleColorRGB); overload;
Public procedure SetGroundColor(const Value: TVector3List); overload;
Public procedure SetSkyAngle(const Value: array of Single); overload;
Public procedure SetSkyAngle(const Value: TSingleList); overload;
Public procedure SetSkyColor(const Value: array of TCastleColorRGB); overload;
Public procedure SetSkyColor(const Value: TVector3List); overload;

Properties

Public property FdGroundAngle: TMFFloat read FFdGroundAngle;
Public property FdGroundColor: TMFColor read FFdGroundColor;
Public property FdSkyAngle: TMFFloat read FFdSkyAngle;
Public property FdSkyColor: TMFColor read FFdSkyColor;
Public property FdTransparency: TSFFloat read FFdTransparency;
Public property Transparency: Single read GetTransparency write SetTransparency;

Description

Methods

Public function TransformationChange: TNodeTransformationChange; override;

This item has no description.

Public function Texture(const Side: TBackgroundSide): TAbstractTextureNode; virtual; abstract;

Texture node for given background side. May return Nil if none.

It is the caller's responsibility to take care of freeing the result, but only if it's not otherwise used. In other words, use TX3DNode.FreeIfUnused (or some routine based on it), unless you're sure that you always make the returned node a child of another node (in this case the returned node is always used, and remains managed by parent node).

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.

Public procedure SetGroundAngle(const Value: array of Single); overload;

This item has no description.

Public procedure SetGroundAngle(const Value: TSingleList); overload;

This item has no description.

Public procedure SetGroundColor(const Value: array of TCastleColorRGB); overload;

This item has no description.

Public procedure SetGroundColor(const Value: TVector3List); overload;

This item has no description.

Public procedure SetSkyAngle(const Value: array of Single); overload;

This item has no description.

Public procedure SetSkyAngle(const Value: TSingleList); overload;

This item has no description.

Public procedure SetSkyColor(const Value: array of TCastleColorRGB); overload;

This item has no description.

Public procedure SetSkyColor(const Value: TVector3List); overload;

This item has no description.

Properties

Public property FdGroundAngle: TMFFloat read FFdGroundAngle;

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

Public property FdGroundColor: TMFColor read FFdGroundColor;

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

Public property FdSkyAngle: TMFFloat read FFdSkyAngle;

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

Public property FdSkyColor: TMFColor read FFdSkyColor;

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

Public property FdTransparency: TSFFloat read FFdTransparency;

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

Public property Transparency: Single read GetTransparency write SetTransparency;

This item has no description.

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.