Interface CADFace

All Superinterfaces:
X3DBoundedObject, X3DChildNode, X3DNode, X3DProductStructureChildNode
All Known Implementing Classes:
CADFaceObject

public interface CADFace
extends X3DProductStructureChildNode, X3DBoundedObject
CADFace holds geometry representing one face in a Computer-Aided Design (CAD) CADPart.

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').
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification: TODO, X3D Abstract Specification: CADFace, X3D Tooltips: CADFace, X3D Scene Authoring Hints: Meshes
  • Method Summary

    Modifier and Type Method Description
    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.
    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.
    CADFace setBboxCenter​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
    CADFace setBboxSize​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
    CADFace setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    CADFace setName​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named name.
    CADFace setShape​(X3DNode newValue)
    Accessor method to assign X3DNode instance (using a properly typed node) 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 (!
  • Method Details

    • getBboxCenter

      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 X3DBoundedObject
      Returns:
      value of bboxCenter field
    • setBboxCenter

      CADFace 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 X3DBoundedObject
      Parameters:
      newValue - is new value for the bboxCenter field.
      Returns:
      CADFace - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getBboxSize

      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 X3DBoundedObject
      Returns:
      value of bboxSize field
    • setBboxSize

      CADFace 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 X3DBoundedObject
      Parameters:
      newValue - is new value for the bboxSize field.
      Returns:
      CADFace - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getMetadata

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

      CADFace setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DProductStructureChildNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      CADFace - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • getName

      java.lang.String getName()
      Provide String value from inputOutput SFString field named name.

      Tooltip: Optional name for this particular CAD node.
      Specified by:
      getName in interface X3DProductStructureChildNode
      Returns:
      value of name field
    • setName

      CADFace 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 X3DProductStructureChildNode
      Parameters:
      newValue - is new value for the name field.
      Returns:
      CADFace - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getShape

      X3DNode getShape()
      Provide X3DNode instance (using a properly typed node) with acceptable node types limited to Shape|LOD|Transform, from inputOutput SFNode field shape.

      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.
      Returns:
      value of shape field
    • setShape

      CADFace setShape​(X3DNode newValue)
      Accessor method to assign X3DNode instance (using a properly typed node) 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); }

      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.
      Parameters:
      newValue - is new value for the shape field.
      Returns:
      CADFace - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).