official documentation

  1. x3dom.org
  2. documentation
  3. Developer API

Class: IntegerSequencer

X3D: 3.3
Component: EventUtilities
Status:
experimental

Quick Links

➨ Fields
➨ Properties

.nodeTypes. IntegerSequencer

The IntegerSequencer node generates sequential discrete value_changed events selected from the keyValue field in response to each set_fraction, next, or previous event.

HTML Encoding and Default Values⤴

<IntegerSequencer key='[]' keyValue='[]' metadata='X3DMetadataObject' next='false' previous='false' set_fraction='0' ></IntegerSequencer>

Inheritance⤴


Constructor⤴

IntegerSequencer(ctx)⤴

Constructor for IntegerSequencer

Parameters:
Name Type Argument Default Description
ctx Object <optional>
 null context object, containing initial settings like namespace

Fields⤴

These are the X3D / X3DOM fields of this node. Values should usually be received / set as strings via DOM functions (i.e., using setAttribute("myFieldName", "myFieldValue") and getAttribute("myFieldName")).
Name Type Default Value Range Inheritance Standard Description
key MFFloat [] X3DSequencerNode The key field contains the list of key times, the keyValue field contains values for the target field, one complete set of values for each key. Sequencer nodes containing no keys in the key field shall not produce any events. However, an input event that replaces an empty key field with one that contains keys will cause the sequencer node to produce events the next time that a set_fraction event is received.
keyValue MFInt32 [] Defines the set of integers, that are used for sequencing.
metadata SFNode X3DMetadataObject X3DNode Field to add metadata information
next SFBool false X3DSequencerNode If the next inputOnly field receives an SFBool event with value TRUE, it triggers the next output value in keyValue array by issuing a value_changed event with that value. After reaching the boundary of keyValue array, next goes to the initial element after last.
previous SFBool false X3DSequencerNode If the previous inputOnly field receives an SFBool event with value TRUE, it triggers the previous output value in keyValue array by issuing a value_changed event with that value. After reaching the boundary of keyValue array previous goes to the last element after the first.
set_fraction SFFloat 0 X3DSequencerNode The set_fraction inputOnly field receives an SFFloat event and causes the sequencer node function to evaluate, resulting in a value_changed output event of the specified type with the same timestamp as the set_fraction event.