Castle Game Engine

Class T3DResourceAnimation

Description
Hierarchy
Fields
Methods
Properties

Unit

CastleResources

Declaration

type T3DResourceAnimation = class(TObject)

Description

Animation defined by T3DResource.

Hierarchy

Overview

Methods

Public constructor Create(const AOwner: T3DResource; const AName: string; const ARequired: boolean = true);
Public function BoundingBox: TBox3D;
Public function Defined: boolean;

Properties

Public property Duration: Single read FDuration;
Public property URL: string read FURL write FURL; deprecated 'do not use separate URLs for each animation; use one URL with all animations; see https://castle-engine.io/creating_data_resources.php';
Public property AnimationName: string read FAnimationName write FAnimationName;
Public property TimeSensor: string read FAnimationName write FAnimationName; deprecated 'use AnimationName';
Public property Name: string read FName;
Public property Required: boolean read FRequired;

Description

Methods

Public constructor Create(const AOwner: T3DResource; const AName: string; const ARequired: boolean = true);
 
Public function BoundingBox: TBox3D;
 
Public function Defined: boolean;

Was the animation state defined in resource.xml file. May be False only if Required was False, or before we actually read animation info from resource.xml file.

Properties

Public property Duration: Single read FDuration;

Duration of the animation. See engine tutorial about how resources animations duration is calculated. Always 0 if not Defined.

Public property URL: string read FURL write FURL; deprecated 'do not use separate URLs for each animation; use one URL with all animations; see https://castle-engine.io/creating_data_resources.php';

Warning: this symbol is deprecated: do not use separate URLs for each animation; use one URL with all animations; see https://castle-engine.io/creating_data_resources.php

Scene URL, only when each animation is inside a separate 3D file. See [https://castle-engine.io/creating_data_resources.php] for documentation how you can define creature animations.

Public property AnimationName: string read FAnimationName write FAnimationName;

Animation name (like for TCastleSceneCore.PlayAnimation), which is equal to TimeSensor node name. All animations are started by X3D TimeSensor node. If not given, we assume it's just 'animation', which is fine at least for castle-anim-frames and MD3 files loaded using TNodeInterpolator. This refers to an X3D TimeSensor node inside animation model (from URL) or, when not defined, inside whole resource model (from T3DResource.ModelURL).

See [https://castle-engine.io/creating_data_resources.php] for documentation how you can define creature animations.

Public property TimeSensor: string read FAnimationName write FAnimationName; deprecated 'use AnimationName';

Warning: this symbol is deprecated: use AnimationName

 
Public property Name: string read FName;
 
Public property Required: boolean read FRequired;
 
Generated by PasDoc 0.16.0.