Matrix4VertexAttribute (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DGeometricPropertyNode, X3DNode, X3DVertexAttributeNode

All Known Implementing Classes:

Matrix4VertexAttributeObject
```
public interface Matrix4VertexAttribute
extends X3DVertexAttributeNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: (X3D version 3.1 or later) [X3DVertexAttributeNode] Matrix4VertexAttribute defines a set of per-vertex 4x4 matrix attributes. *

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: Matrix4VertexAttribute, X3D Tooltips: Matrix4VertexAttribute, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`java.lang.String`	`getName()` Provide String value from inputOutput SFString field named name.
`float[]`	`getValue()` Provide array of float results from inputOutput MFMatrix4f field named value.
`Matrix4VertexAttribute`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`Matrix4VertexAttribute`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`Matrix4VertexAttribute`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`Matrix4VertexAttribute`	`setName(java.lang.String newValue)` Assign String value to inputOutput SFString field named name.
`Matrix4VertexAttribute`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`Matrix4VertexAttribute`	`setValue(float[] newValue)` Assign float array to inputOutput MFMatrix4f field named value.

- Method Detail
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DGeometricPropertyNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Specified by:
    
    getMetadata in interface X3DVertexAttributeNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
Matrix4VertexAttribute setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DGeometricPropertyNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface X3DVertexAttributeNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    Matrix4VertexAttribute - 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
  - getName
```
java.lang.String getName()
```
    Provide String value from inputOutput SFString field named name.
    
    Tooltip: Required name for this particular VertexAttribute instance.
    - Warning: name is not specified if this instance is a USE node.
    - 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
    Specified by:
    
    getName in interface X3DVertexAttributeNode
    
    Returns:
    
    value of name field
  - setName
```
Matrix4VertexAttribute setName(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named name.
    
    Tooltip: Required name for this particular VertexAttribute instance. Warning: name is not specified if this instance is a USE node. 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
    
    Specified by:
    
    setName in interface X3DVertexAttributeNode
    
    Parameters:
    
    newValue - is new value for the name field.
    
    Returns:
    
    Matrix4VertexAttribute - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getValue
```
float[] getValue()
```
    Provide array of float results from inputOutput MFMatrix4f field named value.
    
    Tooltip: value specifies an arbitrary collection of matrix values that will be passed to the shader as per-vertex information.
    - Hint: the length of the value field shall be a multiple of numComponents.
    Returns:
    
    value of value field
  - setValue
```
Matrix4VertexAttribute setValue(float[] newValue)
```
    Assign float array to inputOutput MFMatrix4f field named value.
    
    Tooltip: value specifies an arbitrary collection of matrix values that will be passed to the shader as per-vertex information. Hint: the length of the value field shall be a multiple of numComponents.
    
    Parameters:
    
    newValue - is new value for the value field.
    
    Returns:
    
    Matrix4VertexAttribute - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
Matrix4VertexAttribute 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 X3DGeometricPropertyNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in interface X3DVertexAttributeNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    Matrix4VertexAttribute - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
Matrix4VertexAttribute 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 X3DGeometricPropertyNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in interface X3DVertexAttributeNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    Matrix4VertexAttribute - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
Matrix4VertexAttribute 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 X3DGeometricPropertyNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in interface X3DVertexAttributeNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    Matrix4VertexAttribute - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface Matrix4VertexAttribute

Method Summary

Method Detail

getMetadata

setMetadata

getName

setName

getValue

setValue

setDEF

setUSE

setCssClass