Package org.web3d.x3d.sai.CubeMapTexturing

Interface GeneratedCubeMapTexture

All Superinterfaces:
X3DAppearanceChildNode, X3DEnvironmentTextureNode, X3DNode, X3DTextureNode
All Known Implementing Classes:
GeneratedCubeMapTextureObject
public interface GeneratedCubeMapTexture
extends X3DEnvironmentTextureNode
GeneratedCubeMapTexture is a texture node that defines a cubic environment map that sources its data from internally generated images.

X3D node tooltip: (X3D version 3.1 or later) [X3DEnvironmentTextureNode] GeneratedCubeMapTexture is a texture node that defines a cubic environment map that sources its data from internally generated images. The viewpoint of the generated texture is the location and orientation of the associated geometry in world space.
  • Hint: can contain a single TextureProperties node.
  • Hint: typically a Box is used for applying the GeneratedCubeMapTexture.

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification: TODO, X3D Abstract Specification: GeneratedCubeMapTexture, X3D Tooltips: GeneratedCubeMapTexture, X3D Scene Authoring Hints: Images

  • Method Summary

    Modifier and Type Method Description
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    int getSize()
    Provide int value within allowed range of (0,infinity) from initializeOnly SFInt32 field named size.
    TextureProperties getTextureProperties()
    Provide TextureProperties instance (using a properly typed node) from initializeOnly SFNode field textureProperties.
    java.lang.String getUpdate()
    Provide String enumeration value (baseType generatedCubeMapTextureUpdateChoices) ["NONE" | "NEXT_FRAME_ONLY" | "ALWAYS"] from inputOutput SFString field named update.
    GeneratedCubeMapTexture setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    GeneratedCubeMapTexture setSize​(int newValue)
    Accessor method to assign int value to initializeOnly SFInt32 field named size.
    GeneratedCubeMapTexture setTextureProperties​(TextureProperties newValue)
    Accessor method to assign TextureProperties instance (using a properly typed node) to initializeOnly SFNode field textureProperties.
    GeneratedCubeMapTexture setUpdate​(java.lang.String newValue)
    Accessor method to assign String enumeration value ("NONE" | "NEXT_FRAME_ONLY" | "ALWAYS") to inputOutput SFString field named update.

  • Method Details

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide 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 X3DAppearanceChildNode
      Specified by:
      getMetadata in interface X3DEnvironmentTextureNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DTextureNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      GeneratedCubeMapTexture setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign 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 X3DAppearanceChildNode
      Specified by:
      setMetadata in interface X3DEnvironmentTextureNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DTextureNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      GeneratedCubeMapTexture - 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

    • getSize

      int getSize()
      Provide int value within allowed range of (0,infinity) from initializeOnly SFInt32 field named size.

      Tooltip: (0,+infinity) size indicates the resolution of the generated images in number of pixels per side. *
      Returns:
      value of size field

    • setSize

      GeneratedCubeMapTexture setSize​(int newValue)
      Accessor method to assign int value to initializeOnly SFInt32 field named size.

      Tooltip: (0,+infinity) size indicates the resolution of the generated images in number of pixels per side. *
      Parameters:
      newValue - is new value for the size field.
      Returns:
      GeneratedCubeMapTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getTextureProperties

      TextureProperties getTextureProperties()
      Provide TextureProperties instance (using a properly typed node) from initializeOnly SFNode field textureProperties.
      Returns:
      value of textureProperties field

    • setTextureProperties

      GeneratedCubeMapTexture setTextureProperties​(TextureProperties newValue)
      Accessor method to assign TextureProperties instance (using a properly typed node) to initializeOnly SFNode field textureProperties.
      Parameters:
      newValue - is new value for the textureProperties field.
      Returns:
      GeneratedCubeMapTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getUpdate

      java.lang.String getUpdate()
      Provide String enumeration value (baseType generatedCubeMapTextureUpdateChoices) ["NONE" | "NEXT_FRAME_ONLY" | "ALWAYS"] from inputOutput SFString field named update.

      Tooltip: update controls regeneration of the texture.
      • Warning: An object trying to render itself in the scene graph can cause infinite loops.
      • Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
      Returns:
      value of update field

    • setUpdate

      GeneratedCubeMapTexture setUpdate​(java.lang.String newValue)
      Accessor method to assign String enumeration value ("NONE" | "NEXT_FRAME_ONLY" | "ALWAYS") to inputOutput SFString field named update.

      Tooltip: update controls regeneration of the texture.
      • Warning: An object trying to render itself in the scene graph can cause infinite loops.
      • Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
      Parameters:
      newValue - is new value for the update field.
      Returns:
      GeneratedCubeMapTexture - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).