BooleanSequencer (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DNode, X3DSequencerNode

All Known Implementing Classes:

BooleanSequencerObject
```
public interface BooleanSequencer
extends X3DSequencerNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: [X3DSequencerNode] BooleanSequencer generates periodic discrete Boolean values. Authors can ROUTE value_changed output events to other Boolean attributes.
- Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction
- Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute.
- Hint: example scenes and authoring assets at
  http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting
- Hint: X3D Event-Utility Node Diagrams
  http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting/X3dEventUtilityNodeEventDiagrams.pdf
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

SAI Java Specification: TODO, X3D Abstract Specification: BooleanSequencer, X3D Tooltips: BooleanSequencer, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`float[]`	`getKey()` Provide array of float results from inputOutput MFFloat field named key.
`boolean[]`	`getKeyValue()` Provide array of boolean results from inputOutput MFBool field named keyValue.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`boolean`	`getValue()` Provide boolean value from outputOnly SFBool field named value_changed.
`BooleanSequencer`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`BooleanSequencer`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`BooleanSequencer`	`setKey(float[] newValue)` Assign float array to inputOutput MFFloat field named key.
`BooleanSequencer`	`setKeyValue(boolean[] newValue)` Assign boolean array to inputOutput MFBool field named keyValue.
`BooleanSequencer`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`BooleanSequencer`	`setNext(boolean newValue)` Assign boolean value to inputOnly SFBool field named next.
`BooleanSequencer`	`setPrevious(boolean newValue)` Assign boolean value to inputOnly SFBool field named previous.
`BooleanSequencer`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getKey
```
float[] getKey()
```
    Provide array of float results from inputOutput MFFloat field named key.
    
    Tooltip: Definition values for linear-interpolation function input intervals, listed in non-decreasing order and corresponding to a value in the keyValue array.
    - Warning: number of keys must match number of keyValues!
    - Warning: values in key array shall be monotonically non-decreasing, meaning that each value is greater than or equal to the preceding value.
    - Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals can be defined with arbitrary bounds.
    Specified by:
    
    getKey in interface X3DSequencerNode
    
    Returns:
    
    value of key field
  - setKey
```
BooleanSequencer setKey(float[] newValue)
```
    Assign float array to inputOutput MFFloat field named key.
    
    Tooltip: Definition values for linear-interpolation function input intervals, listed in non-decreasing order and corresponding to a value in the keyValue array. Warning: number of keys must match number of keyValues! Warning: values in key array shall be monotonically non-decreasing, meaning that each value is greater than or equal to the preceding value. Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals can be defined with arbitrary bounds.
    
    Specified by:
    
    setKey in interface X3DSequencerNode
    
    Parameters:
    
    newValue - is new value for the key field.
    
    Returns:
    
    BooleanSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getKeyValue
```
boolean[] getKeyValue()
```
    Provide array of boolean results from inputOutput MFBool field named keyValue.
    
    Tooltip: Output values for linear sequencing, each corresponding to an input-fraction value in the key array.
    - Warning: number of keys must match number of keyValues!.
    Returns:
    
    value of keyValue field
  - setKeyValue
```
BooleanSequencer setKeyValue(boolean[] newValue)
```
    Assign boolean array to inputOutput MFBool field named keyValue.
    
    Tooltip: Output values for linear sequencing, each corresponding to an input-fraction value in the key array. Warning: number of keys must match number of keyValues!.
    
    Parameters:
    
    newValue - is new value for the keyValue field.
    
    Returns:
    
    BooleanSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Specified by:
    
    getMetadata in interface X3DSequencerNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
BooleanSequencer setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface X3DSequencerNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    BooleanSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setNext
```
BooleanSequencer setNext(boolean newValue)
```
    Assign boolean value to inputOnly SFBool field named next.
    
    Tooltip: Send next output value in keyValue array, and reset internal fraction field to match corresponding value in key array. Hint: this input event will "wrap around" boundary of keyValue array, i.e. continue from last to first if necessary. Warning: it is an error to define this transient inputOnly field in an X3D file.
    
    Specified by:
    
    setNext in interface X3DSequencerNode
    
    Parameters:
    
    newValue - is new value for the next field.
    
    Returns:
    
    BooleanSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setPrevious
```
BooleanSequencer setPrevious(boolean newValue)
```
    Assign boolean value to inputOnly SFBool field named previous.
    
    Tooltip: Send previous output value in keyValue array, and reset internal fraction field to match corresponding value in key array. Hint: this input event will "wrap around" boundary of keyValue array, i.e. continue from first to last if necessary. Warning: it is an error to define this transient inputOnly field in an X3D file.
    
    Specified by:
    
    setPrevious in interface X3DSequencerNode
    
    Parameters:
    
    newValue - is new value for the previous field.
    
    Returns:
    
    BooleanSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getValue
```
boolean getValue()
```
    Provide boolean value from outputOnly SFBool field named value_changed.
    
    Tooltip: Single intermittent output value determined by current key time and corresponding keyValue entry.
    - Warning: it is an error to define this transient outputOnly field in an X3D file.
    Returns:
    
    value of value_changed field
  - setDEF
```
BooleanSequencer setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DSequencerNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    BooleanSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
BooleanSequencer setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface X3DSequencerNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    BooleanSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
BooleanSequencer setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DSequencerNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    BooleanSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface BooleanSequencer

Method Summary

Method Detail

getKey

setKey

getKeyValue

setKeyValue

getMetadata

setMetadata

setNext

setPrevious

getValue

setDEF

setUSE

setCssClass