API Reference

Class TAudioClipNode

Description
Hierarchy
Fields
Methods
Properties

Unit

X3DNodes

Declaration

type TAudioClipNode = class(TAbstractSoundSourceNode)

Description

Buffer for sound data, which can be played by the TSoundNode.

Hierarchy

Overview

Methods

Protected procedure ParseAfter(Reader: TX3DReaderNames); override;
Protected procedure BeforeTraverse(StateStack: TX3DGraphTraverseStateStack); override;
Public constructor Create(const AX3DName: string = ''; const ABaseUrl: String = ''); override;
Public destructor Destroy; 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 FdAutoRefresh: TSFTime read FFdAutoRefresh;
Public property AutoRefresh: TFloatTime read GetAutoRefresh write SetAutoRefresh;
Public property FdAutoRefreshTimeLimit: TSFTime read FFdAutoRefreshTimeLimit;
Public property AutoRefreshTimeLimit: TFloatTime read GetAutoRefreshTimeLimit write SetAutoRefreshTimeLimit;
Public property FdLoad: TSFBool read FFdLoad;
Public property Load: Boolean read GetLoad write SetLoad;
Public property FdUrl: TMFString read FFdUrl;

Description

Methods

Protected procedure ParseAfter(Reader: TX3DReaderNames); override;

This item has no description. Showing description inherited from TX3DNode.ParseAfter.

Called at the end of parsing this node (including children) in any encoding.

Protected procedure BeforeTraverse(StateStack: TX3DGraphTraverseStateStack); override;

This item has no description. Showing description inherited from TX3DNode.BeforeTraverse.

Override these methods to determine what happens when given node is traversed during Traverse call. The main use of this is to operate on TX3DGraphTraverseStateStack.

Remember to always call inherited when overriding. In BeforeTraverse and MiddleTraverse you should call inherited at the beginning, in AfterTraverse inherited should be called at the end.

Besides changing StateStack.Top fields, you can do push/pop on the stack. Remember that if you do StateStack.Push in BeforeTraverse, and then you must call StateStack.Pop in AfterTraverse.

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 destructor Destroy; override;

This item has no description.

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 FdAutoRefresh: TSFTime read FFdAutoRefresh;

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

Public property AutoRefresh: TFloatTime read GetAutoRefresh write SetAutoRefresh;

This item has no description.

Public property FdAutoRefreshTimeLimit: TSFTime read FFdAutoRefreshTimeLimit;

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

Public property AutoRefreshTimeLimit: TFloatTime read GetAutoRefreshTimeLimit write SetAutoRefreshTimeLimit;

This item has no description.

Public property FdLoad: TSFBool read FFdLoad;

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

Public property Load: Boolean read GetLoad write SetLoad;

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).

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.