Class SpotLightObject

  • All Implemented Interfaces:
    X3DChildNode, X3DNode, SpotLight, X3DLightNode

    public class SpotLightObject
    extends X3DConcreteNode
    implements SpotLight
    Linear attenuation may occur at level 2, full support at level 3.

    X3D node tooltip: [X3DLightNode] SpotLight is a light source that illuminates geometry within a conical beam. Lighting illuminates all geometry except lines and points. By default, light scope only illuminates peer geometry and children nodes within the scene graph hierarchy. Lights have no visible shape themselves and lighting effects continue through any intermediate geometry.
    • Hint: the bound NavigationInfo controls whether headlight is enabled on/off.

    Note that SFColorObject provides a variety of color constants.

    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: SpotLight, X3D Tooltips: SpotLight, X3D Scene Authoring Hints
    • Field Detail

      • NAME

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

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

        public static final int LEVEL
        Integer constant LEVEL provides default X3D Lighting component level for this element: 2
        See Also:
        Constant Field Values
      • AMBIENTINTENSITY_DEFAULT_VALUE

        public static final float AMBIENTINTENSITY_DEFAULT_VALUE
        SFFloat field named ambientIntensity has default value 0f (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • ATTENUATION_DEFAULT_VALUE

        public static final float[] ATTENUATION_DEFAULT_VALUE
        SFVec3f field named attenuation has default value {1f,0f,0f} (Java syntax) or 1 0 0 (XML syntax).
      • BEAMWIDTH_DEFAULT_VALUE

        public static final float BEAMWIDTH_DEFAULT_VALUE
        SFFloat field named beamWidth has default value 0.7854f (Java syntax) or 0.7854 (XML syntax).
        See Also:
        Constant Field Values
      • COLOR_DEFAULT_VALUE

        public static final float[] COLOR_DEFAULT_VALUE
        SFColor field named color has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).
      • CUTOFFANGLE_DEFAULT_VALUE

        public static final float CUTOFFANGLE_DEFAULT_VALUE
        SFFloat field named cutOffAngle has default value 1.570796f (Java syntax) or 1.570796 (XML syntax).
        See Also:
        Constant Field Values
      • DIRECTION_DEFAULT_VALUE

        public static final float[] DIRECTION_DEFAULT_VALUE
        SFVec3f field named direction has default value {0f,0f,-1f} (Java syntax) or 0 0 -1 (XML syntax).
      • GLOBAL_DEFAULT_VALUE

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

        public static final float INTENSITY_DEFAULT_VALUE
        SFFloat field named intensity has default value 1f (Java syntax) or 1 (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).
      • LOCATION_DEFAULT_VALUE

        public static final float[] LOCATION_DEFAULT_VALUE
        SFVec3f field named location has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
      • METADATA_DEFAULT_VALUE

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

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

        public static final float RADIUS_DEFAULT_VALUE
        SFFloat field named radius has default value 100f (Java syntax) or 100 (XML syntax).
        See Also:
        Constant Field Values
      • fromField_AMBIENTINTENSITY

        public static final java.lang.String fromField_AMBIENTINTENSITY
        fromField ROUTE name for SFFloat field named ambientIntensity.
        See Also:
        Constant Field Values
      • toField_AMBIENTINTENSITY

        public static final java.lang.String toField_AMBIENTINTENSITY
        toField ROUTE name for SFFloat field named ambientIntensity.
        See Also:
        Constant Field Values
      • fromField_ATTENUATION

        public static final java.lang.String fromField_ATTENUATION
        fromField ROUTE name for SFVec3f field named attenuation.
        See Also:
        Constant Field Values
      • toField_ATTENUATION

        public static final java.lang.String toField_ATTENUATION
        toField ROUTE name for SFVec3f field named attenuation.
        See Also:
        Constant Field Values
      • fromField_BEAMWIDTH

        public static final java.lang.String fromField_BEAMWIDTH
        fromField ROUTE name for SFFloat field named beamWidth.
        See Also:
        Constant Field Values
      • toField_BEAMWIDTH

        public static final java.lang.String toField_BEAMWIDTH
        toField ROUTE name for SFFloat field named beamWidth.
        See Also:
        Constant Field Values
      • fromField_COLOR

        public static final java.lang.String fromField_COLOR
        fromField ROUTE name for SFColor field named color.
        See Also:
        Constant Field Values
      • toField_COLOR

        public static final java.lang.String toField_COLOR
        toField ROUTE name for SFColor field named color.
        See Also:
        Constant Field Values
      • fromField_CUTOFFANGLE

        public static final java.lang.String fromField_CUTOFFANGLE
        fromField ROUTE name for SFFloat field named cutOffAngle.
        See Also:
        Constant Field Values
      • toField_CUTOFFANGLE

        public static final java.lang.String toField_CUTOFFANGLE
        toField ROUTE name for SFFloat field named cutOffAngle.
        See Also:
        Constant Field Values
      • fromField_DIRECTION

        public static final java.lang.String fromField_DIRECTION
        fromField ROUTE name for SFVec3f field named direction.
        See Also:
        Constant Field Values
      • toField_DIRECTION

        public static final java.lang.String toField_DIRECTION
        toField ROUTE name for SFVec3f field named direction.
        See Also:
        Constant Field Values
      • fromField_GLOBAL

        public static final java.lang.String fromField_GLOBAL
        fromField ROUTE name for SFBool field named global.
        See Also:
        Constant Field Values
      • toField_GLOBAL

        public static final java.lang.String toField_GLOBAL
        toField ROUTE name for SFBool field named global.
        See Also:
        Constant Field Values
      • fromField_INTENSITY

        public static final java.lang.String fromField_INTENSITY
        fromField ROUTE name for SFFloat field named intensity.
        See Also:
        Constant Field Values
      • toField_INTENSITY

        public static final java.lang.String toField_INTENSITY
        toField ROUTE name for SFFloat field named intensity.
        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_LOCATION

        public static final java.lang.String fromField_LOCATION
        fromField ROUTE name for SFVec3f field named location.
        See Also:
        Constant Field Values
      • toField_LOCATION

        public static final java.lang.String toField_LOCATION
        toField ROUTE name for SFVec3f field named location.
        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_ON

        public static final java.lang.String fromField_ON
        fromField ROUTE name for SFBool field named on.
        See Also:
        Constant Field Values
      • toField_ON

        public static final java.lang.String toField_ON
        toField ROUTE name for SFBool field named on.
        See Also:
        Constant Field Values
    • Constructor Detail

      • SpotLightObject

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

        public SpotLightObject​(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: SpotLight
        Specified by:
        getElementName in class X3DConcreteElement
        Returns:
        name of this element
      • getComponent

        public final java.lang.String getComponent()
        Defines X3D component for the SpotLight element: Lighting
        Specified by:
        getComponent in class X3DConcreteElement
        Returns:
        X3D component for this element
      • getComponentLevel

        public final int getComponentLevel()
        Provides default X3D component level for this element: 2
        Specified by:
        getComponentLevel in class X3DConcreteElement
        Returns:
        default X3D component level for this element
      • 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
      • getAmbientIntensity

        public float getAmbientIntensity()
        Provide float value within allowed range of [0,1] from inputOutput SFFloat field named ambientIntensity.

        Tooltip: [0,1] Brightness of ambient (nondirectional background) emission from the light. *
        Specified by:
        getAmbientIntensity in interface SpotLight
        Specified by:
        getAmbientIntensity in interface X3DLightNode
        Returns:
        value of ambientIntensity field
      • setAmbientIntensity

        public SpotLightObject setAmbientIntensity​(float newValue)
        Accessor method to assign float value to inputOutput SFFloat field named ambientIntensity.

        Tooltip: [0,1] Brightness of ambient (nondirectional background) emission from the light. *
        Specified by:
        setAmbientIntensity in interface SpotLight
        Specified by:
        setAmbientIntensity in interface X3DLightNode
        Parameters:
        newValue - is new value for the ambientIntensity field.
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setAmbientIntensity

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

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

        public float[] getAttenuation()
        Provide array of 3-tuple float results within allowed range of [0,infinity) from inputOutput SFVec3f field named attenuation.

        Tooltip: Constant, linear-distance and squared-distance dropoff factors as radial distance increases from the source.
        • Hint: attenuation = 1/max(attenuation[0] + attenuation[1] ⨯ r + attenuation[2] ⨯ r2 , 1).
        Specified by:
        getAttenuation in interface SpotLight
        Returns:
        value of attenuation field
      • setAttenuation

        public SpotLightObject setAttenuation​(float[] newValue)
        Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named attenuation.

        Tooltip: Constant, linear-distance and squared-distance dropoff factors as radial distance increases from the source.
        • Hint: attenuation = 1/max(attenuation[0] + attenuation[1] ⨯ r + attenuation[2] ⨯ r2 , 1).
        Specified by:
        setAttenuation in interface SpotLight
        Parameters:
        newValue - is new value for the attenuation field.
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setAttenuation

        public SpotLightObject setAttenuation​(SFVec3fObject newValue)
        Assign typed object value to SFVec3f attenuation field, similar to setAttenuation(float[]).
        Parameters:
        newValue - is new value for the attenuation field.
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setAttenuation

        public SpotLightObject setAttenuation​(float x,
                                              float y,
                                              float z)
        Assign values to SFVec3f attenuation field, similar to setAttenuation(float[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setAttenuation

        public SpotLightObject setAttenuation​(double x,
                                              double y,
                                              double z)
        Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setAttenuation(float[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setAttenuation

        public SpotLightObject setAttenuation​(double[] newArray)
        Utility method: double-precision set-array accessor for X3D floating-point type, similar to setAttenuation(float[]).
        Parameters:
        newArray - is new value for field
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getBeamWidth

        public float getBeamWidth()
        Provide float value within allowed range of (0,1.570796] from inputOutput SFFloat field named beamWidth.

        Tooltip: [0,1.570796] Inner conical solid angle (in radians) where light source has uniform full intensity.
        • Hint: beamWidth is inner angle of full intensity, cutOffAngle is outer angle of zero intensity. Therefore set beamWidth <= cutOffAngle.
        • Warning: if beamWidth > cutOffAngle, then beamWidth reset to equal cutOffAngle.
        • Hint: https://en.wikipedia.org/wiki/Radian
        Specified by:
        getBeamWidth in interface SpotLight
        Returns:
        value of beamWidth field
      • setBeamWidth

        public SpotLightObject setBeamWidth​(float newValue)
        Accessor method to assign float value to inputOutput SFFloat field named beamWidth.

        Tooltip: [0,1.570796] Inner conical solid angle (in radians) where light source has uniform full intensity.
        • Hint: beamWidth is inner angle of full intensity, cutOffAngle is outer angle of zero intensity. Therefore set beamWidth <= cutOffAngle.
        • Warning: if beamWidth > cutOffAngle, then beamWidth reset to equal cutOffAngle.
        • Hint: https://en.wikipedia.org/wiki/Radian
        Specified by:
        setBeamWidth in interface SpotLight
        Parameters:
        newValue - is new value for the beamWidth field.
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setBeamWidth

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

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

        public SpotLightObject setColor​(SFColorObject newValue)
        Assign typed object value to SFColor color field, similar to setColor(float[]).
        Parameters:
        newValue - is new value for the color field.
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setColor

        public SpotLightObject setColor​(float red,
                                        float green,
                                        float blue)
        Assign values to SFColor color field, similar to setColor(float[]).
        Parameters:
        red - first component
        green - second component
        blue - third component
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setColor

        public SpotLightObject setColor​(double red,
                                        double green,
                                        double blue)
        Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setColor(float[]).
        Parameters:
        red - first component [0..1]
        green - second component [0..1]
        blue - third component [0..1]
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setColor

        public SpotLightObject setColor​(double[] newArray)
        Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setColor(float[]).
        Parameters:
        newArray - is new value for field
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getCutOffAngle

        public float getCutOffAngle()
        Provide float value unit axis, angle (in radians) within allowed range of (0,1.570796] from inputOutput SFFloat field named cutOffAngle.

        Tooltip: [0,1.570796] Outer conical solid angle (in radians) where light source intensity becomes zero.
        • Hint: beamWidth is inner angle of full intensity, cutOffAngle is outer angle of zero intensity. Therefore set beamWidth <= cutOffAngle.
        • Warning: if beamWidth > cutOffAngle, then beamWidth reset to equal cutOffAngle.
        • Hint: https://en.wikipedia.org/wiki/Radian
        Specified by:
        getCutOffAngle in interface SpotLight
        Returns:
        value of cutOffAngle field
      • setCutOffAngle

        public SpotLightObject setCutOffAngle​(float newValue)
        Accessor method to assign float value unit axis, angle (in radians) to inputOutput SFFloat field named cutOffAngle.

        Tooltip: [0,1.570796] Outer conical solid angle (in radians) where light source intensity becomes zero.
        • Hint: beamWidth is inner angle of full intensity, cutOffAngle is outer angle of zero intensity. Therefore set beamWidth <= cutOffAngle.
        • Warning: if beamWidth > cutOffAngle, then beamWidth reset to equal cutOffAngle.
        • Hint: https://en.wikipedia.org/wiki/Radian
        Specified by:
        setCutOffAngle in interface SpotLight
        Parameters:
        newValue - is new value for the cutOffAngle field.
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setCutOffAngle

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

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

        public float[] getDirection()
        Provide array of 3-tuple float results from inputOutput SFVec3f field named direction.

        Tooltip: Orientation vector of light relative to local coordinate system. *
        Specified by:
        getDirection in interface SpotLight
        Returns:
        value of direction field
      • setDirection

        public SpotLightObject setDirection​(float[] newValue)
        Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.

        Tooltip: Orientation vector of light relative to local coordinate system. *
        Specified by:
        setDirection in interface SpotLight
        Parameters:
        newValue - is new value for the direction field.
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDirection

        public SpotLightObject setDirection​(SFVec3fObject newValue)
        Assign typed object value to SFVec3f direction field, similar to setDirection(float[]).
        Parameters:
        newValue - is new value for the direction field.
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDirection

        public SpotLightObject setDirection​(float x,
                                            float y,
                                            float z)
        Assign values to SFVec3f direction field, similar to setDirection(float[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDirection

        public SpotLightObject setDirection​(double x,
                                            double y,
                                            double z)
        Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setDirection(float[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDirection

        public SpotLightObject setDirection​(double[] newArray)
        Utility method: double-precision set-array accessor for X3D floating-point type, similar to setDirection(float[]).
        Parameters:
        newArray - is new value for field
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getGlobal

        public boolean getGlobal()
        Provide boolean value from inputOutput SFBool field named global.

        Tooltip: Global lights illuminate all objects within their volume of lighting influence. Scoped lights only illuminate objects within the same transformation hierarchy.
        • Warning: DirectionalLight default global=false to limit scope and avoid inadvertently illuminating every object in a large scene. PointLight and SpotLight default global=true since their effects are each limited by maximum radius value.
        Specified by:
        getGlobal in interface SpotLight
        Returns:
        value of global field
      • setGlobal

        public SpotLightObject setGlobal​(boolean newValue)
        Accessor method to assign boolean value to inputOutput SFBool field named global.

        Tooltip: Global lights illuminate all objects within their volume of lighting influence. Scoped lights only illuminate objects within the same transformation hierarchy.
        • Warning: DirectionalLight default global=false to limit scope and avoid inadvertently illuminating every object in a large scene. PointLight and SpotLight default global=true since their effects are each limited by maximum radius value.
        Specified by:
        setGlobal in interface SpotLight
        Parameters:
        newValue - is new value for the global field.
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setGlobal

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

        public float getIntensity()
        Provide float value within allowed range of [0,1] from inputOutput SFFloat field named intensity.

        Tooltip: [0,1] Brightness of direct emission from the light. *
        Specified by:
        getIntensity in interface SpotLight
        Specified by:
        getIntensity in interface X3DLightNode
        Returns:
        value of intensity field
      • setIntensity

        public SpotLightObject setIntensity​(float newValue)
        Accessor method to assign float value to inputOutput SFFloat field named intensity.

        Tooltip: [0,1] Brightness of direct emission from the light. *
        Specified by:
        setIntensity in interface SpotLight
        Specified by:
        setIntensity in interface X3DLightNode
        Parameters:
        newValue - is new value for the intensity field.
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setIntensity

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

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

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

        public float[] getLocation()
        Provide array of 3-tuple float results from inputOutput SFVec3f field named location.

        Tooltip: Position of light relative to local coordinate system. *
        Specified by:
        getLocation in interface SpotLight
        Returns:
        value of location field
      • setLocation

        public SpotLightObject setLocation​(float[] newValue)
        Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named location.

        Tooltip: Position of light relative to local coordinate system. *
        Specified by:
        setLocation in interface SpotLight
        Parameters:
        newValue - is new value for the location field.
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setLocation

        public SpotLightObject setLocation​(SFVec3fObject newValue)
        Assign typed object value to SFVec3f location field, similar to setLocation(float[]).
        Parameters:
        newValue - is new value for the location field.
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setLocation

        public SpotLightObject setLocation​(float x,
                                           float y,
                                           float z)
        Assign values to SFVec3f location field, similar to setLocation(float[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setLocation

        public SpotLightObject setLocation​(double x,
                                           double y,
                                           double z)
        Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setLocation(float[]).
        Parameters:
        x - first component
        y - second component
        z - third component
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setLocation

        public SpotLightObject setLocation​(double[] newArray)
        Utility method: double-precision set-array accessor for X3D floating-point type, similar to setLocation(float[]).
        Parameters:
        newArray - is new value for field
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearMetadata

        public SpotLightObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        SpotLightObject - 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
      • getOn

        public boolean getOn()
        Provide boolean value from inputOutput SFBool field named on.

        Tooltip: Enables/disables this light source. *
        Specified by:
        getOn in interface SpotLight
        Specified by:
        getOn in interface X3DLightNode
        Returns:
        value of on field
      • setOn

        public SpotLightObject setOn​(boolean newValue)
        Accessor method to assign boolean value to inputOutput SFBool field named on.

        Tooltip: Enables/disables this light source. *
        Specified by:
        setOn in interface SpotLight
        Specified by:
        setOn in interface X3DLightNode
        Parameters:
        newValue - is new value for the on field.
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setOn

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

        public float getRadius()
        Provide float value within allowed range of [0,infinity) from initializeOnly SFFloat field named radius.

        Tooltip: Maximum effective distance of light relative to local light position, affected by ancestor scaling. *
        Specified by:
        getRadius in interface SpotLight
        Returns:
        value of radius field
      • setRadius

        public SpotLightObject setRadius​(float newValue)
        Accessor method to assign float value to initializeOnly SFFloat field named radius.

        Tooltip: Maximum effective distance of light relative to local light position, affected by ancestor scaling. *
        Specified by:
        setRadius in interface SpotLight
        Parameters:
        newValue - is new value for the radius field.
        Returns:
        SpotLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setRadius

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

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

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

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

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

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

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

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

        public SpotLightObject addComments​(CommentsBlock newCommentsBlock)
        Add CommentsBlock to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newCommentsBlock - block of comments to add
        Returns:
        SpotLightObject - 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)