Appearance (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DAppearanceNode, X3DNode

All Known Implementing Classes:

AppearanceObject
```
public interface Appearance
extends X3DAppearanceNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

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.
- Hint: insert a Shape node before adding geometry or Appearance. Interchange profile hint: only Material and ImageTexture children are allowed.
- Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related shapes in a scene.
- Hint: Advanced uses can contain MultiTexture, MultiTextureTransform/TextureTransformMatrix3D/TextureTransform3D, ComposedShader/PackagedShader/ProgramShader, ComposedTexture3D/ImageTexture3D/PixelTexture3D, or ComposedCubeMapTexture/GeneratedCubeMapTexture/ImageCubeMapTexture.
- Hint: X3D Architecture 12.2.2 Appearance node
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shape.html#Appearancenode
- Hint: X3D Architecture 17.2.2 Lighting model
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/lighting.html#Lightingmodel
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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and 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.
`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`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`Appearance`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`Appearance`	`setFillProperties(FillProperties newValue)` Assign FillProperties instance (using a properly typed node) to inputOutput SFNode field fillProperties.
`Appearance`	`setLineProperties(LineProperties newValue)` Assign LineProperties instance (using a properly typed node) to inputOutput SFNode field lineProperties.
`Appearance`	`setMaterial(X3DMaterialNode newValue)` Assign X3DMaterialNode instance (using a properly typed node) to inputOutput SFNode field material.
`Appearance`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`void`	`setShaders(X3DNode newValue)` Set single child shaders node, replacing prior array of existing nodes (if any).
`Appearance`	`setShaders(X3DNode[] newValue)` Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field shaders.
`Appearance`	`setTexture(X3DTextureNode newValue)` Assign X3DTextureNode instance (using a properly typed node) to inputOutput SFNode field texture.
`Appearance`	`setTextureTransform(X3DTextureTransformNode newValue)` Assign X3DTextureTransformNode instance (using a properly typed node) to inputOutput SFNode field textureTransform.
`Appearance`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - 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)
```
    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)
```
    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)
```
    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)
```
    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
  - 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.
    - Hint: X3D Architecture 31 Programmable shaders component
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shaders.html
    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)
```
    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. Hint: X3D Architecture 31 Programmable shaders component http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/shaders.html
    
    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.
    - Hint: if texture node is NULL or unspecified, corresponding Shape geometry for this Appearance is not textured.
    - Hint: X3D Scene Authoring Hints, Images
      http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images
    - Hint: X3D Architecture 18 Texturing component
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html
    - Hint: X3D Architecture 33 Texturing3D component
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texture3D.html
    Returns:
    
    value of texture field
  - setTexture
```
Appearance setTexture(X3DTextureNode newValue)
```
    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. Hint: if texture node is NULL or unspecified, corresponding Shape geometry for this Appearance is not textured. Hint: X3D Scene Authoring Hints, Images http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Images Hint: X3D Architecture 18 Texturing component http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texturing.html Hint: X3D Architecture 33 Texturing3D component http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/texture3D.html
    
    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 is NULL or unspecified, this field has no effect.
    Returns:
    
    value of textureTransform field
  - setTextureTransform
```
Appearance setTextureTransform(X3DTextureTransformNode newValue)
```
    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 is NULL or unspecified, 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).
  - setDEF
```
Appearance setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DAppearanceNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
Appearance setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DAppearanceNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
Appearance setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DAppearanceNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    Appearance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface Appearance

Method Summary

Method Detail

getFillProperties

setFillProperties

getLineProperties

setLineProperties

getMaterial

setMaterial

getMetadata

setMetadata

getShaders

setShaders

addShaders

setShaders

getTexture

setTexture

getTextureTransform

setTextureTransform

setDEF

setUSE

setCssClass