Class ChannelSelector

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Sound.ChannelSelector
All Implemented Interfaces:
X3DChildNode, X3DNode, ChannelSelector, X3DSoundChannelNode, X3DSoundNode
public class ChannelSelector extends X3DConcreteNode implements ChannelSelector
ChannelSelector selects a single channel output from all input channels.

ChannelSelector node tooltip: [X3DSoundChannelNode] ChannelSelector selects a single channel output from all input channels.
  • Hint: ChannelSelector is a utility node to complement ChannelSplitter.

Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:

  • Field Details

  • Constructor Details

    • ChannelSelector

      public ChannelSelector()
      Constructor for ChannelSelector to initialize member variables with default values.

    • ChannelSelector

      public ChannelSelector(String DEFlabel)
      Utility constructor that assigns DEF label after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node

  • Method Details

    • getChannelCountModeAlias

      public static String getChannelCountModeAlias(String channelCountModeValue)
      Get alias for this channelCountMode
      Parameters:
      channelCountModeValue - of interest
      Returns:
      alias value, otherwise empty string if not found

    • hasChannelCountModeAlias

      public static boolean hasChannelCountModeAlias(String channelCountMode)
      Whether a alias exists for this channelCountMode
      Parameters:
      channelCountMode - of interest
      Returns:
      true if found

    • getElementName

      public final String getElementName()
      Provides name of this element: ChannelSelector
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element

    • getComponent

      public final String getComponent()
      Defines X3D component for the ChannelSelector element: Sound
      Specified by:
      getComponent in class X3DConcreteElement
      Returns:
      X3D component for this element

    • getComponentLevel

      public final int getComponentLevel()
      Provides default X3D component level for this element: 2
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element

    • getChannelCountModeDefault

      public static final String getChannelCountModeDefault()
      Public accessor for encapsulated SFString default value "MAX", returned as String.
      Returns:
      default value

    • getChannelInterpretationDefault

      public static final String getChannelInterpretationDefault()
      Public accessor for encapsulated SFString default value "SPEAKERS", returned as String.
      Returns:
      default value

    • getChannelSelectionDefault

      public static final int getChannelSelectionDefault()
      Public accessor for encapsulated SFInt32 default value 0, returned as int.
      Returns:
      default value

    • getDescriptionDefault

      public static final String getDescriptionDefault()
      Public accessor for encapsulated SFString default value, returned as String.
      Returns:
      default value

    • getEnabledDefault

      public static final boolean getEnabledDefault()
      Public accessor for encapsulated SFBool default value true, returned as boolean.
      Returns:
      default value

    • getGainDefault

      public static final float getGainDefault()
      Public accessor for encapsulated SFFloat default value 1f, returned as float.
      Returns:
      default value

    • getISDefault

      public static final IS getISDefault()
      Public accessor for encapsulated SFNode default value null, returned as IS.
      Returns:
      default value

    • getMetadataDefault

      public static final X3DMetadataObject getMetadataDefault()
      Public accessor for encapsulated SFNode default value null, returned as org.web3d.x3d.sai.Core.X3DMetadataObject.
      Returns:
      default value

    • getFieldType

      public String getFieldType(String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:

    • getAccessType

      public String getAccessType(String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:

    • getContainerFieldDefault

      public final String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:

    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode

    • getChannelCount

      public int getChannelCount()
      Provide int value from outputOnly SFInt32 field named channelCount.

      Tooltip: [0,+infinity) channelCount reports number of channels provided by input nodes.
      Specified by:
      getChannelCount in interface ChannelSelector
      Specified by:
      getChannelCount in interface X3DSoundChannelNode
      Returns:
      value of channelCount field

    • getChannelCountMode

      public String getChannelCountMode()
      Provide String enumeration value (baseType SFString) ["MAX" | "CLAMPED_MAX" | "EXPLICIT"] from inputOutput SFString field named channelCountMode.

      Tooltip: channelCountMode determines how individual channels are counted when up-mixing and down-mixing connections to any inputs.

      Available enumeration values for string comparison: MAX, CLAMPED_MAX, EXPLICIT.
      Specified by:
      getChannelCountMode in interface ChannelSelector
      Specified by:
      getChannelCountMode in interface X3DSoundChannelNode
      Returns:
      value of channelCountMode field

    • setChannelCountMode

      public ChannelSelector setChannelCountMode(String newValue)
      Accessor method to assign String enumeration value ("MAX" | "CLAMPED_MAX" | "EXPLICIT") to inputOutput SFString field named channelCountMode.

      Warning: authors can only choose from a strict list of enumeration values (MAX, CLAMPED_MAX, EXPLICIT).

      Tooltip: channelCountMode determines how individual channels are counted when up-mixing and down-mixing connections to any inputs.
      Specified by:
      setChannelCountMode in interface ChannelSelector
      Specified by:
      setChannelCountMode in interface X3DSoundChannelNode
      Parameters:
      newValue - is new value for the channelCountMode field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setChannelCountMode

      public ChannelSelector setChannelCountMode(SFString newValue)
      Assign typed object value to SFString channelCountMode field, similar to setChannelCountMode(String).
      Parameters:
      newValue - is new value for the channelCountMode field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getChannelInterpretation

      public String getChannelInterpretation()
      Provide String enumeration value (baseType SFString) ["SPEAKERS" | "DISCRETE"] from inputOutput SFString field named channelInterpretation.

      Tooltip: channelInterpretation determines how individual channels are treated when up-mixing and down-mixing connections to any inputs.

      Available enumeration values for string comparison: SPEAKERS, DISCRETE.
      Specified by:
      getChannelInterpretation in interface ChannelSelector
      Specified by:
      getChannelInterpretation in interface X3DSoundChannelNode
      Returns:
      value of channelInterpretation field

    • setChannelInterpretation

      public ChannelSelector setChannelInterpretation(String newValue)
      Accessor method to assign String enumeration value ("SPEAKERS" | "DISCRETE") to inputOutput SFString field named channelInterpretation.

      Warning: authors can only choose from a strict list of enumeration values (SPEAKERS, DISCRETE).

      Tooltip: channelInterpretation determines how individual channels are treated when up-mixing and down-mixing connections to any inputs.
      Specified by:
      setChannelInterpretation in interface ChannelSelector
      Specified by:
      setChannelInterpretation in interface X3DSoundChannelNode
      Parameters:
      newValue - is new value for the channelInterpretation field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setChannelInterpretation

      public ChannelSelector setChannelInterpretation(SFString newValue)
      Assign typed object value to SFString channelInterpretation field, similar to setChannelInterpretation(String).
      Parameters:
      newValue - is new value for the channelInterpretation field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getChannelSelection

      public int getChannelSelection()
      Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named channelSelection.

      Tooltip: [0,+infinity) channelSelection is single channel of interest from those provided by input nodes. *
      Specified by:
      getChannelSelection in interface ChannelSelector
      Returns:
      value of channelSelection field

    • setChannelSelection

      public ChannelSelector setChannelSelection(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named channelSelection.

      Tooltip: [0,+infinity) channelSelection is single channel of interest from those provided by input nodes. *
      Specified by:
      setChannelSelection in interface ChannelSelector
      Parameters:
      newValue - is new value for the channelSelection field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setChannelSelection

      public ChannelSelector setChannelSelection(SFInt32 newValue)
      Assign typed object value to SFInt32 channelSelection field, similar to setChannelSelection(int).
      Parameters:
      newValue - is new value for the channelSelection field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getChildren

      public X3DNode[] getChildren()
      Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper, from inputOutput MFNode field children.

      Tooltip: [X3DSoundChannelNode|X3DSoundProcessingNode|X3DSoundSourceNode] The children field specifies audio-graph sound sources providing input signals for this node. If multiple input signals are provided by the inputs children field, all channels are mixed together and merged prior to presentation.
      • Warning: contained AudioClip or MovieTexture nodes must have containerField='children' to override otherwise-incorrect defaults.
      • Hint: can be original (DEF) or referenced (USE) nodes.


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.
      Specified by:
      getChildren in interface ChannelSelector
      Returns:
      value of children field
      See Also:

    • getChildrenList

      public ArrayList<X3DNode> getChildrenList()
      Utility method to get ArrayList value of MFNode children field, similar to getChildren().
      Returns:
      value of children field

    • setChildren

      public ChannelSelector setChildren(X3DNode[] newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.

      Tooltip: [X3DSoundChannelNode|X3DSoundProcessingNode|X3DSoundSourceNode] The children field specifies audio-graph sound sources providing input signals for this node. If multiple input signals are provided by the inputs children field, all channels are mixed together and merged prior to presentation.
      • Warning: contained AudioClip or MovieTexture nodes must have containerField='children' to override otherwise-incorrect defaults.
      • Hint: can be original (DEF) or referenced (USE) nodes.


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.
      Specified by:
      setChildren in interface ChannelSelector
      Parameters:
      newValue - is new value for the children field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setChildren

      public ChannelSelector setChildren(ArrayList<X3DNode> newValue)
      Assign ArrayList value of MFNode children field, similar to setChildren(org.web3d.x3d.sai.Core.X3DNode[]).
      Parameters:
      newValue - is new value for the children field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addChildren

      public void addChildren(X3DNode newValue)
      Add single node to existing array of children nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper and ProtoInstance.
      Parameters:
      newValue - is new value to be appended the children field.

    • addChildren

      public ChannelSelector addChildren(ProtoInstance newValue)
      Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for children field.

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.
      Parameters:
      newValue - is new value to be appended the parts field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addChild

      public ChannelSelector addChild(X3DChildNode newValue)
      Utility method to add single child element to contained list of existing children nodes (if any).
      Parameters:
      newValue - is new node value to be appended the children field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addChildren

      public void addChildren(X3DNode[] newValue)
      Add array of children nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.
      Specified by:
      addChildren in interface ChannelSelector
      Parameters:
      newValue - is new value array to be appended the children field.

    • setChildren

      public void setChildren(X3DNode newValue)
      Set single children node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.
      Specified by:
      setChildren in interface ChannelSelector
      Parameters:
      newValue - is new node for the children field (restricted to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper)

    • clearChildren

      public ChannelSelector clearChildren()
      Utility method to clear MFNode value of children field. This method does not initialize with CHILDREN_DEFAULT_VALUE.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • hasChildren

      public boolean hasChildren()
      Indicate whether an object is available for inputOutput MFNode field children.
      Returns:
      whether a properly typed node or ProtoInstance array or CommentsBlock is available.
      See Also:

    • addComments

      public ChannelSelector addComments(String newComment)
      Add comment as CommentsBlock to children field
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addComments

      public ChannelSelector addComments(String[] newComments)
      Add comments as String[] array to children field
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addComments

      public ChannelSelector addComments(CommentsBlock newCommentsBlock)
      Add CommentsBlock to children field
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDescription

      public String getDescription()
      Provide String value from inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of the url asset.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &#38; for & ampersand character, or &#34; for " quotation-mark character).
      Specified by:
      getDescription in interface ChannelSelector
      Specified by:
      getDescription in interface X3DSoundChannelNode
      Specified by:
      getDescription in interface X3DSoundNode
      Returns:
      value of description field

    • setDescription

      public ChannelSelector setDescription(String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of the url asset.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &#38; for & ampersand character, or &#34; for " quotation-mark character).
      Specified by:
      setDescription in interface ChannelSelector
      Specified by:
      setDescription in interface X3DSoundChannelNode
      Specified by:
      setDescription in interface X3DSoundNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setDescription

      public ChannelSelector setDescription(SFString newValue)
      Assign typed object value to SFString description field, similar to setDescription(String).
      Parameters:
      newValue - is new value for the description field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getEnabled

      public boolean getEnabled()
      Provide boolean value from inputOutput SFBool field named enabled.

      Tooltip: Enables/disables node operation. *
      Specified by:
      getEnabled in interface ChannelSelector
      Specified by:
      getEnabled in interface X3DSoundChannelNode
      Specified by:
      getEnabled in interface X3DSoundNode
      Returns:
      value of enabled field

    • setEnabled

      public ChannelSelector setEnabled(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named enabled.

      Tooltip: Enables/disables node operation. *
      Specified by:
      setEnabled in interface ChannelSelector
      Specified by:
      setEnabled in interface X3DSoundChannelNode
      Specified by:
      setEnabled in interface X3DSoundNode
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setEnabled

      public ChannelSelector setEnabled(SFBool newValue)
      Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getGain

      public float getGain()
      Provide float value from inputOutput SFFloat field named gain.

      Tooltip: (-infinity,+infinity) The gain field is a factor that represents the amount of linear amplification to apply to the output of the node.
      • Warning: Decibel values shall not be used for this multiplicative factor.
      • Hint: Negative gain factors negate the input signal.
      Specified by:
      getGain in interface ChannelSelector
      Specified by:
      getGain in interface X3DSoundChannelNode
      Returns:
      value of gain field

    • setGain

      public ChannelSelector setGain(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named gain.

      Tooltip: (-infinity,+infinity) The gain field is a factor that represents the amount of linear amplification to apply to the output of the node.
      • Warning: Decibel values shall not be used for this multiplicative factor.
      • Hint: Negative gain factors negate the input signal.
      Specified by:
      setGain in interface ChannelSelector
      Specified by:
      setGain in interface X3DSoundChannelNode
      Parameters:
      newValue - is new value for the gain field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setGain

      public ChannelSelector setGain(SFFloat newValue)
      Assign typed object value to SFFloat gain field, similar to setGain(float).
      Parameters:
      newValue - is new value for the gain field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setGain

      public ChannelSelector setGain(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setGain(float).
      Parameters:
      newValue - is new value for field
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getIS

      public IS getIS()
      Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:

    • setIS

      public ChannelSelector setIS(IS newValue)
      Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • clearIS

      public ChannelSelector clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • hasIS

      public boolean hasIS()
      Indicate whether an object is available for inputOutput SFNode field IS.
      Returns:
      whether a concrete statement or CommentsBlock is available.
      See Also:

    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface ChannelSelector
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DSoundChannelNode
      Specified by:
      getMetadata in interface X3DSoundNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      public ChannelSelector setMetadata(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface ChannelSelector
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DSoundChannelNode
      Specified by:
      setMetadata in interface X3DSoundNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • clearMetadata

      public ChannelSelector clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setMetadata

      public ChannelSelector setMetadata(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • hasMetadata

      public boolean hasMetadata()
      Indicate whether an object is available for inputOutput SFNode field metadata.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:

    • getDEF

      public String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:

    • setDEF

      public final ChannelSelector setDEF(String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setDEF

      public ChannelSelector setDEF(SFString newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getUSE

      public String getUSE()
      Provide String value from 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.
      Overrides:
      getUSE in class X3DConcreteNode
      Returns:
      value of USE field
      See Also:

    • setUSE

      public final ChannelSelector setUSE(String newValue)
      Accessor method to 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 class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

      public ChannelSelector setUSE(SFString newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String).
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getCssClass

      public String getCssClass()
      Provide String value from inputOutput SFString field named class.
      Overrides:
      getCssClass in class X3DConcreteElement
      Returns:
      value of class field
      See Also:

    • setCssClass

      public final ChannelSelector setCssClass(String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setCssClass

      public ChannelSelector setCssClass(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getHtmlId

      public String getHtmlId()
      Provide String value from inputOutput SFString field named id.
      Overrides:
      getHtmlId in class X3DConcreteElement
      Returns:
      value of id field
      See Also:

    • setHtmlId

      public final ChannelSelector setHtmlId(String newValue)
      Accessor method to assign String value to inputOutput SFString field named id.
      Specified by:
      setHtmlId in class X3DConcreteNode
      Parameters:
      newValue - is new value for the id field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setHtmlId

      public ChannelSelector setHtmlId(SFString newValue)
      Assign typed object value to SFString HtmlId field, similar to setHtmlId(String).
      Parameters:
      newValue - is new value for the id field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getCssStyle

      public String getCssStyle()
      Provide String value from inputOutput SFString field named style.
      Overrides:
      getCssStyle in class X3DConcreteElement
      Returns:
      value of style field
      See Also:

    • setCssStyle

      public final ChannelSelector setCssStyle(String newValue)
      Accessor method to assign String value to inputOutput SFString field named style.
      Specified by:
      setCssStyle in class X3DConcreteNode
      Parameters:
      newValue - is new value for the style field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setCssStyle

      public ChannelSelector setCssStyle(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
      Parameters:
      newValue - is new value for the style field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

      public ChannelSelector setUSE(ChannelSelector DEFnode)
      Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

      Warning: note that 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.
      Parameters:
      DEFnode - must have a DEF value defined
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • toStringX3D

      public String toStringX3D(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:

    • toStringClassicVRML

      public String toStringClassicVRML(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:

    • toStringVRML97

      public String toStringVRML97(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(String nameValue)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(String nameValue, String elementName)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:

    • hasElementByNameValue

      public boolean hasElementByNameValue(String nameValue, String elementName)
      Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      whether node is found
      See Also:

    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF(String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:

    • hasNodeByDEF

      public boolean hasNodeByDEF(String DEFvalue)
      Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      whether node is found
      See Also:

    • validate

      public String validate()
      Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values. TODO document specific validation methods.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)