Class CADPartObject

java.lang.Object
All Implemented Interfaces:
CADPart, X3DProductStructureChildNode, X3DChildNode, X3DNode, X3DBoundedObject, X3DGroupingNode

public class CADPartObject
extends X3DConcreteNode
implements CADPart
CADPart is an atomic part that defines both coordinate-system location and the faces that constitute a part in a Computer-Aided Design (CAD) model.

X3D node tooltip: (X3D version 3.1 or later) [X3DGroupingNode,X3DProductStructureChildNode] CADPart is an atomic part that defines both coordinate-system location and the faces that constitute a part in a Computer-Aided Design (CAD) model. CADPart contains multiple CADFace nodes that make up a single part.
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: CADPart, X3D Tooltips: CADPart, X3D Scene Authoring Hints
  • Field Details

  • Constructor Details

    • CADPartObject

      public CADPartObject()
      Constructor for CADPartObject to initialize member variables with default values.
    • CADPartObject

      public CADPartObject​(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
    • CADPartObject

      public CADPartObject​(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: CADPartObject
  • Method Details

    • getElementName

      public final java.lang.String getElementName()
      Provides name of this element: CADPart
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the CADPart 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.
      Specified by:
      getBboxCenter in interface CADPart
      Specified by:
      getBboxCenter in interface X3DBoundedObject
      Specified by:
      getBboxCenter in interface X3DGroupingNode
      Returns:
      value of bboxCenter field
    • setBboxCenter

      public CADPartObject setBboxCenter​(float[] newValue)
      Accessor method to 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.
      Specified by:
      setBboxCenter in interface CADPart
      Specified by:
      setBboxCenter in interface X3DBoundedObject
      Specified by:
      setBboxCenter in interface X3DGroupingNode
      Parameters:
      newValue - is new value for the bboxCenter field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxCenter

      public CADPartObject 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:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxCenter

      public CADPartObject 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:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxCenter

      public CADPartObject setBboxCenter​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxCenter

      public CADPartObject setBboxCenter​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxCenter(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      CADPartObject - 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.
      Specified by:
      getBboxSize in interface CADPart
      Specified by:
      getBboxSize in interface X3DBoundedObject
      Specified by:
      getBboxSize in interface X3DGroupingNode
      Returns:
      value of bboxSize field
    • setBboxSize

      public CADPartObject setBboxSize​(float[] newValue)
      Accessor method to assign 3-tuple float array 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.
      Specified by:
      setBboxSize in interface CADPart
      Specified by:
      setBboxSize in interface X3DBoundedObject
      Specified by:
      setBboxSize in interface X3DGroupingNode
      Parameters:
      newValue - is new value for the bboxSize field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

      public CADPartObject 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:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

      public CADPartObject 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:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

      public CADPartObject setBboxSize​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

      public CADPartObject setBboxSize​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxSize(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCenter

      public float[] getCenter()
      Provide array of 3-tuple float results from inputOutput SFVec3f field named center.

      Tooltip: Translation offset from origin of local coordinate system, applied prior to rotation or scaling.
      • Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
      Specified by:
      getCenter in interface CADPart
      Returns:
      value of center field
    • setCenter

      public CADPartObject setCenter​(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named center.

      Tooltip: Translation offset from origin of local coordinate system, applied prior to rotation or scaling.
      • Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
      Specified by:
      setCenter in interface CADPart
      Parameters:
      newValue - is new value for the center field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenter

      public CADPartObject setCenter​(SFVec3fObject newValue)
      Assign typed object value to SFVec3f center field, similar to setCenter(float[]).
      Parameters:
      newValue - is new value for the center field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenter

      public CADPartObject setCenter​(float x, float y, float z)
      Assign values to SFVec3f center field, similar to setCenter(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenter

      public CADPartObject setCenter​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setCenter(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCenter

      public CADPartObject setCenter​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setCenter(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getChildren

      public X3DNode[] getChildren()
      Provide array of CADFaceObject results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.

      Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.
      • Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
      • Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
      • Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
      • Hint: X3D Architecture 10.2.1 Grouping and children node types, http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to CADFace.
      Specified by:
      getChildren in interface CADPart
      Specified by:
      getChildren in interface X3DGroupingNode
      Returns:
      value of children field
      See Also:
      CADFaceObject
    • getChildrenList

      public java.util.ArrayList<X3DNode> getChildrenList()
      Utility method to get ArrayList value of MFNode children field, similar to getChildren().
      Returns:
      value of children field
    • setChildren

      public CADPartObject setChildren​(X3DNode[] newValue)
      Accessor method to assign CADFaceObject array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.

      Tooltip: [X3DChildNode] Grouping nodes contain an ordered list of children nodes.
      • Hint: Each grouping node defines a coordinate space for its children, relative to the coordinate space of its parent node. Thus transformations accumulate down the scene graph hierarchy.
      • Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
      • Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
      • Hint: X3D Architecture 10.2.1 Grouping and children node types, http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#GroupingAndChildrenNodes


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to CADFace.
      Specified by:
      setChildren in interface CADPart
      Specified by:
      setChildren in interface X3DGroupingNode
      Parameters:
      newValue - is new value for the children field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setChildren

      public CADPartObject setChildren​(java.util.ArrayList<CADFaceObject> newValue)
      Assign ArrayList value of MFNode children field, similar to setChildren(X3DNode[]).
      Parameters:
      newValue - is new value for the children field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addChildren

      public void addChildren​(CADFaceObject newValue)
      Add single node to existing array of children nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to CADFace and ProtoInstance.
      Parameters:
      newValue - is new value to be appended the children field.
    • addChildren

      public CADPartObject addChildren​(ProtoInstanceObject newValue)
      Add single ProtoInstanceObject (with appropriate node type and containerField value) to MFNode array for children field.

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.
      Parameters:
      newValue - is new value to be appended the parts field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addChild

      public CADPartObject addChild​(CADFace newValue)
      Utility method to add single child element to contained list of existing children nodes (if any).
      Parameters:
      newValue - is new node value to be appended the children field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addChildren

      public 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 CADFace.
      Specified by:
      addChildren in interface CADPart
      Specified by:
      addChildren in interface X3DGroupingNode
      Parameters:
      newValue - is new value array to be appended the children field.
    • setChildren

      public void setChildren​(X3DNode newValue)
      Set single children node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to CADFace.
      Specified by:
      setChildren in interface CADPart
      Specified by:
      setChildren in interface X3DGroupingNode
      Parameters:
      newValue - is new node for the children field (restricted to CADFace)
    • clearChildren

      public CADPartObject clearChildren()
      Utility method to clear MFNode value of children field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasChildren

      public boolean hasChildren()
      Indicate whether an object is available for inputOutput MFNode field children.
      Returns:
      whether a properly typed node or ProtoInstance array or CommentsBlock is available.
      See Also:
      getChildren()
    • getIS

      public ISObject getIS()
      Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • setIS

      public CADPartObject setIS​(ISObject newValue)
      Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      CADPartObject - 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
    • clearIS

      public CADPartObject clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasIS

      public boolean hasIS()
      Indicate whether an object is available for inputOutput SFNode field IS.
      Returns:
      whether a concrete statement or CommentsBlock is available.
      See Also:
      getIS()
    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface CADPart
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DGroupingNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DProductStructureChildNode
      Returns:
      value of metadata field
      See Also:
      getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public CADPartObject setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface CADPart
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DGroupingNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DProductStructureChildNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      CADPartObject - 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 CADPartObject clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setMetadata

      public CADPartObject 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:
      CADPartObject - 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.
      Specified by:
      getName in interface CADPart
      Specified by:
      getName in interface X3DProductStructureChildNode
      Returns:
      value of name field
    • setName

      public final CADPartObject setName​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named name.

      Tooltip: Optional name for this particular CAD node.

      @see X3D Scene Authoring Hints: Naming Conventions
      Specified by:
      setName in interface CADPart
      Specified by:
      setName in interface X3DProductStructureChildNode
      Parameters:
      newValue - is new value for the name field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setName

      public CADPartObject 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:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getRotation

      public float[] getRotation()
      Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named rotation.

      Tooltip: Orientation (axis, angle in radians) of children relative to local coordinate system.
      • Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
      Specified by:
      getRotation in interface CADPart
      Returns:
      value of rotation field
    • setRotation

      public CADPartObject setRotation​(float[] newValue)
      Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named rotation.

      Tooltip: Orientation (axis, angle in radians) of children relative to local coordinate system.
      • Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
      Specified by:
      setRotation in interface CADPart
      Parameters:
      newValue - is new value for the rotation field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRotation

      public CADPartObject setRotation​(SFRotationObject newValue)
      Assign typed object value to SFRotation rotation field, similar to setRotation(float[]).
      Parameters:
      newValue - is new value for the rotation field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRotation

      public CADPartObject setRotation​(float x, float y, float z, float angleRadians)
      Assign values to SFRotation rotation field, similar to setRotation(float[]).
      Parameters:
      x - first component of axis
      y - second component of axis
      z - third component of axis
      angleRadians - fourth component of rotation around axis
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRotation

      public CADPartObject setRotation​(double x, double y, double z, double angleRadians)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setRotation(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      angleRadians - fourth component
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRotation

      public CADPartObject setRotation​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setRotation(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getScale

      public float[] getScale()
      Provide array of 3-tuple float results from inputOutput SFVec3f field named scale.

      Tooltip: Non-uniform x-y-z scale of child coordinate system, adjusted by center and scaleOrientation.
      • Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
      Specified by:
      getScale in interface CADPart
      Returns:
      value of scale field
    • setScale

      public CADPartObject setScale​(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named scale.

      Tooltip: Non-uniform x-y-z scale of child coordinate system, adjusted by center and scaleOrientation.
      • Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
      Specified by:
      setScale in interface CADPart
      Parameters:
      newValue - is new value for the scale field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setScale

      public CADPartObject setScale​(SFVec3fObject newValue)
      Assign typed object value to SFVec3f scale field, similar to setScale(float[]).
      Parameters:
      newValue - is new value for the scale field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setScale

      public CADPartObject setScale​(float x, float y, float z)
      Assign values to SFVec3f scale field, similar to setScale(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setScale

      public CADPartObject setScale​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setScale(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setScale

      public CADPartObject setScale​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setScale(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getScaleOrientation

      public float[] getScaleOrientation()
      Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named scaleOrientation.

      Tooltip: Preliminary rotation of coordinate system before scaling (to allow scaling around arbitrary orientations).
      • Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
      Specified by:
      getScaleOrientation in interface CADPart
      Returns:
      value of scaleOrientation field
    • setScaleOrientation

      public CADPartObject setScaleOrientation​(float[] newValue)
      Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named scaleOrientation.

      Tooltip: Preliminary rotation of coordinate system before scaling (to allow scaling around arbitrary orientations).
      • Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
      Specified by:
      setScaleOrientation in interface CADPart
      Parameters:
      newValue - is new value for the scaleOrientation field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setScaleOrientation

      public CADPartObject setScaleOrientation​(SFRotationObject newValue)
      Assign typed object value to SFRotation scaleOrientation field, similar to setScaleOrientation(float[]).
      Parameters:
      newValue - is new value for the scaleOrientation field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setScaleOrientation

      public CADPartObject setScaleOrientation​(float x, float y, float z, float angleRadians)
      Assign values to SFRotation scaleOrientation field, similar to setScaleOrientation(float[]).
      Parameters:
      x - first component of axis
      y - second component of axis
      z - third component of axis
      angleRadians - fourth component of rotation around axis
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setScaleOrientation

      public CADPartObject setScaleOrientation​(double x, double y, double z, double angleRadians)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setScaleOrientation(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      angleRadians - fourth component
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setScaleOrientation

      public CADPartObject setScaleOrientation​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setScaleOrientation(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getTranslation

      public float[] getTranslation()
      Provide array of 3-tuple float results from inputOutput SFVec3f field named translation.

      Tooltip: Position (x, y, z in meters) of children relative to local coordinate system.
      • Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
      Specified by:
      getTranslation in interface CADPart
      Returns:
      value of translation field
    • setTranslation

      public CADPartObject setTranslation​(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named translation.

      Tooltip: Position (x, y, z in meters) of children relative to local coordinate system.
      • Hint: The order of operation is first apply the center offset, then scaleOrientation and scale, then rotation, then restore the center offset, then translation.
      Specified by:
      setTranslation in interface CADPart
      Parameters:
      newValue - is new value for the translation field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTranslation

      public CADPartObject setTranslation​(SFVec3fObject newValue)
      Assign typed object value to SFVec3f translation field, similar to setTranslation(float[]).
      Parameters:
      newValue - is new value for the translation field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTranslation

      public CADPartObject setTranslation​(float x, float y, float z)
      Assign values to SFVec3f translation field, similar to setTranslation(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTranslation

      public CADPartObject setTranslation​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setTranslation(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTranslation

      public CADPartObject setTranslation​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setTranslation(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getDEF

      public java.lang.String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

      public final CADPartObject setDEF​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

      public CADPartObject 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:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getUSE

      public java.lang.String getUSE()
      Provide String value from 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.
      Overrides:
      getUSE in class X3DConcreteNode
      Returns:
      value of USE field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setUSE

      public final CADPartObject setUSE​(java.lang.String newValue)
      Accessor method to 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 class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public CADPartObject 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:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCssClass

      public java.lang.String getCssClass()
      Provide String value from 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
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public final CADPartObject setCssClass​(java.lang.String newValue)
      Accessor method to 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 class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      CADPartObject - 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 CADPartObject 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:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public CADPartObject setUSE​(CADPartObject 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:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

      public CADPartObject addComments​(java.lang.String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public CADPartObject 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:
      CADPartObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public CADPartObject addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      CADPartObject - 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, X3D Canonicalization (C14N) Tool
    • 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)