API Reference

Class TAbstractTimeDependentNode

Description
Hierarchy
Fields
Methods
Properties

Unit

X3DNodes

Declaration

type TAbstractTimeDependentNode = class(TAbstractChildNode)

Description

Abstract node from which most (but not all) time-dependent nodes are derived.

Hierarchy

Overview

Methods

Public constructor Create(const AX3DName: String = ''; const ABaseUrl: String = ''); override;
Public function IsActive: Boolean;
Public function IsPaused: Boolean;
Public function ElapsedTime: TFloatTime;
Public function ElapsedTimeInCycle: TFloatTime;
Public procedure CreateNode; override;
Public class function ClassX3DType: String; override;

Properties

Public property FdDescription: TSFString read FFdDescription;
Public property Description: String read GetDescription write SetDescription;
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 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 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 IsActive: Boolean;

Is the sensor enabled and running (ignoring whether it is paused).

See TTimeDependentFunctionality.IsActive.

Public function IsPaused: Boolean;

Is the sensor paused.

See TTimeDependentFunctionality.IsPaused.

Public function ElapsedTime: TFloatTime;

Time in seconds since the sensor was activated and running, not counting any time while in pause state.

See TTimeDependentFunctionality.ElapsedTime.

Public function ElapsedTimeInCycle: TFloatTime;

Time in seconds since the sensor was activated and running, in this cycle, not counting any time while in pause state.

See TTimeDependentFunctionality.ElapsedTimeInCycle.

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.

Properties

Public property FdDescription: TSFString read FFdDescription;

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

Public property Description: String read GetDescription write SetDescription;

This item has no description.

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