Interface Appearance

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

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: TODO, 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).
    FillProperties getFillProperties()
    Provide FillProperties instance (using a properly typed node) from inputOutput SFNode field fillProperties.
    LineProperties getLineProperties()
    Provide LineProperties instance (using a properly typed node) from inputOutput SFNode field lineProperties.
    X3DMaterialNode getMaterial()
    Provide X3DMaterialNode instance (using a properly typed node) from inputOutput SFNode field material.
    X3DMetadataObject getMetadata()
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    PointProperties getPointProperties()
    Provide PointProperties instance (using a properly typed node) from inputOutput SFNode field pointProperties.
    X3DNode[] getShaders()
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field shaders.
    X3DTextureNode getTexture()
    Provide X3DTextureNode instance (using a properly typed node) from inputOutput SFNode field texture.
    X3DTextureTransformNode getTextureTransform()
    Provide X3DTextureTransformNode instance (using a properly typed node) from inputOutput SFNode field textureTransform.
    Appearance setFillProperties​(FillProperties newValue)
    Accessor method to assign FillProperties instance (using a properly typed node) to inputOutput SFNode field fillProperties.
    Appearance setLineProperties​(LineProperties newValue)
    Accessor method to assign LineProperties instance (using a properly typed node) to inputOutput SFNode field lineProperties.
    Appearance setMaterial​(X3DMaterialNode newValue)
    Accessor method to assign X3DMaterialNode instance (using a properly typed node) to inputOutput SFNode field material.
    Appearance setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    Appearance setPointProperties​(PointProperties newValue)
    Accessor method to assign 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).
    Appearance setShaders​(X3DNode[] newValue)
    Accessor method to assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field shaders.
    Appearance setTexture​(X3DTextureNode newValue)
    Accessor method to assign X3DTextureNode instance (using a properly typed node) to inputOutput SFNode field texture.
    Appearance setTextureTransform​(X3DTextureTransformNode newValue)
    Accessor method to assign X3DTextureTransformNode instance (using a properly typed node) to inputOutput SFNode field textureTransform.
  • Method Details

    • getFillProperties

      FillProperties getFillProperties()
      Provide 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 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 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 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 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 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 X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      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 X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      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 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 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 X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) 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 X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) 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 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 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 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 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).