Package org.web3d.x3d.sai.EventUtilities

Interface BooleanFilter

All Superinterfaces:
X3DChildNode, X3DNode
All Known Implementing Classes:
BooleanFilter
public interface BooleanFilter extends X3DChildNode
BooleanFilter selectively passes true, false or negated events.

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. X3D node tooltip: [X3DChildNode] BooleanFilter selectively passes true, false or negated events. Hint: example scenes and authoring assets at <a href="https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting" target="_blank">https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting</a> Hint: X3D Event-Utility Node Diagrams <a href="https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting/X3dEventUtilityNodeEventDiagrams.pdf" target="_blank">https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting/X3dEventUtilityNodeEventDiagrams.pdf</a> *


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
    boolean
    getInputFalse()
    Provide boolean value from outputOnly SFBool field named inputFalse.
    boolean
    getInputNegate()
    Provide boolean value from outputOnly SFBool field named inputNegate.
    boolean
    getInputTrue()
    Provide boolean value from outputOnly SFBool field named inputTrue.
    X3DMetadataObject
    getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    BooleanFilter
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

  • Method Details

    • getInputFalse

      boolean getInputFalse()
      Provide boolean value from outputOnly SFBool field named inputFalse.

      Tooltip: inputFalse only passes a false value, which occurs when set_boolean is false. Hint: inputFalse is an output event that can only provide a value of false. *
      Returns:
      value of inputFalse field

    • getInputNegate

      boolean getInputNegate()
      Provide boolean value from outputOnly SFBool field named inputNegate.

      Tooltip: inputNegate is an output event that provides an opposite value by negating set_boolean input. *
      Returns:
      value of inputNegate field

    • getInputTrue

      boolean getInputTrue()
      Provide boolean value from outputOnly SFBool field named inputTrue.

      Tooltip: inputTrue only passes a true value, which occurs when set_boolean input is true. Hint: inputTrue is an output event that can only provide a value of true. *
      Returns:
      value of inputTrue field

    • 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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata</a> *
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      BooleanFilter 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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata</a> *
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      BooleanFilter - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also: