Interface Appearance

All Superinterfaces:
X3DAppearanceNode, X3DNode
All Known Implementing Classes:
Appearance

public interface Appearance extends X3DAppearanceNode
Appearance specifies the visual properties of geometry by containing the Material, ImageTexture/MovieTexture/PixelTexture, FillProperties, LineProperties, programmable shader nodes (ComposedShader, PackagedShader, ProgramShader) and TextureTransform nodes.

X3D node tooltip: [X3DAppearanceNode] Appearance specifies the visual properties of geometry by containing the Material, ImageTexture/MovieTexture/PixelTexture, FillProperties, LineProperties, programmable shader nodes (ComposedShader, PackagedShader, ProgramShader) and TextureTransform nodes.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification, X3D Abstract Specification: Appearance, X3D Tooltips: Appearance, X3D Scene Authoring Hints
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addShaders​(X3DNode[] newValue)
    Add array of child shaders nodes to array of existing nodes (if any).
    Provide org.web3d.x3d.sai.Shape.AcousticProperties instance (using a properly typed node) from inputOutput SFNode field acousticProperties.
    float
    Provide float value within allowed range of [0,1] from inputOutput SFFloat field named alphaCutoff.
    Provide String enumeration value (baseType SFString) ["AUTO" | "OPAQUE" | "MASK" | "BLEND"] from inputOutput SFString field named alphaMode.
    Provide org.web3d.x3d.sai.Shape.FillProperties instance (using a properly typed node) from inputOutput SFNode field fillProperties.
    Provide org.web3d.x3d.sai.Shape.LineProperties instance (using a properly typed node) from inputOutput SFNode field lineProperties.
    Provide org.web3d.x3d.sai.Shape.X3DMaterialNode instance (using a properly typed node) from inputOutput SFNode field material.
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    Provide org.web3d.x3d.sai.Shape.PointProperties instance (using a properly typed node) from inputOutput SFNode field pointProperties.
    Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field shaders.
    Provide org.web3d.x3d.sai.Texturing.X3DTextureNode instance (using a properly typed node) from inputOutput SFNode field texture.
    Provide org.web3d.x3d.sai.Texturing.X3DTextureTransformNode instance (using a properly typed node) from inputOutput SFNode field textureTransform.
    Accessor method to assign org.web3d.x3d.sai.Shape.AcousticProperties instance (using a properly typed node) to inputOutput SFNode field acousticProperties.
    setAlphaCutoff​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named alphaCutoff.
    setAlphaMode​(String newValue)
    Accessor method to assign String enumeration value ("AUTO" | "OPAQUE" | "MASK" | "BLEND") to inputOutput SFString field named alphaMode.
    Accessor method to assign org.web3d.x3d.sai.Shape.FillProperties instance (using a properly typed node) to inputOutput SFNode field fillProperties.
    Accessor method to assign org.web3d.x3d.sai.Shape.LineProperties instance (using a properly typed node) to inputOutput SFNode field lineProperties.
    Accessor method to assign org.web3d.x3d.sai.Shape.X3DMaterialNode instance (using a properly typed node) to inputOutput SFNode field material.
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    Accessor method to assign org.web3d.x3d.sai.Shape.PointProperties instance (using a properly typed node) to inputOutput SFNode field pointProperties.
    void
    setShaders​(X3DNode newValue)
    Set single child shaders node, replacing prior array of existing nodes (if any).
    setShaders​(X3DNode[] newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field shaders.
    Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTextureNode instance (using a properly typed node) to inputOutput SFNode field texture.
    Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTextureTransformNode instance (using a properly typed node) to inputOutput SFNode field textureTransform.
  • Method Details

    • getAcousticProperties

      AcousticProperties getAcousticProperties()
      Provide org.web3d.x3d.sai.Shape.AcousticProperties instance (using a properly typed node) from inputOutput SFNode field acousticProperties.

      Tooltip: [AcousticProperties] Single contained acousticProperties node that specifies additional acoustic attributes applied to associated surface geometry. *
      Returns:
      value of acousticProperties field
    • setAcousticProperties

      Appearance setAcousticProperties(AcousticProperties newValue)
      Accessor method to assign org.web3d.x3d.sai.Shape.AcousticProperties instance (using a properly typed node) to inputOutput SFNode field acousticProperties.

      Tooltip: [AcousticProperties] Single contained acousticProperties node that specifies additional acoustic attributes applied to associated surface geometry. *
      Parameters:
      newValue - is new value for the acousticProperties field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getAlphaCutoff

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

      Tooltip: [0,1] Threshold value used for pixel rendering either transparent or opaque, used when alphaMode="MASK".
      Returns:
      value of alphaCutoff field
    • setAlphaCutoff

      Appearance setAlphaCutoff(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named alphaCutoff.

      Tooltip: [0,1] Threshold value used for pixel rendering either transparent or opaque, used when alphaMode="MASK".
      Parameters:
      newValue - is new value for the alphaCutoff field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getAlphaMode

      String getAlphaMode()
      Provide String enumeration value (baseType SFString) ["AUTO" | "OPAQUE" | "MASK" | "BLEND"] from inputOutput SFString field named alphaMode.

      Tooltip: Provides options for control of alpha transparency handling for textures. AUTO means Material transparency is applied to texture transparency for full backwards compatility with X3D3, OPAQUE means ignore alpha transparency to render texture as opaque, MASK means alpha-testing of pixels as fully transparent when alpha value is less than alphaCutoff and fully opaque when alpha value is greater than or equal to alphaCutoff, BLEND combines partial transparency of textures and materials.
      Returns:
      value of alphaMode field
    • setAlphaMode

      Appearance setAlphaMode(String newValue)
      Accessor method to assign String enumeration value ("AUTO" | "OPAQUE" | "MASK" | "BLEND") to inputOutput SFString field named alphaMode.

      Tooltip: Provides options for control of alpha transparency handling for textures. AUTO means Material transparency is applied to texture transparency for full backwards compatility with X3D3, OPAQUE means ignore alpha transparency to render texture as opaque, MASK means alpha-testing of pixels as fully transparent when alpha value is less than alphaCutoff and fully opaque when alpha value is greater than or equal to alphaCutoff, BLEND combines partial transparency of textures and materials.
      Parameters:
      newValue - is new value for the alphaMode field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getFillProperties

      FillProperties getFillProperties()
      Provide org.web3d.x3d.sai.Shape.FillProperties instance (using a properly typed node) from inputOutput SFNode field fillProperties.

      Tooltip: [FillProperties] Single contained FillProperties node that specifies additional visual attributes applied to polygonal areas of corresponding geometry, on top of whatever other appearance is already defined. *
      Returns:
      value of fillProperties field
    • setFillProperties

      Appearance setFillProperties(FillProperties newValue)
      Accessor method to assign org.web3d.x3d.sai.Shape.FillProperties instance (using a properly typed node) to inputOutput SFNode field fillProperties.

      Tooltip: [FillProperties] Single contained FillProperties node that specifies additional visual attributes applied to polygonal areas of corresponding geometry, on top of whatever other appearance is already defined. *
      Parameters:
      newValue - is new value for the fillProperties field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getLineProperties

      LineProperties getLineProperties()
      Provide org.web3d.x3d.sai.Shape.LineProperties instance (using a properly typed node) from inputOutput SFNode field lineProperties.

      Tooltip: [LineProperties] Single contained LineProperties node that specifies additional visual attributes applied to corresponding line geometry. *
      Returns:
      value of lineProperties field
    • setLineProperties

      Appearance setLineProperties(LineProperties newValue)
      Accessor method to assign org.web3d.x3d.sai.Shape.LineProperties instance (using a properly typed node) to inputOutput SFNode field lineProperties.

      Tooltip: [LineProperties] Single contained LineProperties node that specifies additional visual attributes applied to corresponding line geometry. *
      Parameters:
      newValue - is new value for the lineProperties field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getMaterial

      X3DMaterialNode getMaterial()
      Provide org.web3d.x3d.sai.Shape.X3DMaterialNode instance (using a properly typed node) from inputOutput SFNode field material.

      Tooltip: [X3DMaterialNode] Single contained Material node that specifies visual attributes for lighting response (color types, transparency, etc.) applied to corresponding geometry.
      • Warning: if material is NULL or unspecified, lighting is off (all lights ignored) for this Shape and unlit object color is (1, 1, 1).
      Returns:
      value of material field
    • setMaterial

      Appearance setMaterial(X3DMaterialNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Shape.X3DMaterialNode instance (using a properly typed node) to inputOutput SFNode field material.

      Tooltip: [X3DMaterialNode] Single contained Material node that specifies visual attributes for lighting response (color types, transparency, etc.) applied to corresponding geometry.
      • Warning: if material is NULL or unspecified, lighting is off (all lights ignored) for this Shape and unlit object color is (1, 1, 1).
      Parameters:
      newValue - is new value for the material field.
      Returns:
      Appearance - 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 X3DAppearanceNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      Appearance 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 X3DAppearanceNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      Appearance - 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
    • getPointProperties

      PointProperties getPointProperties()
      Provide org.web3d.x3d.sai.Shape.PointProperties instance (using a properly typed node) from inputOutput SFNode field pointProperties.
      Returns:
      value of pointProperties field
    • setPointProperties

      Appearance setPointProperties(PointProperties newValue)
      Accessor method to assign org.web3d.x3d.sai.Shape.PointProperties instance (using a properly typed node) to inputOutput SFNode field pointProperties.
      Parameters:
      newValue - is new value for the pointProperties field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getShaders

      X3DNode[] getShaders()
      Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field shaders.

      Tooltip: [X3DShaderNode] Zero or more contained programmable shader nodes (ComposedShader, PackagedShader, ProgramShader) that specify, in order of preference, author-programmed rendering characteristics.

      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DShaderNode.
      Returns:
      value of shaders field
      See Also:
      X3DShaderNode
    • setShaders

      Appearance setShaders(X3DNode[] newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field shaders.

      Tooltip: [X3DShaderNode] Zero or more contained programmable shader nodes (ComposedShader, PackagedShader, ProgramShader) that specify, in order of preference, author-programmed rendering characteristics.

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DShaderNode.
      Parameters:
      newValue - is new value for the shaders field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addShaders

      void addShaders(X3DNode[] newValue)
      Add array of child shaders nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DShaderNode.
      Parameters:
      newValue - is new value array to be appended the shaders field.
    • setShaders

      void setShaders(X3DNode newValue)
      Set single child shaders node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the shaders field
    • getTexture

      X3DTextureNode getTexture()
      Provide org.web3d.x3d.sai.Texturing.X3DTextureNode 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.
      Returns:
      value of texture field
    • setTexture

      Appearance setTexture(X3DTextureNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTextureNode 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.
      Parameters:
      newValue - is new value for the texture field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getTextureTransform

      X3DTextureTransformNode getTextureTransform()
      Provide org.web3d.x3d.sai.Texturing.X3DTextureTransformNode instance (using a properly typed node) from inputOutput SFNode field textureTransform.

      Tooltip: [X3DTextureTransformNode] Single contained TextureTransform node that defines 2D transformation applied to texture coordinates.
      • Hint: if textureTransform array is empty, then this field has no effect.
      Returns:
      value of textureTransform field
    • setTextureTransform

      Appearance setTextureTransform(X3DTextureTransformNode newValue)
      Accessor method to assign org.web3d.x3d.sai.Texturing.X3DTextureTransformNode instance (using a properly typed node) to inputOutput SFNode field textureTransform.

      Tooltip: [X3DTextureTransformNode] Single contained TextureTransform node that defines 2D transformation applied to texture coordinates.
      • Hint: if textureTransform array is empty, then this field has no effect.
      Parameters:
      newValue - is new value for the textureTransform field.
      Returns:
      Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).