Package org.web3d.x3d.sai.TextureProjector

Interface TextureProjectorParallel

All Superinterfaces:
X3DChildNode, X3DLightNode, X3DNode, X3DTextureProjectorNode
All Known Implementing Classes:
TextureProjectorParallel
public interface TextureProjectorParallel extends X3DTextureProjectorNode
TextureProjectorParallel is similar to a light that projects a texture into the scene, illuminating geometry that intersects the parallel projection volume.

X3D node tooltip: (X3D version 4.0 draft) [X3DTextureProjectorNode] TextureProjectorParallel is similar to a light that projects a texture into the scene, illuminating geometry that intersects the parallel projection volume.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    getAmbientIntensity()
    Provide float value within allowed range of [0,1] from inputOutput SFFloat field named ambientIntensity.
    float
    getAspectRatio()
    Provide float value within allowed range of (0,infinity) from outputOnly SFFloat field named aspectRatio.
    float[]
    getColor()
    Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named color.
    String
    getDescription()
    Provide String value from inputOutput SFString field named description.
    float[]
    getDirection()
    Provide array of 3-tuple float results from inputOutput SFVec3f field named direction.
    float
    getFarDistance()
    Provide float value within allowed range of [-1,infinity) from inputOutput SFFloat field named farDistance.
    float[]
    getFieldOfView()
    Provide array of 4-tuple float results from inputOutput SFVec4f field named fieldOfView.
    boolean
    getGlobal()
    Provide boolean value from inputOutput SFBool field named global.
    float
    getIntensity()
    Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named intensity.
    float[]
    getLocation()
    Provide array of 3-tuple float results from inputOutput SFVec3f field named location.
    X3DMetadataObject
    getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    float
    getNearDistance()
    Provide float value within allowed range of [-1,infinity) from inputOutput SFFloat field named nearDistance.
    boolean
    getOn()
    Provide boolean value from inputOutput SFBool field named on.
    float
    getShadowIntensity()
    Provide float value within allowed range of [0,1] from inputOutput SFFloat field named shadowIntensity.
    boolean
    getShadows()
    Provide boolean value from inputOutput SFBool field named shadows.
    X3DTexture2DNode
    getTexture()
    Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field texture.
    TextureProjectorParallel
    setAmbientIntensity(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named ambientIntensity.
    TextureProjectorParallel
    setColor(float[] newValue)
    Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named color.
    TextureProjectorParallel
    setDescription(String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    TextureProjectorParallel
    setDirection(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.
    TextureProjectorParallel
    setFarDistance(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named farDistance.
    TextureProjectorParallel
    setFieldOfView(float[] newValue)
    Accessor method to assign 4-tuple float array to inputOutput SFVec4f field named fieldOfView.
    TextureProjectorParallel
    setGlobal(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named global.
    TextureProjectorParallel
    setIntensity(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named intensity.
    TextureProjectorParallel
    setLocation(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named location.
    TextureProjectorParallel
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    TextureProjectorParallel
    setNearDistance(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named nearDistance.
    TextureProjectorParallel
    setOn(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named on.
    TextureProjectorParallel
    setShadowIntensity(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named shadowIntensity.
    TextureProjectorParallel
    setShadows(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named shadows.
    TextureProjectorParallel
    setTexture(X3DTexture2DNode newValue)
    Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field texture.

  • Method Details

    • getAmbientIntensity

      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. Interchange profile hint: this field may be ignored, applying the default value regardless. *
      Specified by:
      getAmbientIntensity in interface X3DLightNode
      Specified by:
      getAmbientIntensity in interface X3DTextureProjectorNode
      Returns:
      value of ambientIntensity field

    • setAmbientIntensity

      TextureProjectorParallel 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. Interchange profile hint: this field may be ignored, applying the default value regardless. *
      Specified by:
      setAmbientIntensity in interface X3DLightNode
      Specified by:
      setAmbientIntensity in interface X3DTextureProjectorNode
      Parameters:
      newValue - is new value for the ambientIntensity field.
      Returns:
      TextureProjectorParallel - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getAspectRatio

      float getAspectRatio()
      Provide float value within allowed range of (0,infinity) from outputOnly SFFloat field named aspectRatio.

      Tooltip: aspectRatio is the ratio of width and height that is projected. *
      Specified by:
      getAspectRatio in interface X3DTextureProjectorNode
      Returns:
      value of aspectRatio field

    • getColor

      float[] getColor()
      Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named color.

      Tooltip: [0,1] color of light, applied to colors of objects.
      Specified by:
      getColor in interface X3DLightNode
      Specified by:
      getColor in interface X3DTextureProjectorNode
      Returns:
      value of color field

    • setColor

      TextureProjectorParallel setColor(float[] newValue)
      Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named color.

      Tooltip: [0,1] color of light, applied to colors of objects.
      Specified by:
      setColor in interface X3DLightNode
      Specified by:
      setColor in interface X3DTextureProjectorNode
      Parameters:
      newValue - is new value for the color field.
      Returns:
      TextureProjectorParallel - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDescription

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

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

    • setDescription

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

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

    • getDirection

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

      Tooltip: Direction for projection. *
      Specified by:
      getDirection in interface X3DTextureProjectorNode
      Returns:
      value of direction field

    • setDirection

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

      Tooltip: Direction for projection. *
      Specified by:
      setDirection in interface X3DTextureProjectorNode
      Parameters:
      newValue - is new value for the direction field.
      Returns:
      TextureProjectorParallel - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getFarDistance

      float getFarDistance()
      Provide float value within allowed range of [-1,infinity) from inputOutput SFFloat field named farDistance.

      Tooltip: or (0,+infinity) maximum distance necessary for texture display. *
      Specified by:
      getFarDistance in interface X3DTextureProjectorNode
      Returns:
      value of farDistance field

    • setFarDistance

      TextureProjectorParallel setFarDistance(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named farDistance.

      Tooltip: or (0,+infinity) maximum distance necessary for texture display. *
      Specified by:
      setFarDistance in interface X3DTextureProjectorNode
      Parameters:
      newValue - is new value for the farDistance field.
      Returns:
      TextureProjectorParallel - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getFieldOfView

      float[] getFieldOfView()
      Provide array of 4-tuple float results from inputOutput SFVec4f field named fieldOfView.

      Tooltip: Minimum and maximum extents of projection texture in units of local coordinate system. Small field of view roughly corresponds to a telephoto lens, large field of view roughly corresponds to a wide-angle lens.
      • Warning: minimum corner must remain less than maximum corner.
      • Hint: rectangular display width/height = (maxX-minX) / (maxY-minY).
      • Warning: this field differs for TextureProjectorParallel and TextureProjector.
      Returns:
      value of fieldOfView field

    • setFieldOfView

      TextureProjectorParallel setFieldOfView(float[] newValue)
      Accessor method to assign 4-tuple float array to inputOutput SFVec4f field named fieldOfView.

      Tooltip: Minimum and maximum extents of projection texture in units of local coordinate system. Small field of view roughly corresponds to a telephoto lens, large field of view roughly corresponds to a wide-angle lens.
      • Warning: minimum corner must remain less than maximum corner.
      • Hint: rectangular display width/height = (maxX-minX) / (maxY-minY).
      • Warning: this field differs for TextureProjectorParallel and TextureProjector.
      Parameters:
      newValue - is new value for the fieldOfView field.
      Returns:
      TextureProjectorParallel - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getGlobal

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

      Tooltip: Global texture projection illuminates all objects within their volume of influence. Scoped texture projection (global false) only illuminates objects within the same transformation hierarchy. *
      Specified by:
      getGlobal in interface X3DTextureProjectorNode
      Returns:
      value of global field

    • setGlobal

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

      Tooltip: Global texture projection illuminates all objects within their volume of influence. Scoped texture projection (global false) only illuminates objects within the same transformation hierarchy. *
      Specified by:
      setGlobal in interface X3DTextureProjectorNode
      Parameters:
      newValue - is new value for the global field.
      Returns:
      TextureProjectorParallel - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getIntensity

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

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

    • setIntensity

      TextureProjectorParallel 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 X3DLightNode
      Specified by:
      setIntensity in interface X3DTextureProjectorNode
      Parameters:
      newValue - is new value for the intensity field.
      Returns:
      TextureProjectorParallel - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getLocation

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

      Tooltip: Position of center of texture projection relative to local coordinate system. *
      Specified by:
      getLocation in interface X3DTextureProjectorNode
      Returns:
      value of location field

    • setLocation

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

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

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DLightNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DTextureProjectorNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      TextureProjectorParallel setMetadata(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DLightNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DTextureProjectorNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      TextureProjectorParallel - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • getNearDistance

      float getNearDistance()
      Provide float value within allowed range of [-1,infinity) from inputOutput SFFloat field named nearDistance.

      Tooltip: or (0,+infinity) minimum distance necessary for texture display. *
      Specified by:
      getNearDistance in interface X3DTextureProjectorNode
      Returns:
      value of nearDistance field

    • setNearDistance

      TextureProjectorParallel setNearDistance(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named nearDistance.

      Tooltip: or (0,+infinity) minimum distance necessary for texture display. *
      Specified by:
      setNearDistance in interface X3DTextureProjectorNode
      Parameters:
      newValue - is new value for the nearDistance field.
      Returns:
      TextureProjectorParallel - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getOn

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

      Tooltip: Enables/disables this texture projection source. *
      Specified by:
      getOn in interface X3DLightNode
      Specified by:
      getOn in interface X3DTextureProjectorNode
      Returns:
      value of on field

    • setOn

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

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

    • getShadowIntensity

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

      Tooltip: [0,1] shadowIntensity field defines how much light is obscured by shapes that cast shadows, ranging from 0 (light not obscured, no visible shadows) to 1 (light completely obscured, full-intensity shadows). *
      Specified by:
      getShadowIntensity in interface X3DLightNode
      Specified by:
      getShadowIntensity in interface X3DTextureProjectorNode
      Returns:
      value of shadowIntensity field

    • setShadowIntensity

      TextureProjectorParallel setShadowIntensity(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named shadowIntensity.

      Tooltip: [0,1] shadowIntensity field defines how much light is obscured by shapes that cast shadows, ranging from 0 (light not obscured, no visible shadows) to 1 (light completely obscured, full-intensity shadows). *
      Specified by:
      setShadowIntensity in interface X3DLightNode
      Specified by:
      setShadowIntensity in interface X3DTextureProjectorNode
      Parameters:
      newValue - is new value for the shadowIntensity field.
      Returns:
      TextureProjectorParallel - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getShadows

      boolean getShadows()
      Provide boolean value from inputOutput SFBool field named shadows.

      Tooltip: shadows field indicates whether or not this light casts a shadow behind illuminated X3DShapeNode geometry. *
      Specified by:
      getShadows in interface X3DLightNode
      Specified by:
      getShadows in interface X3DTextureProjectorNode
      Returns:
      value of shadows field

    • setShadows

      TextureProjectorParallel setShadows(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named shadows.

      Tooltip: shadows field indicates whether or not this light casts a shadow behind illuminated X3DShapeNode geometry. *
      Specified by:
      setShadows in interface X3DLightNode
      Specified by:
      setShadows in interface X3DTextureProjectorNode
      Parameters:
      newValue - is new value for the shadows field.
      Returns:
      TextureProjectorParallel - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getTexture

      X3DTexture2DNode getTexture()
      Provide org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) from inputOutput SFNode field texture.

      Tooltip: [X3DTextureNode] Single contained texture node (ImageTexture, MovieTexture, PixelTexture, MultiTexture) that maps image(s) to surface geometry.
      Specified by:
      getTexture in interface X3DTextureProjectorNode
      Returns:
      value of texture field

    • setTexture

      TextureProjectorParallel setTexture(X3DTexture2DNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTexture2DNode instance (using a properly typed node) to inputOutput SFNode field texture.

      Tooltip: [X3DTextureNode] Single contained texture node (ImageTexture, MovieTexture, PixelTexture, MultiTexture) that maps image(s) to surface geometry.
      Specified by:
      setTexture in interface X3DTextureProjectorNode
      Parameters:
      newValue - is new value for the texture field.
      Returns:
      TextureProjectorParallel - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).