CADFaceObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.X3DConcreteElement
- - org.web3d.x3d.jsail.X3DConcreteNode
  - - org.web3d.x3d.jsail.CADGeometry.CADFaceObject

All Implemented Interfaces:

CADFace, X3DProductStructureChildNode, X3DChildNode, X3DNode, X3DBoundedObject
```
public class CADFaceObject
extends X3DConcreteNode
implements CADFace
```
X3D node tooltip: (X3D version 3.1 or later) [X3DProductStructureChildNode,X3DBoundedObject] CADFace holds geometry representing one face in a Computer-Aided Design (CAD) CADPart. CADFace can only contain a single Shape or LOD node (with containerField='shape').
- Warning: only zero or one Shape child is allowed to be active at one time.
- Hint: X3D for Advanced Modeling (X3D4AM) slideset
  http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/ComputerAidedDesignInterchangeProfile.pdf
- Warning: requires X3D profile='Full' or else include <component name='CADGeometry' level='2'/>
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:

X3D Abstract Specification: CADFace, X3D Tooltips: CADFace, X3D Scene Authoring Hints: Meshes

Field Summary

Fields
Modifier and Type	Field and Description
`static float[]`	`BBOXCENTER_DEFAULT_VALUE` SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
`static float[]`	`BBOXSIZE_DEFAULT_VALUE` SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).
`static java.lang.String`	`COMPONENT` String constant COMPONENT defines X3D component for the CADFace element: CADGeometry
`static java.lang.String`	`containerField_DEFAULT_VALUE` containerField describes typical field relationship of a node to its parent.
`static java.lang.String`	`fromField_METADATA` fromField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`fromField_NAME` fromField ROUTE name for SFString field named name.
`static java.lang.String`	`fromField_SHAPE` fromField ROUTE name for SFNode field named shape.
`static int`	`LEVEL` Integer constant LEVEL provides default X3D CADGeometry component level for this element: 2
`static java.lang.String`	`NAME` String constant NAME provides name of this element: CADFace.
`static java.lang.String`	`NAME_DEFAULT_VALUE` SFString field named name has default value equal to an empty string.
`static java.lang.String`	`toField_METADATA` toField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`toField_NAME` toField ROUTE name for SFString field named name.
`static java.lang.String`	`toField_SHAPE` toField ROUTE name for SFNode field named shape.

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
validationResult

Constructor Summary

Constructors
Constructor and Description
`CADFaceObject()` Constructor for CADFaceObject to initialize member variables with default values.
`CADFaceObject(java.lang.String DEFlabel)` Utility constructor that assigns DEF label after initializing member variables with default values.
`CADFaceObject(java.lang.String DEFlabel, java.lang.String newName)` Utility constructor that assigns both DEF label and name, after initializing member variables with default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CADFaceObject`	`addComments(CommentsBlock newCommentsBlock)` Add CommentsBlock to contained commentsList.
`CADFaceObject`	`addComments(java.lang.String newComment)` Add comment as String to contained commentsList.
`CADFaceObject`	`addComments(java.lang.String[] newComments)` Add comments as String[] array to contained commentsList.
`CADFaceObject`	`clearMetadata()` Utility method to clear SFNode value of metadata field.
`CADFaceObject`	`clearShape()` Utility method to clear SFNode value of shape field.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteNode`	`findNodeByDEF(java.lang.String DEFvalue)` Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
`java.lang.String`	`getAccessType(java.lang.String fieldName)` Indicate accessType corresponding to given fieldName.
`float[]`	`getBboxCenter()` Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
`float[]`	`getBboxSize()` Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
`java.lang.String`	`getComponent()` Defines X3D component for the CADFace element: CADGeometry
`int`	`getComponentLevel()` Provides default X3D component level for this element: 2
`java.lang.String`	`getContainerFieldDefault()` containerField describes typical field relationship of a node to its parent.
`java.lang.String`	`getElementName()` Provides name of this element: CADFace
`java.lang.String`	`getFieldType(java.lang.String fieldName)` Indicate type corresponding to given fieldName.
`ISObject`	`getIS()` Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`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.
`X3DNode`	`getShape()` Provide X3DNode instance (using a properly typed node) with acceptable node types limited to Shape\|LOD\|Transform, from inputOutput SFNode field shape.
`boolean`	`hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
`boolean`	`hasMetadata()` Indicate whether an object is available for inputOutput SFNode field metadata.
`boolean`	`hasNodeByDEF(java.lang.String DEFvalue)` Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
`boolean`	`hasShape()` Indicate whether an object is available for inputOutput SFNode field shape.
`void`	`initialize()` Initialize all member variables to default values.
`CADFaceObject`	`setBboxCenter(float[] newValue)` Assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
`CADFaceObject`	`setBboxCenter(float x, float y, float z)` Assign values to SFVec3f bboxCenter field, similar to `setBboxCenter(float[])`.
`CADFaceObject`	`setBboxCenter(SFVec3fObject newValue)` Assign typed object value to SFVec3f bboxCenter field, similar to `setBboxCenter(float[])`.
`CADFaceObject`	`setBboxSize(float[] newValue)` Assign 3-tuple float array within allowed range of [0,infinity), or default value [-1 -1 -1], to initializeOnly SFVec3f field named bboxSize.
`CADFaceObject`	`setBboxSize(float x, float y, float z)` Assign values to SFVec3f bboxSize field, similar to `setBboxSize(float[])`.
`CADFaceObject`	`setBboxSize(SFVec3fObject newValue)` Assign typed object value to SFVec3f bboxSize field, similar to `setBboxSize(float[])`.
`CADFaceObject`	`setCssClass(SFStringObject newValue)` Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`CADFaceObject`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`CADFaceObject`	`setDEF(SFStringObject newValue)` Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`CADFaceObject`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`CADFaceObject`	`setIS(ISObject newValue)` Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`CADFaceObject`	`setMetadata(ProtoInstanceObject newValue)` Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
`CADFaceObject`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`CADFaceObject`	`setName(SFStringObject newValue)` Assign typed object value to SFString name field, similar to `setName(String)`.
`CADFaceObject`	`setName(java.lang.String newValue)` Assign String value to inputOutput SFString field named name.
`CADFaceObject`	`setShape(ProtoInstanceObject newValue)` Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field shape.
`CADFaceObject`	`setShape(X3DNode newValue)` Assign X3DNode instance (using a properly typed node) with acceptable node types limited to Shape\|LOD\|Transform, to inputOutput SFNode field shape. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Shape.ShapeObject) \|\| (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Navigation.LODObject) \|\| (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Grouping.TransformObject); if (!
`CADFaceObject`	`setUSE(CADFaceObject DEFnode)` Assign a USE reference to another DEF node of same node type, similar to `setUSE(String)`.
`CADFaceObject`	`setUSE(SFStringObject newValue)` Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`CADFaceObject`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`java.lang.String`	`toStringClassicVRML(int indentLevel)` Recursive method to provide ClassicVRML string serialization.
`java.lang.String`	`toStringVRML97(int indentLevel)` Recursive method to provide VRML97 string serialization.
`java.lang.String`	`toStringX3D(int indentLevel)` Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
`java.lang.String`	`validate()` Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    String constant NAME provides name of this element: CADFace.
    
    See Also:
    
    Constant Field Values
  - COMPONENT
```
public static final java.lang.String COMPONENT
```
    String constant COMPONENT defines X3D component for the CADFace element: CADGeometry
    
    See Also:
    
    Constant Field Values
  - LEVEL
```
public static final int LEVEL
```
    Integer constant LEVEL provides default X3D CADGeometry component level for this element: 2
    
    See Also:
    
    Constant Field Values
  - BBOXCENTER_DEFAULT_VALUE
```
public static final float[] BBOXCENTER_DEFAULT_VALUE
```
    SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
  - BBOXSIZE_DEFAULT_VALUE
```
public static final float[] BBOXSIZE_DEFAULT_VALUE
```
    SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).
  - NAME_DEFAULT_VALUE
```
public static final java.lang.String NAME_DEFAULT_VALUE
```
    SFString field named name has default value equal to an empty string.
    
    See Also:
    
    Constant Field Values
  - containerField_DEFAULT_VALUE
```
public static final java.lang.String containerField_DEFAULT_VALUE
```
    containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
    
    See Also:
    
    X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
  - fromField_METADATA
```
public static final java.lang.String fromField_METADATA
```
    fromField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - toField_METADATA
```
public static final java.lang.String toField_METADATA
```
    toField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - fromField_NAME
```
public static final java.lang.String fromField_NAME
```
    fromField ROUTE name for SFString field named name.
    
    See Also:
    
    Constant Field Values
  - toField_NAME
```
public static final java.lang.String toField_NAME
```
    toField ROUTE name for SFString field named name.
    
    See Also:
    
    Constant Field Values
  - fromField_SHAPE
```
public static final java.lang.String fromField_SHAPE
```
    fromField ROUTE name for SFNode field named shape.
    
    See Also:
    
    Constant Field Values
  - toField_SHAPE
```
public static final java.lang.String toField_SHAPE
```
    toField ROUTE name for SFNode field named shape.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CADFaceObject
```
public CADFaceObject()
```
    Constructor for CADFaceObject to initialize member variables with default values.
  - CADFaceObject
```
public CADFaceObject(java.lang.String DEFlabel)
```
    Utility constructor that assigns DEF label after initializing member variables with default values.
    
    Parameters:
    
    DEFlabel - unique DEF name for this X3D node
  - CADFaceObject
```
public CADFaceObject(java.lang.String DEFlabel,
                     java.lang.String newName)
```
    Utility constructor that assigns both DEF label and name, after initializing member variables with default values.
    
    Parameters:
    
    DEFlabel - unique DEF name for this X3D node
    
    newName - name for this meta element
    
    See Also:
    
    X3D Tooltips: CADFaceObject
- Method Detail
  - getElementName
```
public final java.lang.String getElementName()
```
    Provides name of this element: CADFace
    
    Specified by:
    
    getElementName in class X3DConcreteElement
    
    Returns:
    
    name of this element
  - getComponent
```
public final java.lang.String getComponent()
```
    Defines X3D component for the CADFace element: CADGeometry
    
    Specified by:
    
    getComponent in class X3DConcreteElement
    
    Returns:
    
    X3D component for this element
  - getComponentLevel
```
public final int getComponentLevel()
```
    Provides default X3D component level for this element: 2
    
    Specified by:
    
    getComponentLevel in class X3DConcreteElement
    
    Returns:
    
    default X3D component level for this element
  - getFieldType
```
public java.lang.String getFieldType(java.lang.String fieldName)
```
    Indicate type corresponding to given fieldName.
    
    Specified by:
    
    getFieldType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D node
    
    Returns:
    
    X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
  - getAccessType
```
public java.lang.String getAccessType(java.lang.String fieldName)
```
    Indicate accessType corresponding to given fieldName.
    
    Specified by:
    
    getAccessType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D node
    
    Returns:
    
    X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
  - getContainerFieldDefault
```
public final java.lang.String getContainerFieldDefault()
```
    containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
    
    Specified by:
    
    getContainerFieldDefault in class X3DConcreteNode
    
    Returns:
    
    default containerField value
    
    See Also:
    
    X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
  - initialize
```
public final void initialize()
```
    Initialize all member variables to default values.
    
    Overrides:
    
    initialize in class X3DConcreteNode
  - getBboxCenter
```
public float[] getBboxCenter()
```
    Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
    
    Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.
    - Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
    - Hint: X3D Architecture, 10.2.2 Bounding boxes
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
    Specified by:
    
    getBboxCenter in interface CADFace
    
    Specified by:
    
    getBboxCenter in interface X3DBoundedObject
    
    Returns:
    
    value of bboxCenter field
  - setBboxCenter
```
public CADFaceObject setBboxCenter(float[] newValue)
```
    Assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
    
    Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system. Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size. Hint: X3D Architecture, 10.2.2 Bounding boxes http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
    
    Specified by:
    
    setBboxCenter in interface CADFace
    
    Specified by:
    
    setBboxCenter in interface X3DBoundedObject
    
    Parameters:
    
    newValue - is new value for the bboxCenter field.
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setBboxCenter
```
public CADFaceObject setBboxCenter(SFVec3fObject newValue)
```
    Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
    
    Parameters:
    
    newValue - is new value for the bboxCenter field.
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setBboxCenter
```
public CADFaceObject setBboxCenter(float x,
                                   float y,
                                   float z)
```
    Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
    
    Parameters:
    
    x - first component
    
    y - second component
    
    z - third component
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getBboxSize
```
public float[] getBboxSize()
```
    Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
    
    Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.
    - Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
    - Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
    - Hint: X3D Architecture, 10.2.2 Bounding boxes
      http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
    Specified by:
    
    getBboxSize in interface CADFace
    
    Specified by:
    
    getBboxSize in interface X3DBoundedObject
    
    Returns:
    
    value of bboxSize field
  - setBboxSize
```
public CADFaceObject setBboxSize(float[] newValue)
```
    Assign 3-tuple float array within allowed range of [0,infinity), or default value [-1 -1 -1], to initializeOnly SFVec3f field named bboxSize.
    
    Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint. Hint: can be useful for collision computations or inverse-kinematics (IK) engines. Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size. Hint: X3D Architecture, 10.2.2 Bounding boxes http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
    
    Specified by:
    
    setBboxSize in interface CADFace
    
    Specified by:
    
    setBboxSize in interface X3DBoundedObject
    
    Parameters:
    
    newValue - is new value for the bboxSize field.
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setBboxSize
```
public CADFaceObject setBboxSize(SFVec3fObject newValue)
```
    Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).
    
    Parameters:
    
    newValue - is new value for the bboxSize field.
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setBboxSize
```
public CADFaceObject setBboxSize(float x,
                                 float y,
                                 float z)
```
    Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
    
    Parameters:
    
    x - first component
    
    y - second component
    
    z - third component
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getMetadata
```
public X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface CADFace
    
    Specified by:
    
    getMetadata in interface X3DProductStructureChildNode
    
    Specified by:
    
    getMetadata in interface X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
public CADFaceObject setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface CADFace
    
    Specified by:
    
    setMetadata in interface X3DProductStructureChildNode
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
  - clearMetadata
```
public CADFaceObject clearMetadata()
```
    Utility method to clear SFNode value of metadata field.
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setMetadata
```
public CADFaceObject setMetadata(ProtoInstanceObject newValue)
```
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setMetadata(X3DMetadataObject)
  - hasMetadata
```
public boolean hasMetadata()
```
    Indicate whether an object is available for inputOutput SFNode field metadata.
    
    Returns:
    
    whether a properly typed node or ProtoInstance or CommentsBlock is available.
    
    See Also:
    
    getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - getName
```
public java.lang.String getName()
```
    Provide String value from inputOutput SFString field named name.
    
    Tooltip: Optional name for this particular CAD node.
    - Warning: name is not included 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 CADFace
    
    Specified by:
    
    getName in interface X3DProductStructureChildNode
    
    Returns:
    
    value of name field
  - setName
```
public final CADFaceObject setName(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named name.
    
    Tooltip: Optional name for this particular CAD node. Warning: name is not included 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
    
    @see X3D Scene Authoring Hints: Naming Conventions
    
    Specified by:
    
    setName in interface CADFace
    
    Specified by:
    
    setName in interface X3DProductStructureChildNode
    
    Parameters:
    
    newValue - is new value for the name field.
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setName
```
public CADFaceObject setName(SFStringObject newValue)
```
    Assign typed object value to SFString name field, similar to setName(String).
    
    Parameters:
    
    newValue - is new value for the name field.
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getShape
```
public X3DNode getShape()
```
    Provide X3DNode instance (using a properly typed node) with acceptable node types limited to Shape|LOD|Transform, from inputOutput SFNode field shape.
    Specified by:
    
    getShape in interface CADFace
    
    Returns:
    
    value of shape field
    
    See Also:
    Tooltip: [X3DShapeNode|LOD|Transform] Contained Shape for this CADPart. Warning: if LOD or Transform are used, only zero or one Shape child is allowed to be active at one time.
  - setShape
```
public CADFaceObject setShape(X3DNode newValue)
```
    Assign X3DNode instance (using a properly typed node) with acceptable node types limited to Shape|LOD|Transform, to inputOutput SFNode field shape. // newValueInstanceAcceptableNodeTypesTest checks are needed for methods that override/subset X3DNode interfaces #1 boolean isNodeTypeAllowed = (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Shape.ShapeObject) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Navigation.LODObject) || (((X3DConcreteNode)newValue) instanceof org.web3d.x3d.jsail.Grouping.TransformObject); if (!isNodeTypeAllowed) { throw new org.web3d.x3d.sai.InvalidFieldValueException("X3DNode newValue is not instanceof " + "acceptableNodeTypes Shape|LOD|Transform; newValue=" + newValue); }
    
    Specified by:
    
    setShape in interface CADFace
    
    Parameters:
    
    newValue - is new value for the shape field.
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    Tooltip: [X3DShapeNode|LOD|Transform] Contained Shape for this CADPart. Warning: if LOD or Transform are used, only zero or one Shape child is allowed to be active at one time.
  - clearShape
```
public CADFaceObject clearShape()
```
    Utility method to clear SFNode value of shape field.
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setShape
```
public CADFaceObject setShape(ProtoInstanceObject newValue)
```
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field shape.
    
    Parameters:
    
    newValue - is new value for the shape field.
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setShape(X3DNode)
  - hasShape
```
public boolean hasShape()
```
    Indicate whether an object is available for inputOutput SFNode field shape.
    
    Returns:
    
    whether a properly typed node or ProtoInstance or CommentsBlock is available.
    
    See Also:
    
    getShape(), getShapeProtoInstance()
  - setDEF
```
public final CADFaceObject 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 CADFace
    
    Specified by:
    
    setDEF in interface X3DProductStructureChildNode
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Specified by:
    
    setDEF in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
public CADFaceObject setDEF(SFStringObject newValue)
```
    Assign typed object value to SFString DEF field, similar to setDEF(String).
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public final CADFaceObject 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 CADFace
    
    Specified by:
    
    setUSE in interface X3DProductStructureChildNode
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Specified by:
    
    setUSE in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public CADFaceObject setUSE(SFStringObject newValue)
```
    Assign typed object value to SFString USE field, similar to setUSE(String).
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
public final CADFaceObject 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 CADFace
    
    Specified by:
    
    setCssClass in interface X3DProductStructureChildNode
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Specified by:
    
    setCssClass in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    W3C Cascading Style Sheets
  - setCssClass
```
public CADFaceObject setCssClass(SFStringObject newValue)
```
    Assign typed object value to SFString cssClass field, similar to setCssClass(String).
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setIS
```
public CADFaceObject setIS(ISObject newValue)
```
    Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    setIS in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the description field.
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - getIS
```
public ISObject getIS()
```
    Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    getIS in class X3DConcreteNode
    
    Returns:
    
    current ISObject, if any.
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - setUSE
```
public CADFaceObject setUSE(CADFaceObject DEFnode)
```
    Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
    
    Warning: note that 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.
    
    Parameters:
    
    DEFnode - must have a DEF value defined
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addComments
```
public CADFaceObject addComments(java.lang.String newComment)
```
    Add comment as String to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComment - initial value
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public CADFaceObject addComments(java.lang.String[] newComments)
```
    Add comments as String[] array to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComments - array of comments
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public CADFaceObject addComments(CommentsBlock newCommentsBlock)
```
    Add CommentsBlock to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newCommentsBlock - block of comments to add
    
    Returns:
    
    CADFaceObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - toStringX3D
```
public java.lang.String toStringX3D(int indentLevel)
```
    Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
    
    Specified by:
    
    toStringX3D in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    X3D string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form
  - toStringClassicVRML
```
public java.lang.String toStringClassicVRML(int indentLevel)
```
    Recursive method to provide ClassicVRML string serialization.
    
    Specified by:
    
    toStringClassicVRML in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    ClassicVRML string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
  - toStringVRML97
```
public java.lang.String toStringVRML97(int indentLevel)
```
    Recursive method to provide VRML97 string serialization.
    
    Specified by:
    
    toStringVRML97 in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    VRML97 string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue,
                                                 java.lang.String elementName)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasElementByNameValue
```
public boolean hasElementByNameValue(java.lang.String nameValue,
                                     java.lang.String elementName)
```
    Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findElementByNameValue(String, String)
  - findNodeByDEF
```
public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same DEF, this method does not handle that case.
    
    Specified by:
    
    findNodeByDEF in class X3DConcreteElement
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found node, null otherwise
    
    See Also:
    
    findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasNodeByDEF
```
public boolean hasNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findNodeByDEF(String)
  - validate
```
public java.lang.String validate()
```
    Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
    
    Specified by:
    
    validate in class X3DConcreteElement
    
    Returns:
    
    validation results (if any)

Class CADFaceObject

Field Summary

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Constructor Summary

Method Summary

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Methods inherited from class java.lang.Object

Field Detail

NAME

COMPONENT

LEVEL

BBOXCENTER_DEFAULT_VALUE

BBOXSIZE_DEFAULT_VALUE

NAME_DEFAULT_VALUE

containerField_DEFAULT_VALUE

fromField_METADATA

toField_METADATA

fromField_NAME

toField_NAME

fromField_SHAPE

toField_SHAPE

Constructor Detail

CADFaceObject

CADFaceObject

CADFaceObject

Method Detail

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

getContainerFieldDefault

initialize

getBboxCenter

setBboxCenter

setBboxCenter

setBboxCenter

getBboxSize

setBboxSize

setBboxSize

setBboxSize

getMetadata

setMetadata

clearMetadata

setMetadata

hasMetadata

getName

setName

setName

getShape

setShape

clearShape

setShape

hasShape

setDEF

setDEF

setUSE

setUSE

setCssClass

setCssClass

setIS

getIS

setUSE

addComments

addComments

addComments

toStringX3D

toStringClassicVRML

toStringVRML97

findElementByNameValue

findElementByNameValue

hasElementByNameValue

findNodeByDEF

hasNodeByDEF

validate