Class TTimeDependentFunctionality

Propagate this to all send events, to make animation fade-in/out.

Final duration (in seconds) of this animation. For a looping animation, this is the time it takes to make a single cycle.

This is > 0 in normal circumstances, but can also be 0 or negative in special cases – see below.

The final length, returned here, is:

• In case of TAudioClipNode: sound file duration divided by TAbstractSoundSourceNode.Pitch. 0 if sound file is not loaded.

• In case of TMovieTextureNode: movie duration divided by TMovieTextureNode.Speed. Negative if movie duration is unknown, like when movie is not loaded. 0 if movie is loaded, but has speed = 0.

• In case of TTimeSensorNode: just TTimeSensorNode.CycleInterval.

• In case of X3D 4.x new audio time-dependent nodes, like TAnalyserNode: It is always 0, unknown, these nodes don't support looping.

Call this when world time increases. This is the most important method of this class, that basically implements time-dependent nodes operations.

NewTime and TimeIncrease are produced by TCastleSceneCore.SetTime and friends.

When ResetTime = true, this means that "TimeIncrease value is unknown" (you must pass TimeIncrease = 0 in this case). This can happen only when were called by ResetTime.

In other circumstances, TimeIncrease must be >= 0. (It's allowed to pass TimeIncrease = 0 and ResetTime = false, this doesn't advance the clock, but is a useful trick to force some update, see HandleChangeTimeStopStart in TCastleSceneCore.InternalChangedField implementation.)

References: see X3D specification "Time" component, 8.2 ("concepts") for logic behind all those start/stop/pause/resumeTime, cycleInterval, loop properties.

Returns

If some state of time-dependent node changed.

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

For a precise specification of how this behaves, see the X3D TimeSensor.isActive specification at http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/time.html#TimeSensor

Changing this automatically causes appropriate events to be generated.

Is the sensor paused.

For a precise specification of how this behaves, see the X3D TimeSensor.isPaused specification at http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/time.html#TimeSensor

Changing this automatically causes appropriate events to be generated.

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

For non-looping animations, note that the sensor automatically stops when the animation finishes, so ElapsedTime will not grow beyond the CycleInterval. If you want to observe when the animation ended, you probably do not want to use this property. Instead observe when IsActive changed to False, by registering a callback on EventIsActive.AddNotification. See the CGE examples/viewport_and_scenes/listen_on_x3d_events/ . Or, even better (simpler and more reliable) register a stop notification using TPlayAnimationParameters.StopNotification with TCastleSceneCore.PlayAnimation.

For a precise specification of how this behaves, see the X3D TimeSensor.elapsedTime specification at http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/time.html#TimeSensor

Changing this automatically causes appropriate events to be generated.

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

What happens when we play the animation backwards? ( Which can be achieved by TTimeSensorNode.FractionIncreasing = False, which in turn can be achieved by TPlayAnimationParameters.Forward = False passed to TCastleSceneCore.PlayAnimation. ) In such case, this value (ElapsedTimeInCycle) is still increasing as time passes. Under the hood, when playing animation backward, we just send at the end to TTimeSensorNode.EventFraction_changed the value "1.0 - fraction" where "fraction" is the point in the animation as if it played forward.

This is like ElapsedTime, but counting only the current cycle.

• When CycleInterval <= 0 (cycle not defined, e.g. because movie or audio clip not loaded), this is always 0.

• When CycleInterval > 0 (normal situation), then this is always >= 0 and < CycleInterval.