Class MovieTextureObject

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Texturing.MovieTextureObject
All Implemented Interfaces:
X3DChildNode, X3DNode, X3DUrlObject, X3DAppearanceChildNode, X3DSoundSourceNode, MovieTexture, X3DTexture2DNode, X3DTextureNode, X3DTimeDependentNode

public class MovieTextureObject
extends X3DConcreteNode
implements MovieTexture
MovieTexture applies a 2D movie image to surface geometry, or provides audio for a Sound node.

X3D node tooltip: [X3DTexture2DNode,X3DSoundSourceNode,X3DUrlObject] MovieTexture applies a 2D movie image to surface geometry, or provides audio for a Sound node. First define as texture, then USE as Sound source to see it/hear it/save memory. Texture maps have a 2D coordinate system (s, t) horizontal and vertical, with (s, t) texture-coordinate values in range [0.0, 1.0] for opposite corners of the image.
  • Hint: can contain a single TextureProperties node.
  • Hint: insert Shape and Appearance nodes before adding texture.
  • Hint: provide a Viewpoint that allows a clear view of the MovieTexture so that users can easily see all details.
  • Hint: utilize DEF/USE references for multiple copies of a single MovieTexture video file in order to avoid multiple-download delays, reduce memory requirements, and maintain synchronization.
  • Hint: authors can provide multiple video formats for the same video track, with each source address listed separately in the url field.
  • Hint: player support for MPEG-1 video format is required, other formats are optional.
  • Warning: MovieTexture has containerField='texture' when parent is an Appearance node, otherwise containerField='source' when parent is a Sound node.
  • Hint: X3D Scene Authoring Hints, Images http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images
  • Hint: Texture mapping https://en.wikipedia.org/wiki/Texture_mapping
  • Hint: X3D Architecture 17.2.2 Lighting model http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/lighting.html#Lightingmodel
  • Hint: apply containerField='watchList' when parent node is LoadSensor.

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:
X3D Abstract Specification: MovieTexture, X3D Tooltips: MovieTexture, X3D Scene Authoring Hints: Images
  • Field Details

  • Constructor Details

    • MovieTextureObject

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

      public MovieTextureObject​(java.lang.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

    • getElementName

      public final java.lang.String getElementName()
      Provides name of this element: MovieTexture
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the MovieTexture element: Texturing
      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: 3
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element
    • getFieldType

      public java.lang.String getFieldType​(java.lang.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:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
    • getAccessType

      public java.lang.String getAccessType​(java.lang.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:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
    • getContainerFieldDefault

      public final java.lang.String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
    • initialize

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

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

      Tooltip: Author-provided text tooltip that tells users the expected action of this node.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Specified by:
      getDescription in interface MovieTexture
      Specified by:
      getDescription in interface X3DSoundSourceNode
      Returns:
      value of description field
    • setDescription

      public MovieTextureObject setDescription​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.

      Tooltip: Author-provided text tooltip that tells users the expected action of this node.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Specified by:
      setDescription in interface MovieTexture
      Specified by:
      setDescription in interface X3DSoundSourceNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDescription

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

      public double getDuration()
      Provide double value in seconds within allowed range of [-1,infinity) from outputOnly SFTime field named duration_changed.

      Tooltip: [0,+infinity) or -1. length of time in seconds for one cycle of media stream.
      • Warning: duration value of -1 implies that media data has not yet loaded or is unavailable for some reason.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      • Hint: duration_changed is an SFTime duration interval, normally nonnegative, and not an absolute clock time.
      • Hint: changing the pitch field does not trigger a duration_changed event. Playback interval may vary but duration of the original media data remains unmodified.
      Specified by:
      getDuration in interface MovieTexture
      Specified by:
      getDuration in interface X3DSoundSourceNode
      Returns:
      value of duration_changed field
    • getElapsedTime

      public double getElapsedTime()
      Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.

      Tooltip: [0,+infinity) Current elapsed time since MovieTexture activated/running, cumulative in seconds, and not counting any paused time.
      • Warning: not supported in VRML97.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      • Hint: elapsedTime is a nonnegative SFTime duration interval, not an absolute clock time.
      Specified by:
      getElapsedTime in interface MovieTexture
      Specified by:
      getElapsedTime in interface X3DSoundSourceNode
      Specified by:
      getElapsedTime in interface X3DTimeDependentNode
      Returns:
      value of elapsedTime field
    • getIS

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

      public MovieTextureObject setIS​(ISObject newValue)
      Accessor method to assign ISObject 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:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • clearIS

      public MovieTextureObject clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      MovieTextureObject - 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:
      getIS()
    • getIsActive

      public boolean getIsActive()
      Provide boolean value from outputOnly SFBool field named isActive.

      Tooltip: isActive true/false events are sent when playback starts/stops.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Specified by:
      getIsActive in interface MovieTexture
      Specified by:
      getIsActive in interface X3DSoundSourceNode
      Specified by:
      getIsActive in interface X3DTimeDependentNode
      Returns:
      value of isActive field
    • getIsPaused

      public boolean getIsPaused()
      Provide boolean value from outputOnly SFBool field named isPaused.

      Tooltip: isPaused true/false events are sent when MovieTexture is paused/resumed.
      • Warning: not supported in VRML97.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Specified by:
      getIsPaused in interface MovieTexture
      Specified by:
      getIsPaused in interface X3DSoundSourceNode
      Specified by:
      getIsPaused in interface X3DTimeDependentNode
      Returns:
      value of isPaused field
    • getLoop

      public boolean getLoop()
      Provide boolean value from inputOutput SFBool field named loop.

      Tooltip: Repeat indefinitely when loop=true, repeat only once when loop=false. *
      Specified by:
      getLoop in interface MovieTexture
      Specified by:
      getLoop in interface X3DSoundSourceNode
      Specified by:
      getLoop in interface X3DTimeDependentNode
      Returns:
      value of loop field
    • setLoop

      public MovieTextureObject setLoop​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named loop.

      Tooltip: Repeat indefinitely when loop=true, repeat only once when loop=false. *
      Specified by:
      setLoop in interface MovieTexture
      Specified by:
      setLoop in interface X3DSoundSourceNode
      Specified by:
      setLoop in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the loop field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setLoop

      public MovieTextureObject setLoop​(SFBoolObject newValue)
      Assign typed object value to SFBool loop field, similar to setLoop(boolean).
      Parameters:
      newValue - is new value for the loop field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface MovieTexture
      Specified by:
      getMetadata in interface X3DAppearanceChildNode
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DSoundSourceNode
      Specified by:
      getMetadata in interface X3DTexture2DNode
      Specified by:
      getMetadata in interface X3DTextureNode
      Specified by:
      getMetadata in interface X3DTimeDependentNode
      Returns:
      value of metadata field
      See Also:
      getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public MovieTextureObject setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface MovieTexture
      Specified by:
      setMetadata in interface X3DAppearanceChildNode
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DSoundSourceNode
      Specified by:
      setMetadata in interface X3DTexture2DNode
      Specified by:
      setMetadata in interface X3DTextureNode
      Specified by:
      setMetadata in interface X3DTimeDependentNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

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

      public MovieTextureObject setMetadata​(ProtoInstanceObject 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:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(X3DMetadataObject)
    • 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:
      getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • getPauseTime

      public double getPauseTime()
      Provide double value in seconds from inputOutput SFTime field named pauseTime.

      Tooltip: When time now >= pauseTime, isPaused becomes true and MovieTexture becomes paused. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      • Warning: not supported in VRML97.
      Specified by:
      getPauseTime in interface MovieTexture
      Specified by:
      getPauseTime in interface X3DSoundSourceNode
      Specified by:
      getPauseTime in interface X3DTimeDependentNode
      Returns:
      value of pauseTime field
    • setPauseTime

      public MovieTextureObject setPauseTime​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.

      Tooltip: When time now >= pauseTime, isPaused becomes true and MovieTexture becomes paused. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      • Warning: not supported in VRML97.
      Specified by:
      setPauseTime in interface MovieTexture
      Specified by:
      setPauseTime in interface X3DSoundSourceNode
      Specified by:
      setPauseTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the pauseTime field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPauseTime

      public MovieTextureObject setPauseTime​(SFTimeObject newValue)
      Assign typed object value to SFTime pauseTime field, similar to setPauseTime(double).
      Parameters:
      newValue - is new value for the pauseTime field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getPitch

      public float getPitch()
      Provide float value within allowed range of (0,infinity) from inputOutput SFFloat field named pitch.
      Specified by:
      getPitch in interface MovieTexture
      Specified by:
      getPitch in interface X3DSoundSourceNode
      Returns:
      value of pitch field
    • setPitch

      public MovieTextureObject setPitch​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named pitch.
      Specified by:
      setPitch in interface MovieTexture
      Specified by:
      setPitch in interface X3DSoundSourceNode
      Parameters:
      newValue - is new value for the pitch field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPitch

      public MovieTextureObject setPitch​(SFFloatObject newValue)
      Assign typed object value to SFFloat pitch field, similar to setPitch(float).
      Parameters:
      newValue - is new value for the pitch field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPitch

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

      public boolean getRepeatS()
      Provide boolean value from initializeOnly SFBool field named repeatS.

      Tooltip: Whether to horizontally repeat texture along S axis. *
      Specified by:
      getRepeatS in interface MovieTexture
      Specified by:
      getRepeatS in interface X3DTexture2DNode
      Returns:
      value of repeatS field
    • setRepeatS

      public MovieTextureObject setRepeatS​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named repeatS.

      Tooltip: Whether to horizontally repeat texture along S axis. *
      Specified by:
      setRepeatS in interface MovieTexture
      Specified by:
      setRepeatS in interface X3DTexture2DNode
      Parameters:
      newValue - is new value for the repeatS field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRepeatS

      public MovieTextureObject setRepeatS​(SFBoolObject newValue)
      Assign typed object value to SFBool repeatS field, similar to setRepeatS(boolean).
      Parameters:
      newValue - is new value for the repeatS field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getRepeatT

      public boolean getRepeatT()
      Provide boolean value from initializeOnly SFBool field named repeatT.

      Tooltip: Whether to vertically repeat texture along T axis. *
      Specified by:
      getRepeatT in interface MovieTexture
      Specified by:
      getRepeatT in interface X3DTexture2DNode
      Returns:
      value of repeatT field
    • setRepeatT

      public MovieTextureObject setRepeatT​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named repeatT.

      Tooltip: Whether to vertically repeat texture along T axis. *
      Specified by:
      setRepeatT in interface MovieTexture
      Specified by:
      setRepeatT in interface X3DTexture2DNode
      Parameters:
      newValue - is new value for the repeatT field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRepeatT

      public MovieTextureObject setRepeatT​(SFBoolObject newValue)
      Assign typed object value to SFBool repeatT field, similar to setRepeatT(boolean).
      Parameters:
      newValue - is new value for the repeatT field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getResumeTime

      public double getResumeTime()
      Provide double value in seconds from inputOutput SFTime field named resumeTime.

      Tooltip: When resumeTime becomes <= time now, isPaused becomes false and MovieTexture becomes active. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      • Warning: not supported in VRML97.
      Specified by:
      getResumeTime in interface MovieTexture
      Specified by:
      getResumeTime in interface X3DSoundSourceNode
      Specified by:
      getResumeTime in interface X3DTimeDependentNode
      Returns:
      value of resumeTime field
    • setResumeTime

      public MovieTextureObject setResumeTime​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.

      Tooltip: When resumeTime becomes <= time now, isPaused becomes false and MovieTexture becomes active. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      • Warning: not supported in VRML97.
      Specified by:
      setResumeTime in interface MovieTexture
      Specified by:
      setResumeTime in interface X3DSoundSourceNode
      Specified by:
      setResumeTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the resumeTime field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setResumeTime

      public MovieTextureObject setResumeTime​(SFTimeObject newValue)
      Assign typed object value to SFTime resumeTime field, similar to setResumeTime(double).
      Parameters:
      newValue - is new value for the resumeTime field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getSpeed

      public float getSpeed()
      Provide float value from inputOutput SFFloat field named speed.

      Tooltip: Factor for how fast the movie (or soundtrack) is played.
      • Hint: a MovieTexture node shall display frame 0 if speed = 0.
      • Hint: a negative speed value sets the movie to play in reverse.
      Specified by:
      getSpeed in interface MovieTexture
      Returns:
      value of speed field
    • setSpeed

      public MovieTextureObject setSpeed​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named speed.

      Tooltip: Factor for how fast the movie (or soundtrack) is played.
      • Hint: a MovieTexture node shall display frame 0 if speed = 0.
      • Hint: a negative speed value sets the movie to play in reverse.
      Specified by:
      setSpeed in interface MovieTexture
      Parameters:
      newValue - is new value for the speed field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSpeed

      public MovieTextureObject setSpeed​(SFFloatObject newValue)
      Assign typed object value to SFFloat speed field, similar to setSpeed(float).
      Parameters:
      newValue - is new value for the speed field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSpeed

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

      public double getStartTime()
      Provide double value in seconds from inputOutput SFTime field named startTime.

      Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      getStartTime in interface MovieTexture
      Specified by:
      getStartTime in interface X3DSoundSourceNode
      Specified by:
      getStartTime in interface X3DTimeDependentNode
      Returns:
      value of startTime field
    • setStartTime

      public MovieTextureObject setStartTime​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.

      Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      setStartTime in interface MovieTexture
      Specified by:
      setStartTime in interface X3DSoundSourceNode
      Specified by:
      setStartTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the startTime field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setStartTime

      public MovieTextureObject setStartTime​(SFTimeObject newValue)
      Assign typed object value to SFTime startTime field, similar to setStartTime(double).
      Parameters:
      newValue - is new value for the startTime field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getStopTime

      public double getStopTime()
      Provide double value in seconds from inputOutput SFTime field named stopTime.

      Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      • Warning: An active TimeSensor node ignores set_cycleInterval and set_startTime events.
      • Warning: An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.
      Specified by:
      getStopTime in interface MovieTexture
      Specified by:
      getStopTime in interface X3DSoundSourceNode
      Specified by:
      getStopTime in interface X3DTimeDependentNode
      Returns:
      value of stopTime field
    • setStopTime

      public MovieTextureObject setStopTime​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.

      Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      • Warning: An active TimeSensor node ignores set_cycleInterval and set_startTime events.
      • Warning: An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.
      Specified by:
      setStopTime in interface MovieTexture
      Specified by:
      setStopTime in interface X3DSoundSourceNode
      Specified by:
      setStopTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the stopTime field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setStopTime

      public MovieTextureObject setStopTime​(SFTimeObject newValue)
      Assign typed object value to SFTime stopTime field, similar to setStopTime(double).
      Parameters:
      newValue - is new value for the stopTime field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getTextureProperties

      public TextureProperties getTextureProperties()
      Provide TexturePropertiesObject instance (using a properly typed node) from initializeOnly SFNode field textureProperties.
      Specified by:
      getTextureProperties in interface MovieTexture
      Specified by:
      getTextureProperties in interface X3DTexture2DNode
      Returns:
      value of textureProperties field
      See Also:
      getTexturePropertiesProtoInstance()
    • setTextureProperties

      public MovieTextureObject setTextureProperties​(TextureProperties newValue)
      Accessor method to assign TexturePropertiesObject instance (using a properly typed node) to initializeOnly SFNode field textureProperties.
      Specified by:
      setTextureProperties in interface MovieTexture
      Specified by:
      setTextureProperties in interface X3DTexture2DNode
      Parameters:
      newValue - is new value for the textureProperties field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setTextureProperties(ProtoInstanceObject)
    • clearTextureProperties

      public MovieTextureObject clearTextureProperties()
      Utility method to clear SFNode value of textureProperties field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setTextureProperties

      public MovieTextureObject setTextureProperties​(ProtoInstanceObject newValue)
      Assign ProtoInstance (using a properly typed node) to initializeOnly SFNode field textureProperties.
      Parameters:
      newValue - is new value for the textureProperties field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setTextureProperties(TextureProperties)
    • hasTextureProperties

      public boolean hasTextureProperties()
      Indicate whether an object is available for initializeOnly SFNode field textureProperties.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getTextureProperties(), getTexturePropertiesProtoInstance()
    • getUrl

      public java.lang.String[] getUrl()
      Provide array of String results from inputOutput MFString field named url.

      Tooltip: Location and filename of movie file or stream. Multiple locations are more reliable, and including a Web address lets e-mail attachments work.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
      • Hint: X3D Scene Authoring Hints, urls http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
      Specified by:
      getUrl in interface MovieTexture
      Specified by:
      getUrl in interface X3DUrlObject
      Returns:
      value of url field
    • getUrlList

      public java.util.ArrayList<java.lang.String> getUrlList()
      Utility method to get ArrayList value of MFString url field, similar to getUrl().
      Returns:
      value of url field
    • setUrl

      public MovieTextureObject setUrl​(java.lang.String[] newValue)
      Accessor method to assign String array to inputOutput MFString field named url.

      Tooltip: Location and filename of movie file or stream. Multiple locations are more reliable, and including a Web address lets e-mail attachments work.
      • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc."
      • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
      • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
      • Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
      • Hint: X3D Scene Authoring Hints, urls http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
      Specified by:
      setUrl in interface MovieTexture
      Specified by:
      setUrl in interface X3DUrlObject
      Parameters:
      newValue - is new value for the url field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUrl

      public MovieTextureObject setUrl​(MFStringObject newValue)
      Assign typed object value to MFString url field, similar to setUrl(String[]).
      Parameters:
      newValue - is new value for the url field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUrl

      public MovieTextureObject setUrl​(SFStringObject newValue)
      Assign single SFString object value to MFString url field, similar to setUrl(String[]).
      Parameters:
      newValue - is new value for the url field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUrl

      public MovieTextureObject setUrl​(java.lang.String newValue)
      Assign singleton String value to MFString url field, similar to setUrl(String[]).
      Parameters:
      newValue - is new value for the url field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUrl

      public MovieTextureObject setUrl​(java.util.ArrayList<java.lang.String> newValue)
      Assign ArrayList value of MFString url field, similar to setUrl(String[]).
      Parameters:
      newValue - is new value for the url field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearUrl

      public MovieTextureObject clearUrl()
      Utility method to clear MFString value of url field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addUrl

      public MovieTextureObject addUrl​(java.lang.String newValue)
      Add singleton String value to MFString url field.
      Parameters:
      newValue - is new value to add to the url field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • addUrl

      public MovieTextureObject addUrl​(SFStringObject newValue)
      Add singleton SFStringObject value to MFString url field.
      Parameters:
      newValue - is new value to add to the url field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • getDEF

      public java.lang.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:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

      public final MovieTextureObject setDEF​(java.lang.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:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

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

      public java.lang.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:
      X3D Scene Authoring Hints: Naming Conventions
    • setUSE

      public final MovieTextureObject setUSE​(java.lang.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:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

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

      public java.lang.String getCssClass()
      Provide String value from 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
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public final MovieTextureObject setCssClass​(java.lang.String newValue)
      Accessor method to 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 class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

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

      public MovieTextureObject setUSE​(MovieTextureObject 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:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

      public MovieTextureObject addComments​(java.lang.String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public MovieTextureObject addComments​(java.lang.String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public MovieTextureObject addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      MovieTextureObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • toStringX3D

      public java.lang.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:
      X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
    • toStringClassicVRML

      public java.lang.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:
      X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
    • toStringVRML97

      public java.lang.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:
      X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue, java.lang.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • hasElementByNameValue

      public boolean hasElementByNameValue​(java.lang.String nameValue, java.lang.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:
      findElementByNameValue(String, String)
    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF​(java.lang.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • hasNodeByDEF

      public boolean hasNodeByDEF​(java.lang.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:
      findNodeByDEF(String)
    • validate

      public java.lang.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.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)