All Superinterfaces:: X3DChildNode, X3DLightNode, X3DNode, X3DTextureProjectorNode

All Known Implementing Classes:: TextureProjector

public interface TextureProjector extends X3DTextureProjectorNode

TextureProjector is similar to a light that projects a texture into the scene, illuminating geometry that intersects the perspective projection volume.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. TextureProjector node tooltip: [X3DTextureProjectorNode] TextureProjector is similar to a light that projects a texture into the scene, illuminating geometry that intersects the perspective projection volume.

Hint: specification errata corrections at https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4.1-CD/Part01/components/textureProjection.html#TextureProjector
Hint: diagram https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4.1-CD/Images/ptmperspective2.png

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 float value within allowed range of [0,3.1416] from inputOutput SFFloat 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.

float[]

getUpVector()

Provide array of 3-tuple float results from inputOutput SFVec3f field named upVector.

TextureProjector

setAmbientIntensity(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named ambientIntensity.

TextureProjector

setColor(float[] newValue)

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

TextureProjector

setDescription(String newValue)

Accessor method to assign String value to inputOutput SFString field named description.

TextureProjector

setDirection(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.

TextureProjector

setFarDistance(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named farDistance.

TextureProjector

setFieldOfView(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named fieldOfView.

TextureProjector

setGlobal(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named global.

TextureProjector

setIntensity(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named intensity.

TextureProjector

setLocation(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named location.

TextureProjector

setMetadata(X3DMetadataObject newValue)

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

TextureProjector

setNearDistance(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named nearDistance.

TextureProjector

setOn(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named on.

TextureProjector

setShadowIntensity(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named shadowIntensity.

TextureProjector

setShadows(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named shadows.

TextureProjector

setTexture(X3DTexture2DNode newValue)

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

TextureProjector

setUpVector(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named upVector.

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
  TextureProjector 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:
  
  TextureProjector - 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.
  
  Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
  
  Specified by:
  
  getColor in interface X3DLightNode
  
  Specified by:
  
  getColor in interface X3DTextureProjectorNode
  
  Returns:
  
  value of color field
- setColor
  TextureProjector 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.
  
  Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
  
  Specified by:
  
  setColor in interface X3DLightNode
  
  Specified by:
  
  setColor in interface X3DTextureProjectorNode
  
  Parameters:
  
  newValue - is new value for the color field.
  
  Returns:
  
  TextureProjector - 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
  TextureProjector 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:
  
  TextureProjector - 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
  
  TextureProjector 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:
  
  TextureProjector - 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
  
  TextureProjector 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:
  
  TextureProjector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getFieldOfView
  float getFieldOfView()
  
  Provide float value within allowed range of [0,3.1416] from inputOutput SFFloat field named fieldOfView.
  
  Tooltip: Preferred minimum viewing angle for this projection in radians, providing minimum height or minimum width (whichever is smaller). Small field of view roughly corresponds to a telephoto lens, large field of view roughly corresponds to a wide-angle lens.
  
  Warning: this field differs for TextureProjectorParallel and TextureProjector.
  
  Returns:
  
  value of fieldOfView field
- setFieldOfView
  TextureProjector setFieldOfView(float newValue)
  
  Accessor method to assign float value to inputOutput SFFloat field named fieldOfView.
  
  Tooltip: Preferred minimum viewing angle for this projection in radians, providing minimum height or minimum width (whichever is smaller). Small field of view roughly corresponds to a telephoto lens, large field of view roughly corresponds to a wide-angle lens.
  
  Warning: this field differs for TextureProjectorParallel and TextureProjector.
  
  Parameters:
  
  newValue - is new value for the fieldOfView field.
  
  Returns:
  
  TextureProjector - 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
  
  TextureProjector 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:
  
  TextureProjector - 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
  
  TextureProjector 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:
  
  TextureProjector - 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
  
  TextureProjector 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:
  
  TextureProjector - 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.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
  
  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:
  
  X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  TextureProjector 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.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
  
  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:
  
  TextureProjector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  X3D Scene Authoring Hints: Metadata Nodes
- 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
  
  TextureProjector 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:
  
  TextureProjector - 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
  
  TextureProjector 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:
  
  TextureProjector - 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
  
  TextureProjector 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:
  
  TextureProjector - 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
  
  TextureProjector 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:
  
  TextureProjector - 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.
  
  Hint: if texture node is NULL or unspecified, corresponding Shape geometry for this Appearance is not textured.
  
  Hint: X3D Scene Authoring Hints, Images https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images
  
  Hint: X3D Architecture 18 Texturing component https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html
  
  Hint: X3D Architecture 33 Texturing3D component https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texture3D.html
  
  Specified by:
  
  getTexture in interface X3DTextureProjectorNode
  
  Returns:
  
  value of texture field
- setTexture
  TextureProjector 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.
  
  Hint: if texture node is NULL or unspecified, corresponding Shape geometry for this Appearance is not textured.
  
  Hint: X3D Scene Authoring Hints, Images https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images
  
  Hint: X3D Architecture 18 Texturing component https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html
  
  Hint: X3D Architecture 33 Texturing3D component https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texture3D.html
  
  Specified by:
  
  setTexture in interface X3DTextureProjectorNode
  
  Parameters:
  
  newValue - is new value for the texture field.
  
  Returns:
  
  TextureProjector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getUpVector
  
  float[] getUpVector()
  
  Provide array of 3-tuple float results from inputOutput SFVec3f field named upVector.
  
  Tooltip: upVector describes the roll of the camera by defining which direction is up for the camera's orientation. *
  
  Specified by:
  
  getUpVector in interface X3DTextureProjectorNode
  
  Returns:
  
  value of upVector field
- setUpVector
  
  TextureProjector setUpVector(float[] newValue)
  
  Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named upVector.
  
  Tooltip: upVector describes the roll of the camera by defining which direction is up for the camera's orientation. *
  
  Specified by:
  
  setUpVector in interface X3DTextureProjectorNode
  
  Parameters:
  
  newValue - is new value for the upVector field.
  
  Returns:
  
  TextureProjector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface TextureProjector

Method Summary

Method Details

getAmbientIntensity

setAmbientIntensity

getAspectRatio

getColor

setColor

getDescription

setDescription

getDirection

setDirection

getFarDistance

setFarDistance

getFieldOfView

setFieldOfView

getGlobal

setGlobal

getIntensity

setIntensity

getLocation

setLocation

getMetadata

setMetadata

getNearDistance

setNearDistance

getOn

setOn

getShadowIntensity

setShadowIntensity

getShadows

setShadows

getTexture

setTexture

getUpVector

setUpVector