All Superinterfaces:: X3DBoundedObject, X3DChildNode, X3DGroupingNode, X3DNode, X3DProductStructureChildNode

All Known Implementing Classes:: CADPart

public interface CADPart extends X3DProductStructureChildNode, X3DGroupingNode

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.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. CADPart node tooltip: (X3D version 3.1 or later) [X3DGroupingNode,X3DProductStructureChildNode,X3DVisibleObject] 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.

Hint: CADPart is often a child of CADAssembly node.
Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/ComputerAidedDesignInterchangeProfile.pdf
Warning: requires X3D profile='Full' or else include <component name='CADGeometry' level='2'/>

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

Method Summary

Modifier and Type

Method

Description

void

addChildren(X3DNode[] newValue)

Add array of children nodes to array of existing nodes (if any).

float[]

getBboxCenter()

Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.

boolean

getBboxDisplay()

Provide boolean value from inputOutput SFBool field named bboxDisplay.

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.

float[]

getCenter()

Provide array of 3-tuple float results from inputOutput SFVec3f field named center.

X3DNode[]

getChildren()

Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field children.

X3DMetadataObject

getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

String

getName()

Provide String value from inputOutput SFString field named name.

float[]

getRotation()

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

float[]

getScale()

Provide array of 3-tuple float results from inputOutput SFVec3f field named scale.

float[]

getScaleOrientation()

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

float[]

getTranslation()

Provide array of 3-tuple float results from inputOutput SFVec3f field named translation.

boolean

getVisible()

Provide boolean value from inputOutput SFBool field named visible.

CADPart

setBboxCenter(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.

CADPart

setBboxDisplay(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.

CADPart

setBboxSize(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.

CADPart

setCenter(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named center.

void

setChildren(X3DNode newValue)

Set single children node, replacing prior array of existing nodes (if any).

CADPart

setChildren(X3DNode[] newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.

CADPart

setMetadata(X3DMetadataObject newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

CADPart

setName(String newValue)

Accessor method to assign String value to inputOutput SFString field named name.

CADPart

setRotation(float[] newValue)

Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named rotation.

CADPart

setScale(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named scale.

CADPart

setScaleOrientation(float[] newValue)

Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named scaleOrientation.

CADPart

setTranslation(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named translation.

CADPart

setVisible(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named visible.

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.
  
  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 https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
  
  Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
  
  Specified by:
  
  getBboxCenter in interface X3DBoundedObject
  
  Specified by:
  
  getBboxCenter in interface X3DGroupingNode
  
  Returns:
  
  value of bboxCenter field
- setBboxCenter
  CADPart 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.
  
  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 https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
  
  Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
  
  Specified by:
  
  setBboxCenter in interface X3DBoundedObject
  
  Specified by:
  
  setBboxCenter in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new value for the bboxCenter field.
  
  Returns:
  
  CADPart - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getBboxDisplay
  boolean getBboxDisplay()
  
  Provide boolean value from inputOutput SFBool field named bboxDisplay.
  
  Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.
  
  Hint: the bounding box is displayed regardless of whether contained content is visible.
  
  Specified by:
  
  getBboxDisplay in interface X3DBoundedObject
  
  Specified by:
  
  getBboxDisplay in interface X3DGroupingNode
  
  Returns:
  
  value of bboxDisplay field
- setBboxDisplay
  CADPart setBboxDisplay(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.
  
  Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.
  
  Hint: the bounding box is displayed regardless of whether contained content is visible.
  
  Specified by:
  
  setBboxDisplay in interface X3DBoundedObject
  
  Specified by:
  
  setBboxDisplay in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new value for the bboxDisplay field.
  
  Returns:
  
  CADPart - 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: or [0,+infinity) 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 https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
  
  Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
  
  Specified by:
  
  getBboxSize in interface X3DBoundedObject
  
  Specified by:
  
  getBboxSize in interface X3DGroupingNode
  
  Returns:
  
  value of bboxSize field
- setBboxSize
  CADPart setBboxSize(float[] newValue)
  
  Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
  
  Tooltip: or [0,+infinity) 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 https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#BoundingBoxes
  
  Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#X3DBoundedObject
  
  Specified by:
  
  setBboxSize in interface X3DBoundedObject
  
  Specified by:
  
  setBboxSize in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new value for the bboxSize field.
  
  Returns:
  
  CADPart - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getCenter
  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.
  
  Returns:
  
  value of center field
- setCenter
  CADPart 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.
  
  Parameters:
  
  newValue - is new value for the center field.
  
  Returns:
  
  CADPart - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getChildren
  X3DNode[] getChildren()
  
  Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) 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, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#GroupingAndChildrenNodes
  
  Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to CADFace.
  
  Specified by:
  
  getChildren in interface X3DGroupingNode
  
  Returns:
  
  value of children field
  
  See Also:
  
  CADFace
- setChildren
  CADPart setChildren(X3DNode[] newValue)
  
  Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) 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, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/grouping.html#GroupingAndChildrenNodes
  
  Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to CADFace.
  
  Specified by:
  
  setChildren in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new value for the children field.
  
  Returns:
  
  CADPart - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- addChildren
  
  void addChildren(X3DNode[] newValue)
  
  Add array of children nodes to array of existing nodes (if any).
  
  Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to CADFace.
  
  Specified by:
  
  addChildren in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new value array to be appended the children field.
- setChildren
  
  void setChildren(X3DNode newValue)
  
  Set single children node, replacing prior array of existing nodes (if any).
  
  Specified by:
  
  setChildren in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new node for the children field
- getMetadata
  X3DMetadataObject getMetadata()
  
  Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
  
  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:
  
  X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  CADPart setMetadata(X3DMetadataObject newValue)
  
  Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
  
  Specified by:
  
  setMetadata in interface X3DChildNode
  
  Specified by:
  
  setMetadata in interface X3DGroupingNode
  
  Specified by:
  
  setMetadata in interface X3DNode
  
  Specified by:
  
  setMetadata in interface X3DProductStructureChildNode
  
  Parameters:
  
  newValue - is new value for the metadata field.
  
  Returns:
  
  CADPart - 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
  String getName()
  
  Provide String value from inputOutput SFString field named name.
  
  Tooltip: Optional name for this particular CAD node.
  
  Warning: name field is not included if this instance is a USE node, in order to avoid potential mismatches.
  
  Hint: well-defined names can simplify design and debugging through improved author understanding.
  
  Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
  
  Specified by:
  
  getName in interface X3DProductStructureChildNode
  
  Returns:
  
  value of name field
- setName
  CADPart setName(String newValue)
  
  Accessor method to assign String value to inputOutput SFString field named name.
  
  Tooltip: Optional name for this particular CAD node.
  
  Warning: name field is not included if this instance is a USE node, in order to avoid potential mismatches.
  
  Hint: well-defined names can simplify design and debugging through improved author understanding.
  
  Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
  
  @see X3D Scene Authoring Hints: Naming Conventions
  
  Specified by:
  
  setName in interface X3DProductStructureChildNode
  
  Parameters:
  
  newValue - is new value for the name field.
  
  Returns:
  
  CADPart - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getRotation
  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.
  
  Returns:
  
  value of rotation field
- setRotation
  CADPart 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.
  
  Parameters:
  
  newValue - is new value for the rotation field.
  
  Returns:
  
  CADPart - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getScale
  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.
  
  Returns:
  
  value of scale field
- setScale
  CADPart 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.
  
  Parameters:
  
  newValue - is new value for the scale field.
  
  Returns:
  
  CADPart - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getScaleOrientation
  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.
  
  Returns:
  
  value of scaleOrientation field
- setScaleOrientation
  CADPart 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.
  
  Parameters:
  
  newValue - is new value for the scaleOrientation field.
  
  Returns:
  
  CADPart - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getTranslation
  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.
  
  Returns:
  
  value of translation field
- setTranslation
  CADPart 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.
  
  Parameters:
  
  newValue - is new value for the translation field.
  
  Returns:
  
  CADPart - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getVisible
  boolean getVisible()
  
  Provide boolean value from inputOutput SFBool field named visible.
  
  Tooltip: Whether or not renderable content within this node is visually displayed.
  
  Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
  
  Hint: content must be visible to be collidable and to be pickable.
  
  Specified by:
  
  getVisible in interface X3DBoundedObject
  
  Specified by:
  
  getVisible in interface X3DGroupingNode
  
  Returns:
  
  value of visible field
- setVisible
  CADPart setVisible(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named visible.
  
  Tooltip: Whether or not renderable content within this node is visually displayed.
  
  Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
  
  Hint: content must be visible to be collidable and to be pickable.
  
  Specified by:
  
  setVisible in interface X3DBoundedObject
  
  Specified by:
  
  setVisible in interface X3DGroupingNode
  
  Parameters:
  
  newValue - is new value for the visible field.
  
  Returns:
  
  CADPart - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface CADPart

Method Summary

Method Details

getBboxCenter

setBboxCenter

getBboxDisplay

setBboxDisplay

getBboxSize

setBboxSize

getCenter

setCenter

getChildren

setChildren

addChildren

setChildren

getMetadata

setMetadata

getName

setName

getRotation

setRotation

getScale

setScale

getScaleOrientation

setScaleOrientation

getTranslation

setTranslation

getVisible

setVisible