API Reference

Class TImageCubeMapTextureNode

Description
Hierarchy
Fields
Methods
Properties

Unit

X3DNodes

Declaration

type TImageCubeMapTextureNode = class(TAbstractEnvironmentTextureNode)

Description

Cube environment map texture loaded from a single file, like DDS.

Hierarchy

Overview

Methods

Public constructor Create(const AX3DName: String = ''; const ABaseUrl: String = ''); override;
Public function LoadImage: TCompositeImage;
Public procedure CreateNode; override;
Public class function ClassX3DType: String; override;
Public procedure SetUrl(const Value: array of string); overload;
Public procedure SetUrl(const Value: TCastleStringList); overload;

Properties

Public property FdUrl: TMFString read FFdUrl;
Public property FdTextureProperties: TSFNode read FFdTextureProperties;
Public property TextureProperties: TTexturePropertiesNode read GetTextureProperties write SetTextureProperties;

Description

Methods

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 LoadImage: TCompositeImage;

Load cube environment map from a composite (DDS, KTX...) image.

In case of problems, will make WritelnWarning. This includes situations when url cannot be loaded for whatever reason. Also problems when url contains valid Composite image, but not describing cube map with all 6 sides.

If all URLs failed, will return Nil.

Although the loaded image is not saved here, we do save the AlphaChannel type. Our AlphaChannel method will reflect last loaded image.

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

This item has no description.

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

This item has no description.

Properties

Public property FdUrl: TMFString read FFdUrl;

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

Public property FdTextureProperties: TSFNode read FFdTextureProperties;

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

Public property TextureProperties: TTexturePropertiesNode read GetTextureProperties write SetTextureProperties;

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.