All Superinterfaces:: X3DChildNode, X3DNode, X3DSequencerNode

All Known Implementing Classes:: BooleanSequencer

public interface BooleanSequencer extends X3DSequencerNode

BooleanSequencer generates periodic discrete Boolean values.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. BooleanSequencer 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 https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting
Hint: X3D Event-Utility Node Diagrams https://www.web3d.org/x3d/content/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:

Method Summary

Modifier and Type

Method

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 org.web3d.x3d.sai.Core.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

setKey(float[] newValue)

Accessor method to assign float array to inputOutput MFFloat field named key.

BooleanSequencer

setKeyValue(boolean[] newValue)

Accessor method to assign boolean array to inputOutput MFBool field named keyValue.

BooleanSequencer

setMetadata(X3DMetadataObject newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

BooleanSequencer

setNext(boolean newValue)

Accessor method to assign boolean value to inputOnly SFBool field named next.

BooleanSequencer

setPrevious(boolean newValue)

Accessor method to assign boolean value to inputOnly SFBool field named previous.

Method Details
- 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)
  
  Accessor method to 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)
  
  Accessor method to 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 org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#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)
  
  Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#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)
  
  Accessor method to 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, instead only use it a destination for ROUTE events.
  
  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)
  
  Accessor method to 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, instead only use it a destination for ROUTE events.
  
  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, instead only use it a source for ROUTE events.
  
  Returns:
  
  value of value_changed field

Interface BooleanSequencer

Method Summary

Method Details

getKey

setKey

getKeyValue

setKeyValue

getMetadata

setMetadata

setNext

setPrevious

getValue