Class TimeSensorObject

    • Field Detail

      • NAME

        public static final java.lang.String NAME
        String constant NAME provides name of this element: TimeSensor.
        See Also:
        Constant Field Values
      • COMPONENT

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the TimeSensor element: Time
        See Also:
        Constant Field Values
      • LEVEL

        public static final int LEVEL
        Integer constant LEVEL provides default X3D Time component level for this element: 1
        See Also:
        Constant Field Values
      • CYCLEINTERVAL_DEFAULT_VALUE

        public static final double CYCLEINTERVAL_DEFAULT_VALUE
        SFTime field named cycleInterval has default value 1.0 (Java syntax) or 1.0 (XML syntax).
        See Also:
        Constant Field Values
      • ENABLED_DEFAULT_VALUE

        public static final boolean ENABLED_DEFAULT_VALUE
        SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
        See Also:
        Constant Field Values
      • IS_DEFAULT_VALUE

        public static final ISObject IS_DEFAULT_VALUE
        SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
      • LOOP_DEFAULT_VALUE

        public static final boolean LOOP_DEFAULT_VALUE
        SFBool field named loop has default value false (Java syntax) or false (XML syntax).
        See Also:
        Constant Field Values
      • METADATA_DEFAULT_VALUE

        public static final X3DMetadataObject METADATA_DEFAULT_VALUE
        SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
      • PAUSETIME_DEFAULT_VALUE

        public static final double PAUSETIME_DEFAULT_VALUE
        SFTime field named pauseTime has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • RESUMETIME_DEFAULT_VALUE

        public static final double RESUMETIME_DEFAULT_VALUE
        SFTime field named resumeTime has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • STARTTIME_DEFAULT_VALUE

        public static final double STARTTIME_DEFAULT_VALUE
        SFTime field named startTime has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • STOPTIME_DEFAULT_VALUE

        public static final double STOPTIME_DEFAULT_VALUE
        SFTime field named stopTime has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • fromField_CYCLEINTERVAL

        public static final java.lang.String fromField_CYCLEINTERVAL
        fromField ROUTE name for SFTime field named cycleInterval.
        See Also:
        Constant Field Values
      • toField_CYCLEINTERVAL

        public static final java.lang.String toField_CYCLEINTERVAL
        toField ROUTE name for SFTime field named cycleInterval.
        See Also:
        Constant Field Values
      • fromField_CYCLETIME

        public static final java.lang.String fromField_CYCLETIME
        fromField ROUTE name for SFTime field named cycleTime.
        See Also:
        Constant Field Values
      • fromField_ELAPSEDTIME

        public static final java.lang.String fromField_ELAPSEDTIME
        fromField ROUTE name for SFTime field named elapsedTime.
        See Also:
        Constant Field Values
      • fromField_ENABLED

        public static final java.lang.String fromField_ENABLED
        fromField ROUTE name for SFBool field named enabled.
        See Also:
        Constant Field Values
      • toField_ENABLED

        public static final java.lang.String toField_ENABLED
        toField ROUTE name for SFBool field named enabled.
        See Also:
        Constant Field Values
      • fromField_FRACTION_CHANGED

        public static final java.lang.String fromField_FRACTION_CHANGED
        fromField ROUTE name for SFFloat field named fraction_changed.
        See Also:
        Constant Field Values
      • fromField_IS

        public static final java.lang.String fromField_IS
        fromField ROUTE name for SFNode field named IS.
        See Also:
        Constant Field Values
      • fromField_ISACTIVE

        public static final java.lang.String fromField_ISACTIVE
        fromField ROUTE name for SFBool field named isActive.
        See Also:
        Constant Field Values
      • fromField_ISPAUSED

        public static final java.lang.String fromField_ISPAUSED
        fromField ROUTE name for SFBool field named isPaused.
        See Also:
        Constant Field Values
      • fromField_LOOP

        public static final java.lang.String fromField_LOOP
        fromField ROUTE name for SFBool field named loop.
        See Also:
        Constant Field Values
      • toField_LOOP

        public static final java.lang.String toField_LOOP
        toField ROUTE name for SFBool field named loop.
        See Also:
        Constant Field Values
      • fromField_METADATA

        public static final java.lang.String fromField_METADATA
        fromField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • toField_METADATA

        public static final java.lang.String toField_METADATA
        toField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • fromField_PAUSETIME

        public static final java.lang.String fromField_PAUSETIME
        fromField ROUTE name for SFTime field named pauseTime.
        See Also:
        Constant Field Values
      • toField_PAUSETIME

        public static final java.lang.String toField_PAUSETIME
        toField ROUTE name for SFTime field named pauseTime.
        See Also:
        Constant Field Values
      • fromField_RESUMETIME

        public static final java.lang.String fromField_RESUMETIME
        fromField ROUTE name for SFTime field named resumeTime.
        See Also:
        Constant Field Values
      • toField_RESUMETIME

        public static final java.lang.String toField_RESUMETIME
        toField ROUTE name for SFTime field named resumeTime.
        See Also:
        Constant Field Values
      • fromField_STARTTIME

        public static final java.lang.String fromField_STARTTIME
        fromField ROUTE name for SFTime field named startTime.
        See Also:
        Constant Field Values
      • toField_STARTTIME

        public static final java.lang.String toField_STARTTIME
        toField ROUTE name for SFTime field named startTime.
        See Also:
        Constant Field Values
      • fromField_STOPTIME

        public static final java.lang.String fromField_STOPTIME
        fromField ROUTE name for SFTime field named stopTime.
        See Also:
        Constant Field Values
      • toField_STOPTIME

        public static final java.lang.String toField_STOPTIME
        toField ROUTE name for SFTime field named stopTime.
        See Also:
        Constant Field Values
      • fromField_TIME

        public static final java.lang.String fromField_TIME
        fromField ROUTE name for SFTime field named time.
        See Also:
        Constant Field Values
    • Constructor Detail

      • TimeSensorObject

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

        public TimeSensorObject​(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 Detail

      • getElementName

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

        public final java.lang.String getComponent()
        Defines X3D component for the TimeSensor element: Time
        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: 1
        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
      • initialize

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

        public double getCycleInterval()
        Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named cycleInterval.

        Tooltip: [0,+infinity) cycleInterval is loop duration in seconds. Interchange profile hint: TimeSensor may be ignored if cycleInterval < 0.01 second.
        • Warning: An active TimeSensor node ignores set_cycleInterval and set_startTime events.
        • Hint: cycleInterval is a nonnegative SFTime duration interval, not an absolute clock time.
        Specified by:
        getCycleInterval in interface TimeSensor
        Returns:
        value of cycleInterval field
      • setCycleInterval

        public TimeSensorObject setCycleInterval​(double newValue)
        Accessor method to assign double value in seconds to inputOutput SFTime field named cycleInterval.

        Tooltip: [0,+infinity) cycleInterval is loop duration in seconds. Interchange profile hint: TimeSensor may be ignored if cycleInterval < 0.01 second.
        • Warning: An active TimeSensor node ignores set_cycleInterval and set_startTime events.
        • Hint: cycleInterval is a nonnegative SFTime duration interval, not an absolute clock time.
        Specified by:
        setCycleInterval in interface TimeSensor
        Parameters:
        newValue - is new value for the cycleInterval field.
        Returns:
        TimeSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setCycleInterval

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

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

        Tooltip: cycleTime sends a time outputOnly at startTime, and also at the beginning of each new cycle (useful for synchronization with other time-based objects).
        • Hint: the first cycleTime event for a TimeSensor node can be used as an alarm (single pulse at a specified time).
        • Hint: cycleTime is a nonnegative SFTime duration interval, not an absolute clock time.
        • 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:
        getCycleTime in interface TimeSensor
        Returns:
        value of cycleTime 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 TimeSensor 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 TimeSensor
        Specified by:
        getElapsedTime in interface X3DTimeDependentNode
        Returns:
        value of elapsedTime field
      • getEnabled

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

        Tooltip: Enables/disables node operation. *
        Specified by:
        getEnabled in interface TimeSensor
        Specified by:
        getEnabled in interface X3DSensorNode
        Returns:
        value of enabled field
      • setEnabled

        public TimeSensorObject 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 TimeSensor
        Specified by:
        setEnabled in interface X3DSensorNode
        Parameters:
        newValue - is new value for the enabled field.
        Returns:
        TimeSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setEnabled

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

        public float getFraction()
        Provide float value from outputOnly SFFloat field named fraction_changed.

        Tooltip: fraction_changed continuously sends value in range [0,1] showing time progress in the current cycle.
        • 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:
        getFraction in interface TimeSensor
        Returns:
        value of fraction_changed field
      • clearIS

        public TimeSensorObject clearIS()
        Utility method to clear SFNode value of IS field.
        Returns:
        TimeSensorObject - 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 TimeSensor starts/stops running.
        • 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 TimeSensor
        Specified by:
        getIsActive in interface X3DSensorNode
        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 TimeSensor 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 TimeSensor
        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 TimeSensor
        Specified by:
        getLoop in interface X3DTimeDependentNode
        Returns:
        value of loop field
      • setLoop

        public TimeSensorObject 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 TimeSensor
        Specified by:
        setLoop in interface X3DTimeDependentNode
        Parameters:
        newValue - is new value for the loop field.
        Returns:
        TimeSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setLoop

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

        public TimeSensorObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        TimeSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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 TimeSensor 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 TimeSensor
        Specified by:
        getPauseTime in interface X3DTimeDependentNode
        Returns:
        value of pauseTime field
      • setPauseTime

        public TimeSensorObject 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 TimeSensor 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 TimeSensor
        Specified by:
        setPauseTime in interface X3DTimeDependentNode
        Parameters:
        newValue - is new value for the pauseTime field.
        Returns:
        TimeSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setPauseTime

        public TimeSensorObject 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:
        TimeSensorObject - 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 TimeSensor becomes inactive. 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 TimeSensor
        Specified by:
        getResumeTime in interface X3DTimeDependentNode
        Returns:
        value of resumeTime field
      • setResumeTime

        public TimeSensorObject 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 TimeSensor becomes inactive. 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 TimeSensor
        Specified by:
        setResumeTime in interface X3DTimeDependentNode
        Parameters:
        newValue - is new value for the resumeTime field.
        Returns:
        TimeSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setResumeTime

        public TimeSensorObject 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:
        TimeSensorObject - 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: When time now >= startTime, isActive becomes true and TimeSensor 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.
        Specified by:
        getStartTime in interface TimeSensor
        Specified by:
        getStartTime in interface X3DTimeDependentNode
        Returns:
        value of startTime field
      • setStartTime

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

        Tooltip: When time now >= startTime, isActive becomes true and TimeSensor 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.
        Specified by:
        setStartTime in interface TimeSensor
        Specified by:
        setStartTime in interface X3DTimeDependentNode
        Parameters:
        newValue - is new value for the startTime field.
        Returns:
        TimeSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setStartTime

        public TimeSensorObject 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:
        TimeSensorObject - 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: When stopTime becomes <= time now, isActive becomes false and TimeSensor becomes inactive. 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 TimeSensor
        Specified by:
        getStopTime in interface X3DTimeDependentNode
        Returns:
        value of stopTime field
      • setStopTime

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

        Tooltip: When stopTime becomes <= time now, isActive becomes false and TimeSensor becomes inactive. 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 TimeSensor
        Specified by:
        setStopTime in interface X3DTimeDependentNode
        Parameters:
        newValue - is new value for the stopTime field.
        Returns:
        TimeSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setStopTime

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

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

        Tooltip: [0,+infinity) Time continuously sends the absolute time (value 0.0 matches 1 January 1970) in seconds for a given simulation tick.
        • 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:
        getTime in interface TimeSensor
        Returns:
        value of time field
      • setDEF

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

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

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

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

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

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

        public TimeSensorObject addComments​(CommentsBlock newCommentsBlock)
        Add CommentsBlock to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newCommentsBlock - block of comments to add
        Returns:
        TimeSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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)
      • 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)