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

All Known Implementing Classes:: Viewport

public interface Viewport extends X3DViewportNode

Viewport is a Grouping node that can contain most nodes.

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. Viewport node tooltip: (X3D version 3.2 or later) [X3DViewportNode, X3DBoundedObject,X3DVisibleObject] Viewport is a Grouping node that can contain most nodes. Viewport specifies a set of rectangular clip boundaries against which the children nodes are clipped as they are rendered. *

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.

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.

float[]

getClipBoundary()

Provide array of float results within allowed range of [0,1] from inputOutput MFFloat field named clipBoundary.

X3DMetadataObject

getMetadata()

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

boolean

getVisible()

Provide boolean value from inputOutput SFBool field named visible.

Viewport

setBboxCenter(float[] newValue)

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

Viewport

setBboxDisplay(boolean newValue)

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

Viewport

setBboxSize(float[] newValue)

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

void

setChildren(X3DNode newValue)

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

Viewport

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.

Viewport

setClipBoundary(float[] newValue)

Accessor method to assign float array to inputOutput MFFloat field named clipBoundary.

Viewport

setMetadata(X3DMetadataObject newValue)

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

Viewport

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
  
  Specified by:
  
  getBboxCenter in interface X3DViewportNode
  
  Returns:
  
  value of bboxCenter field
- setBboxCenter
  Viewport 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
  
  Specified by:
  
  setBboxCenter in interface X3DViewportNode
  
  Parameters:
  
  newValue - is new value for the bboxCenter field.
  
  Returns:
  
  Viewport - 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
  
  Specified by:
  
  getBboxDisplay in interface X3DViewportNode
  
  Returns:
  
  value of bboxDisplay field
- setBboxDisplay
  Viewport 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
  
  Specified by:
  
  setBboxDisplay in interface X3DViewportNode
  
  Parameters:
  
  newValue - is new value for the bboxDisplay field.
  
  Returns:
  
  Viewport - 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
  
  Specified by:
  
  getBboxSize in interface X3DViewportNode
  
  Returns:
  
  value of bboxSize field
- setBboxSize
  Viewport 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
  
  Specified by:
  
  setBboxSize in interface X3DViewportNode
  
  Parameters:
  
  newValue - is new value for the bboxSize field.
  
  Returns:
  
  Viewport - 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 X3DChildNode.
  
  Specified by:
  
  getChildren in interface X3DGroupingNode
  
  Specified by:
  
  getChildren in interface X3DViewportNode
  
  Returns:
  
  value of children field
  
  See Also:
  
  X3DChildNode
- setChildren
  Viewport 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 X3DChildNode.
  
  Specified by:
  
  setChildren in interface X3DGroupingNode
  
  Specified by:
  
  setChildren in interface X3DViewportNode
  
  Parameters:
  
  newValue - is new value for the children field.
  
  Returns:
  
  Viewport - 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 X3DChildNode.
  
  Specified by:
  
  addChildren in interface X3DGroupingNode
  
  Specified by:
  
  addChildren in interface X3DViewportNode
  
  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
  
  Specified by:
  
  setChildren in interface X3DViewportNode
  
  Parameters:
  
  newValue - is new node for the children field
- getClipBoundary
  float[] getClipBoundary()
  
  Provide array of float results within allowed range of [0,1] from inputOutput MFFloat field named clipBoundary.
  
  Tooltip: [0,1] clipBoundary is specified in fractions of the normal render surface in the sequence left/right/bottom/top. When children are rendered, the output will only appear in the specified subset of the render surface.
  
  Hint: default value 0 1 0 1 indicates 0-1 left-to-right and 0-1 bottom-to-top, meaning full view.
  
  Returns:
  
  value of clipBoundary field
- setClipBoundary
  Viewport setClipBoundary(float[] newValue)
  
  Accessor method to assign float array to inputOutput MFFloat field named clipBoundary.
  
  Tooltip: [0,1] clipBoundary is specified in fractions of the normal render surface in the sequence left/right/bottom/top. When children are rendered, the output will only appear in the specified subset of the render surface.
  
  Hint: default value 0 1 0 1 indicates 0-1 left-to-right and 0-1 bottom-to-top, meaning full view.
  
  Parameters:
  
  newValue - is new value for the clipBoundary field.
  
  Returns:
  
  Viewport - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- 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 X3DViewportNode
  
  Returns:
  
  value of metadata field
  
  See Also:
  
  X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  Viewport 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 X3DViewportNode
  
  Parameters:
  
  newValue - is new value for the metadata field.
  
  Returns:
  
  Viewport - 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
- 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
  
  Specified by:
  
  getVisible in interface X3DViewportNode
  
  Returns:
  
  value of visible field
- setVisible
  Viewport 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
  
  Specified by:
  
  setVisible in interface X3DViewportNode
  
  Parameters:
  
  newValue - is new value for the visible field.
  
  Returns:
  
  Viewport - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface Viewport

Method Summary

Method Details

getBboxCenter

setBboxCenter

getBboxDisplay

setBboxDisplay

getBboxSize

setBboxSize

getChildren

setChildren

addChildren

setChildren

getClipBoundary

setClipBoundary

getMetadata

setMetadata

getVisible

setVisible