Contour2D (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DNode

All Known Implementing Classes:

Contour2DObject
```
public interface Contour2D
extends X3DNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: [X3DNode] Contour2D groups a set of curve segments into a composite contour. The children segments form a closed loop, with first point of first child repeated as last point of last child, and last point of each segment repeated as the first point of the next consecutive segment. The children segments are type NurbsCurve2D or ContourPolyline2D, enumerated in the consecutive order of contour topology.
- Warning: Contour2D is not a renderable geometry node.
- Hint: Contour2D is used as the trimmingContour field of the NurbsTrimmedSurface node.
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: Contour2D, X3D Tooltips: Contour2D, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addChildren(X3DNode[] newValue)` Add array of children nodes to array of existing nodes (if any).
`X3DNode[]`	`getChildren()` Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to NurbsCurve2D\|ContourPolyline2D, from inputOutput MFNode field children.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`void`	`setChildren(X3DNode newValue)` Set single children node, replacing prior array of existing nodes (if any).
`Contour2D`	`setChildren(X3DNode[] newValue)` Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to NurbsCurve2D\|ContourPolyline2D, to inputOutput MFNode field children. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (newValue instanceof org.web3d.x3d.jsail.Core.CommentsBlock) \|\| (newValue instanceof org.web3d.x3d.jsail.Core.ROUTEObject) \|\| (newValue instanceof org.web3d.x3d.jsail.Networking.IMPORTObject) \|\| (newValue instanceof org.web3d.x3d.jsail.Networking.EXPORTObject) \|\| (newValue instanceof org.web3d.x3d.jsail.Core.ProtoDeclareObject) \|\| (newValue instanceof org.web3d.x3d.jsail.Core.ExternProtoDeclareObject) \|\| (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.NURBS.NurbsCurve2DObject) \|\| (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.NURBS.ContourPolyline2DObject); if (!
`Contour2D`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`Contour2D`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`Contour2D`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`Contour2D`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getChildren
```
X3DNode[] getChildren()
```
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to NurbsCurve2D|ContourPolyline2D, from inputOutput MFNode field children.
    
    Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to NurbsCurve2D|ContourPolyline2D.
    
    Returns:
    
    value of children field
    
    See Also:
    
    NurbsCurve2DObject, ContourPolyline2DObject
  - setChildren
```
Contour2D setChildren(X3DNode[] newValue)
```
    Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) with acceptable node types limited to NurbsCurve2D|ContourPolyline2D, to inputOutput MFNode field children. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (newValue instanceof org.web3d.x3d.jsail.Core.CommentsBlock) || (newValue instanceof org.web3d.x3d.jsail.Core.ROUTEObject) || (newValue instanceof org.web3d.x3d.jsail.Networking.IMPORTObject) || (newValue instanceof org.web3d.x3d.jsail.Networking.EXPORTObject) || (newValue instanceof org.web3d.x3d.jsail.Core.ProtoDeclareObject) || (newValue instanceof org.web3d.x3d.jsail.Core.ExternProtoDeclareObject) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.NURBS.NurbsCurve2DObject) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.NURBS.ContourPolyline2DObject); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes NurbsCurve2D|ContourPolyline2D; newValue=" + newValue); }
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to NurbsCurve2D|ContourPolyline2D.
    
    Parameters:
    
    newValue - is new value for the children field.
    
    Returns:
    
    Contour2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addChildren
```
void addChildren(X3DNode[] newValue)
```
    Add array of children nodes to array of existing nodes (if any).
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to NurbsCurve2D|ContourPolyline2D.
    
    Parameters:
    
    newValue - is new value array to be appended the children field.
  - setChildren
```
void setChildren(X3DNode newValue)
```
    Set single children node, replacing prior array of existing nodes (if any).
    
    Parameters:
    
    newValue - is new node for the children field
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
Contour2D setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    Contour2D - 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
  - setDEF
```
Contour2D 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 X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    Contour2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
Contour2D 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 X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    Contour2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
Contour2D 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 X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    Contour2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface Contour2D

Method Summary

Method Detail

getChildren

setChildren

addChildren

setChildren

getMetadata

setMetadata

setDEF

setUSE

setCssClass