API Reference

Class TMovieTextureNode

Description
Hierarchy
Fields
Methods
Properties

Unit

X3DNodes

Declaration

type TMovieTextureNode = class(TAbstractTexture2DNode)

Description

Movie file, that can be played and displayed as a texture.

Hierarchy

Overview

Methods

Public constructor Create(const AX3DName: String = ''; const ABaseUrl: String = ''); override;
Public function TextureDescription: string; override;
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 Duration: TFloatTime read FDuration;
Public property FdLoop: TSFBool read FFdLoop;
Public property Loop: Boolean read GetLoop write SetLoop;
Public property FdPauseTime: TSFTime read FFdPauseTime;
Public property PauseTime: TFloatTime read GetPauseTime write SetPauseTime;
Public property FdResumeTime: TSFTime read FFdResumeTime;
Public property ResumeTime: TFloatTime read GetResumeTime write SetResumeTime;
Public property FdSpeed: TSFFloat read FFdSpeed;
Public property Speed: Single read GetSpeed write SetSpeed;
Public property FdStartTime: TSFTime read FFdStartTime;
Public property StartTime: TFloatTime read GetStartTime write SetStartTime;
Public property FdStopTime: TSFTime read FFdStopTime;
Public property StopTime: TFloatTime read GetStopTime write SetStopTime;
Public property FdUrl: TMFString read FFdUrl;
Public property FdFlipVertically: TSFBool read FFdFlipVertically;
Public property FlipVertically: Boolean read GetFlipVertically write SetFlipVertically;
Public property EventDuration_changed: TSFTimeEvent read FEventDuration_changed;
Public property EventElapsedTime: TSFTimeEvent read FEventElapsedTime;
Public property EventIsActive: TSFBoolEvent read FEventIsActive;
Public property EventIsPaused: TSFBoolEvent read FEventIsPaused;

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 TextureDescription: string; override;

This item has no description. Showing description inherited from TAbstractTextureNode.TextureDescription.

Short description how texture is defined, is it inline or loaded from URL, is it video of simple image texture. "none" if it's not defined at all.

Calling this may not cause automatically loading the texture data (for exampe, from file in case of TAbstractTexture2DNode). So it cannot describe the actually loaded data.

In this class, simply returns X3DType. Override to say something more descriptive.

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 Duration: TFloatTime read FDuration;

Duration of this movie, in seconds. Duration is initialized from loaded video length (default is -1). So it's automatically initialized when you call IsTextureVideo, TextureVideo methods.

This is not multiplied by Speed. Use MyMovieTextureNode.TimeFunctionality.CycleInterval to get this duration multiplied by Abs(Speed).

This duration is not reset when video is freed (like when you set IsTextureLoaded to False, maybe implicitly by calling TCastleSceneCore.FreeResources with frTextureDataInNodes). This way this is available even you freed the texture video data to save memory.

Public property FdLoop: TSFBool read FFdLoop;

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

Public property Loop: Boolean read GetLoop write SetLoop;

This item has no description.

Public property FdPauseTime: TSFTime read FFdPauseTime;

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

Public property PauseTime: TFloatTime read GetPauseTime write SetPauseTime;

This item has no description.

Public property FdResumeTime: TSFTime read FFdResumeTime;

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

Public property ResumeTime: TFloatTime read GetResumeTime write SetResumeTime;

This item has no description.

Public property FdSpeed: TSFFloat read FFdSpeed;

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

Public property Speed: Single read GetSpeed write SetSpeed;

This item has no description.

Public property FdStartTime: TSFTime read FFdStartTime;

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

Public property StartTime: TFloatTime read GetStartTime write SetStartTime;

This item has no description.

Public property FdStopTime: TSFTime read FFdStopTime;

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

Public property StopTime: TFloatTime read GetStopTime write SetStopTime;

This item has no description.

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 FdFlipVertically: TSFBool read FFdFlipVertically;

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

Public property FlipVertically: Boolean read GetFlipVertically write SetFlipVertically;

This item has no description.

Public property EventDuration_changed: TSFTimeEvent read FEventDuration_changed;

This item has no description.

Public property EventElapsedTime: TSFTimeEvent read FEventElapsedTime;

This item has no description.

Public property EventIsActive: TSFBoolEvent read FEventIsActive;

This item has no description.

Public property EventIsPaused: TSFBoolEvent read FEventIsPaused;

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.