API Reference

Class TBackgroundNode

Description
Hierarchy
Fields
Methods
Properties

Unit

X3DNodes

Declaration

type TBackgroundNode = class(TAbstract3DBackgroundNode)

Description

3D background of a scene, comprised of sky and ground colors (gradients) and optional six textures (skybox).

Hierarchy

Overview

Methods

Public function Texture(const Side: TBackgroundSide): TAbstractTextureNode; override;
Public procedure CreateNode; override;
Public class function ClassX3DType: String; override;
Public procedure SetBackUrl(const Value: array of string); overload;
Public procedure SetBackUrl(const Value: TCastleStringList); overload;
Public procedure SetBottomUrl(const Value: array of string); overload;
Public procedure SetBottomUrl(const Value: TCastleStringList); overload;
Public procedure SetFrontUrl(const Value: array of string); overload;
Public procedure SetFrontUrl(const Value: TCastleStringList); overload;
Public procedure SetLeftUrl(const Value: array of string); overload;
Public procedure SetLeftUrl(const Value: TCastleStringList); overload;
Public procedure SetRightUrl(const Value: array of string); overload;
Public procedure SetRightUrl(const Value: TCastleStringList); overload;
Public procedure SetTopUrl(const Value: array of string); overload;
Public procedure SetTopUrl(const Value: TCastleStringList); overload;

Properties

Public property FdBackUrl: TMFString read FFdBackUrl;
Public property FdBottomUrl: TMFString read FFdBottomUrl;
Public property FdFrontUrl: TMFString read FFdFrontUrl;
Public property FdLeftUrl: TMFString read FFdLeftUrl;
Public property FdRightUrl: TMFString read FFdRightUrl;
Public property FdTopUrl: TMFString read FFdTopUrl;

Description

Methods

Public function Texture(const Side: TBackgroundSide): TAbstractTextureNode; override;

This item has no description. Showing description inherited from TAbstract3DBackgroundNode.Texture.

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 SetBackUrl(const Value: array of string); overload;

This item has no description.

Public procedure SetBackUrl(const Value: TCastleStringList); overload;

This item has no description.

Public procedure SetBottomUrl(const Value: array of string); overload;

This item has no description.

Public procedure SetBottomUrl(const Value: TCastleStringList); overload;

This item has no description.

Public procedure SetFrontUrl(const Value: array of string); overload;

This item has no description.

Public procedure SetFrontUrl(const Value: TCastleStringList); overload;

This item has no description.

Public procedure SetLeftUrl(const Value: array of string); overload;

This item has no description.

Public procedure SetLeftUrl(const Value: TCastleStringList); overload;

This item has no description.

Public procedure SetRightUrl(const Value: array of string); overload;

This item has no description.

Public procedure SetRightUrl(const Value: TCastleStringList); overload;

This item has no description.

Public procedure SetTopUrl(const Value: array of string); overload;

This item has no description.

Public procedure SetTopUrl(const Value: TCastleStringList); overload;

This item has no description.

Properties

Public property FdBackUrl: TMFString read FFdBackUrl;

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

Public property FdBottomUrl: TMFString read FFdBottomUrl;

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

Public property FdFrontUrl: TMFString read FFdFrontUrl;

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

Public property FdLeftUrl: TMFString read FFdLeftUrl;

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

Public property FdRightUrl: TMFString read FFdRightUrl;

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

Public property FdTopUrl: TMFString read FFdTopUrl;

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

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.