Class TCastleTransformDesign

Unit

Declaration

type TCastleTransformDesign = class(TCastleTransform)

Description

Contents are loaded from an indicated castle-transform file (by the URL property).

The file should be in the format created by Castle Game Engine Editor (serialized by CastleComponentSerialize routines) with .castle-transform extension.

Hierarchy

Overview

Methods

Public constructor Create(AOwner: TComponent); override;
Public destructor Destroy; override;
Public function PropertySections(const PropertyName: String): TPropertySections; override;
Public function DesignedComponent(const ComponentName: String; const Required: Boolean = true): TComponent;
Public function FindRequiredComponent(const ComponentName: String): TComponent; deprecated 'use DesignedComponent(ComponentName)';
Public function FindComponent(const ComponentName: String): TComponent; deprecated 'use DesignedComponent(ComponentName, false)';

Properties

Published property URL: String read FURL write SetURL;
Published property RevertURL: String read FRevertURL write FRevertURL;

Description

Methods

Public constructor Create(AOwner: TComponent); override;

This item has no description.

Public destructor Destroy; override;

This item has no description.

Public function PropertySections(const PropertyName: String): TPropertySections; override;

This item has no description. Showing description inherited from TCastleComponent.PropertySections.

Section where to show property in the editor.

Public function DesignedComponent(const ComponentName: String; const Required: Boolean = true): TComponent;

Find by name a component in currently loaded design. When the name is not found, raises exception (unless Required is False, then it returns Nil).

Public function FindRequiredComponent(const ComponentName: String): TComponent; deprecated 'use DesignedComponent(ComponentName)';

Warning: this symbol is deprecated: use DesignedComponent(ComponentName)

This item has no description.

Public function FindComponent(const ComponentName: String): TComponent; deprecated 'use DesignedComponent(ComponentName, false)';

Warning: this symbol is deprecated: use DesignedComponent(ComponentName, false)

This item has no description.

Properties

Published property URL: String read FURL write SetURL;

Load file with the transform design. The file should be in the format created by Castle Game Engine Editor (see CastleComponentSerialize unit) with .castle-transform extension. Setting this property automatically unloads the previous design, and loads a new one (if the value is <> '').

After loading a design, you can use DesignedComponent to find the components inside. So e.g. this works:

var
  MyDesign: TCastleTransformDesign;
  MyScene: TCastleScene;
begin
  MyDesign := TCastleTransformDesign.Create(...);
  MyDesign.URL := 'castle-data:/my_transform.castle-transform';
  MyScene := MyDesign.DesignedComponent('MyScene') as TCastleScene;
  MyScene.Translation := Vector3(1, 2, 3);
end;

Published property RevertURL: String read FRevertURL write FRevertURL;

URL used to perform editor "Revert" operation.


Generated by PasDoc 0.16.0-snapshot.