ProtoInstance (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DNode, X3DPrototypeInstance

All Known Implementing Classes:

ProtoInstanceObject
```
public interface ProtoInstance
extends X3DPrototypeInstance, X3DChildNode
```
ProtoInstance can override field default values via fieldValue initializations. Non-recursive nested ProtoInstance and ProtoDeclare statements are allowed within a ProtoDeclare.

X3D statement tooltip: [X3D statement] ProtoInstance creates an instance node of a locally or externally declared prototype definition. ProtoDeclare/ExternProtoDeclare definitions are abstract, corresponding ProtoInstance nodes are concrete. ProtoInstance nodes typically contain fieldValue statements to override default field values defined in the original ProtoDeclare statement.
- Hint: the node type of a ProtoInstance exactly matches the first node in the corresponding ProtoDeclare/ProtoBody declaration.
- Warning: be sure to correctly set the containerField value to match the intended field in the parent node.
- Warning: do not mismatch node types when placing a ProtoInstance in a scene graph. Most validation tools will not catch this error.
- Hint: scene authors can override default initializations of prototype fields by including contained <fieldValue> elements.
- Hint: Nested ProtoInstance and ProtoDeclare statements are allowed within a ProtoDeclare/ProtoBody.
- Hint: if contained within a ProtoDeclare, then a ProtoInstance node can also contain IS/connect statements for other defined fields.
- Warning: a ProtoInstance node may not be instantiated inside its own ProtoDeclare or ExternProtoDeclare declaration (i.e. recursive prototypes are illegal).
- Warning: the local context of each ProtoInstance node must match the node type of the first node in the original ProtoDeclare declaration.
- Warning: ProtoInstance substitution for a Metadata* node might not validate. Workaround: put metadata-typed ProtoInstance nodes as contained values within a parent MetadataSet node.
- Hint: X3D Scene Authoring Hints, Inlines and Prototypes
  http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#InlinesPrototypes
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: ProtoInstance, X3D Tooltips: ProtoInstance, X3D Scene Authoring Hints: InlinesPrototypes

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.
`ProtoInstance`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`ProtoInstance`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`ProtoInstance`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`ProtoInstance`	`setName(java.lang.String newValue)` Assign String value to inputOutput SFString field named name.
`ProtoInstance`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Specified by:
    
    getMetadata in interface X3DPrototypeInstance
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
ProtoInstance setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in interface X3DPrototypeInstance
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    ProtoInstance - 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: name of the prototype node being instanced.
    - Hint: must match name of corresponding ProtoDeclare or ExternProtoDeclare in this scene.
    - Warning: name must be specified unless this ProtoInstance 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
    Returns:
    
    value of name field
  - setName
```
ProtoInstance setName(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named name.
    
    Tooltip: name of the prototype node being instanced. Hint: must match name of corresponding ProtoDeclare or ExternProtoDeclare in this scene. Warning: name must be specified unless this ProtoInstance 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
    
    @see X3D Scene Authoring Hints: Naming Conventions
    
    Parameters:
    
    newValue - is new value for the name field.
    
    Returns:
    
    ProtoInstance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
ProtoInstance 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 X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    ProtoInstance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
ProtoInstance 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 X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    ProtoInstance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
ProtoInstance 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 X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    ProtoInstance - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface ProtoInstance

Method Summary

Method Detail

getMetadata

setMetadata

getName

setName

setDEF

setUSE

setCssClass