org.web3d.x3d.jsail.Layering

Class ViewportObject

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Layering.ViewportObject

All Implemented Interfaces:

X3DChildNode, X3DNode, X3DBoundedObject, X3DGroupingNode, Viewport, X3DViewportNode

public class ViewportObject
extends X3DConcreteNode
implements Viewport

X3D node tooltip: (X3D version 3.2 or later) [X3DViewportNode, X3DBoundedObject] 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 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: Viewport, X3D Tooltips: Viewport, X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field and Description
static float[]	BBOXCENTER_DEFAULT_VALUE SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
static float[]	BBOXSIZE_DEFAULT_VALUE SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).
static java.util.ArrayList<java.lang.Float>	CLIPBOUNDARY_DEFAULT_VALUE MFFloat field named clipBoundary has default value {0f,1f,0f,1f} (Java syntax) or 0 1 0 1 (XML syntax).
static java.lang.String	COMPONENT String constant COMPONENT defines X3D component for the Viewport element: Layering
static java.lang.String	containerField_DEFAULT_VALUE containerField describes typical field relationship of a node to its parent.
static java.lang.String	fromField_CHILDREN fromField ROUTE name for MFNode field named children.
static java.lang.String	fromField_CLIPBOUNDARY fromField ROUTE name for MFFloat field named clipBoundary.
static java.lang.String	fromField_METADATA fromField ROUTE name for SFNode field named metadata.
static int	LEVEL Integer constant LEVEL provides default X3D Layering component level for this element: 1
static java.lang.String	NAME String constant NAME provides name of this element: Viewport.
static java.lang.String	toField_ADDCHILDREN toField ROUTE name for MFNode field named addChildren.
static java.lang.String	toField_CHILDREN toField ROUTE name for MFNode field named children.
static java.lang.String	toField_CLIPBOUNDARY toField ROUTE name for MFFloat field named clipBoundary.
static java.lang.String	toField_METADATA toField ROUTE name for SFNode field named metadata.
static java.lang.String	toField_REMOVECHILDREN toField ROUTE name for MFNode field named removeChildren.

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

CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

validationResult

Constructor Summary

Constructors

Constructor and Description
ViewportObject() Constructor for ViewportObject to initialize member variables with default values.
ViewportObject(java.lang.String DEFlabel) Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method and Description
ViewportObject	addChild(X3DChildNode newValue) Utility method to add single child element to contained list of existing children nodes (if any).
void	addChildren(X3DNode newValue) Add single node to existing array of children nodes (if any).
void	addChildren(X3DNode[] newValue) Add array of children nodes to array of existing nodes (if any).
ViewportObject	addClipBoundary(float newValue) Add singleton float value to MFFloat clipBoundary field.
ViewportObject	addClipBoundary(SFFloatObject newValue) Add singleton SFFloatObject value to MFFloat clipBoundary field.
ViewportObject	addComments(CommentsBlock newCommentsBlock) Add CommentsBlock to children field
ViewportObject	addComments(java.lang.String newComment) Add comment as CommentsBlock to children field
ViewportObject	addComments(java.lang.String[] newComments) Add comments as String[] array to children field
ViewportObject	clearChildren() Utility method to clear MFNode value of children field.
ViewportObject	clearClipBoundary() Utility method to clear MFFloat value of clipBoundary field.
ViewportObject	clearMetadata() Utility method to clear SFNode value of metadata field.
X3DConcreteElement	findElementByNameValue(java.lang.String nameValue) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteElement	findElementByNameValue(java.lang.String nameValue, java.lang.String elementName) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteNode	findNodeByDEF(java.lang.String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
java.lang.String	getAccessType(java.lang.String fieldName) Indicate accessType corresponding to given fieldName.
float[]	getBboxCenter() Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
float[]	getBboxSize() Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
X3DNode[]	getChildren() Provide array of X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field children.
java.util.ArrayList<X3DNode>	getChildrenList() Utility method to get ArrayList value of MFNode children field, similar to getChildren().
float[]	getClipBoundary() Provide array of Float results within allowed range of [0,1] from inputOutput MFFloat field named clipBoundary.
java.util.ArrayList<java.lang.Float>	getClipBoundaryList() Utility method to get ArrayList value of MFFloat clipBoundary field, similar to getClipBoundary().
java.lang.String	getComponent() Defines X3D component for the Viewport element: Layering
int	getComponentLevel() Provides default X3D component level for this element: 1
java.lang.String	getContainerFieldDefault() containerField describes typical field relationship of a node to its parent.
java.lang.String	getElementName() Provides name of this element: Viewport
java.lang.String	getFieldType(java.lang.String fieldName) Indicate type corresponding to given fieldName.
ISObject	getIS() Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
boolean	hasChildren() Indicate whether an object is available for inputOutput MFNode field children.
boolean	hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName) Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
boolean	hasMetadata() Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(java.lang.String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
void	initialize() Initialize all member variables to default values.
ViewportObject	setBboxCenter(float[] newValue) Assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
ViewportObject	setBboxCenter(float x, float y, float z) Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
ViewportObject	setBboxCenter(SFVec3fObject newValue) Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
ViewportObject	setBboxSize(float[] newValue) Assign 3-tuple float array within allowed range of [0,infinity), or default value [-1 -1 -1], to initializeOnly SFVec3f field named bboxSize.
ViewportObject	setBboxSize(float x, float y, float z) Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
ViewportObject	setBboxSize(SFVec3fObject newValue) Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).
ViewportObject	setChildren(java.util.ArrayList<X3DChildNode> newValue) Assign ArrayList value of MFNode children field, similar to setChildren(X3DNode[]).
void	setChildren(X3DNode newValue) Set single children node, replacing prior array of existing nodes (if any).
ViewportObject	setChildren(X3DNode[] newValue) Assign X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field children.
ViewportObject	setClipBoundary(java.util.ArrayList<java.lang.Float> newValue) Assign ArrayList value of MFFloat clipBoundary field, similar to setClipBoundary(float[]).
ViewportObject	setClipBoundary(float[] newValue) Assign Float array within allowed range of [0,1] to inputOutput MFFloat field named clipBoundary.
ViewportObject	setClipBoundary(int[] newValue) Assign floating-point array value of MFFloat clipBoundary field, similar to setClipBoundary(float[]).
ViewportObject	setClipBoundary(MFFloatObject newValue) Assign typed object value to MFFloat clipBoundary field, similar to setClipBoundary(float[]).
ViewportObject	setCssClass(SFStringObject newValue) Assign typed object value to SFString cssClass field, similar to setCssClass(String).
ViewportObject	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
ViewportObject	setDEF(SFStringObject newValue) Assign typed object value to SFString DEF field, similar to setDEF(String).
ViewportObject	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
ViewportObject	setIS(ISObject newValue) Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
ViewportObject	setMetadata(ProtoInstanceObject newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
ViewportObject	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
ViewportObject	setUSE(SFStringObject newValue) Assign typed object value to SFString USE field, similar to setUSE(String).
ViewportObject	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.
ViewportObject	setUSE(ViewportObject DEFnode) Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
java.lang.String	toStringClassicVRML(int indentLevel) Recursive method to provide ClassicVRML string serialization.
java.lang.String	toStringVRML97(int indentLevel) Recursive method to provide VRML97 string serialization.
java.lang.String	toStringX3D(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
java.lang.String	validate() Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

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

getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

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

clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final java.lang.String NAME

String constant NAME provides name of this element: Viewport.

See Also:

Constant Field Values

COMPONENT

public static final java.lang.String COMPONENT

String constant COMPONENT defines X3D component for the Viewport element: Layering

See Also:

Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D Layering component level for this element: 1

See Also:

Constant Field Values

BBOXCENTER_DEFAULT_VALUE

public static final float[] BBOXCENTER_DEFAULT_VALUE

SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).

BBOXSIZE_DEFAULT_VALUE

public static final float[] BBOXSIZE_DEFAULT_VALUE

SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).

CLIPBOUNDARY_DEFAULT_VALUE

public static final java.util.ArrayList<java.lang.Float> CLIPBOUNDARY_DEFAULT_VALUE

MFFloat field named clipBoundary has default value {0f,1f,0f,1f} (Java syntax) or 0 1 0 1 (XML syntax).

containerField_DEFAULT_VALUE

public static final java.lang.String containerField_DEFAULT_VALUE

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.

See Also:

X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values

toField_ADDCHILDREN

public static final java.lang.String toField_ADDCHILDREN

toField ROUTE name for MFNode field named addChildren.

See Also:

Constant Field Values

fromField_CHILDREN

public static final java.lang.String fromField_CHILDREN

fromField ROUTE name for MFNode field named children.

See Also:

Constant Field Values

toField_CHILDREN

public static final java.lang.String toField_CHILDREN

toField ROUTE name for MFNode field named children.

See Also:

Constant Field Values

fromField_CLIPBOUNDARY

public static final java.lang.String fromField_CLIPBOUNDARY

fromField ROUTE name for MFFloat field named clipBoundary.

See Also:

Constant Field Values

toField_CLIPBOUNDARY

public static final java.lang.String toField_CLIPBOUNDARY

toField ROUTE name for MFFloat field named clipBoundary.

See Also:

Constant Field Values

fromField_METADATA

public static final java.lang.String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

Constant Field Values

toField_METADATA

public static final java.lang.String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

Constant Field Values

toField_REMOVECHILDREN

public static final java.lang.String toField_REMOVECHILDREN

toField ROUTE name for MFNode field named removeChildren.

See Also:

Constant Field Values

Constructor Detail

ViewportObject

public ViewportObject()

Constructor for ViewportObject to initialize member variables with default values.

ViewportObject

public ViewportObject(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

Method Detail

getElementName

public final java.lang.String getElementName()

Provides name of this element: Viewport

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final java.lang.String getComponent()

Defines X3D component for the Viewport element: Layering

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: 1

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public java.lang.String getFieldType(java.lang.String fieldName)

Indicate type corresponding to given fieldName.

Specified by:

getFieldType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized

See Also:

ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE

getAccessType

public java.lang.String getAccessType(java.lang.String fieldName)

Indicate accessType corresponding to given fieldName.

Specified by:

getAccessType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized

See Also:

ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

getContainerFieldDefault

public final java.lang.String getContainerFieldDefault()

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getBboxCenter

public float[] getBboxCenter()

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

Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.

• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes

Specified by:

getBboxCenter in interface X3DBoundedObject

Specified by:

getBboxCenter in interface X3DGroupingNode

Specified by:

getBboxCenter in interface Viewport

Specified by:

getBboxCenter in interface X3DViewportNode

Returns:

value of bboxCenter field

setBboxCenter

public ViewportObject setBboxCenter(float[] newValue)

Assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.

Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system. Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size. Hint: X3D Architecture, 10.2.2 Bounding boxes http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes

Specified by:

setBboxCenter in interface X3DBoundedObject

Specified by:

setBboxCenter in interface X3DGroupingNode

Specified by:

setBboxCenter in interface Viewport

Specified by:

setBboxCenter in interface X3DViewportNode

Parameters:

newValue - is new value for the bboxCenter field.

Returns:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxCenter

public ViewportObject 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:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxCenter

public ViewportObject 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:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getBboxSize

public float[] getBboxSize()

Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.

Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.

• Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes

Specified by:

getBboxSize in interface X3DBoundedObject

Specified by:

getBboxSize in interface X3DGroupingNode

Specified by:

getBboxSize in interface Viewport

Specified by:

getBboxSize in interface X3DViewportNode

Returns:

value of bboxSize field

setBboxSize

public ViewportObject setBboxSize(float[] newValue)

Assign 3-tuple float array within allowed range of [0,infinity), or default value [-1 -1 -1], to initializeOnly SFVec3f field named bboxSize.

Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint. Hint: can be useful for collision computations or inverse-kinematics (IK) engines. Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size. Hint: X3D Architecture, 10.2.2 Bounding boxes http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes

Specified by:

setBboxSize in interface X3DBoundedObject

Specified by:

setBboxSize in interface X3DGroupingNode

Specified by:

setBboxSize in interface Viewport

Specified by:

setBboxSize in interface X3DViewportNode

Parameters:

newValue - is new value for the bboxSize field.

Returns:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxSize

public ViewportObject 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:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxSize

public ViewportObject 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:

ViewportObject - 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 X3DChildNode 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 X3DChildNode.

Specified by:

getChildren in interface X3DGroupingNode

Specified by:

getChildren in interface Viewport

Specified by:

getChildren in interface X3DViewportNode

Returns:

value of children field

See Also:

X3DChildNode

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 ViewportObject setChildren(X3DNode[] newValue)

Assign X3DChildNode 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 X3DChildNode.

Specified by:

setChildren in interface X3DGroupingNode

Specified by:

setChildren in interface Viewport

Specified by:

setChildren in interface X3DViewportNode

Parameters:

newValue - is new value for the children field.

Returns:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setChildren

public ViewportObject setChildren(java.util.ArrayList<X3DChildNode> newValue)

Assign ArrayList value of MFNode children field, similar to setChildren(X3DNode[]).

Parameters:

newValue - is new value for the children field.

Returns:

ViewportObject - 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 single node to existing array of children nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to X3DChildNode and ProtoInstance.

Parameters:

newValue - is new value to be appended the children field.

addChild

public ViewportObject addChild(X3DChildNode 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:

ViewportObject - 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 X3DChildNode.

Specified by:

addChildren in interface X3DGroupingNode

Specified by:

addChildren in interface Viewport

Specified by:

addChildren in interface X3DViewportNode

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 X3DChildNode.

Specified by:

setChildren in interface X3DGroupingNode

Specified by:

setChildren in interface Viewport

Specified by:

setChildren in interface X3DViewportNode

Parameters:

newValue - is new node for the children field (restricted to X3DChildNode)

clearChildren

public ViewportObject clearChildren()

Utility method to clear MFNode value of children field.

Returns:

ViewportObject - 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()

addComments

public ViewportObject addComments(java.lang.String newComment)

Add comment as CommentsBlock to children field

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public ViewportObject addComments(java.lang.String[] newComments)

Add comments as String[] array to children field

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public ViewportObject addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to children field

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getClipBoundary

public 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.

Specified by:

getClipBoundary in interface Viewport

Returns:

value of clipBoundary field

getClipBoundaryList

public java.util.ArrayList<java.lang.Float> getClipBoundaryList()

Utility method to get ArrayList value of MFFloat clipBoundary field, similar to getClipBoundary().

Returns:

value of clipBoundary field

setClipBoundary

public ViewportObject setClipBoundary(float[] newValue)

Assign Float array within allowed range of [0,1] 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.

Specified by:

setClipBoundary in interface Viewport

Parameters:

newValue - is new value for the clipBoundary field.

Returns:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setClipBoundary

public ViewportObject setClipBoundary(MFFloatObject newValue)

Assign typed object value to MFFloat clipBoundary field, similar to setClipBoundary(float[]).

Parameters:

newValue - is new value for the clipBoundary field.

Returns:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setClipBoundary

public ViewportObject setClipBoundary(java.util.ArrayList<java.lang.Float> newValue)

Assign ArrayList value of MFFloat clipBoundary field, similar to setClipBoundary(float[]).

Parameters:

newValue - is new value for the clipBoundary field.

Returns:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

clearClipBoundary

public ViewportObject clearClipBoundary()

Utility method to clear MFFloat value of clipBoundary field.

Returns:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setClipBoundary

public ViewportObject setClipBoundary(int[] newValue)

Assign floating-point array value of MFFloat clipBoundary field, similar to setClipBoundary(float[]).

Parameters:

newValue - is new value for the clipBoundary field.

Returns:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addClipBoundary

public ViewportObject addClipBoundary(float newValue)

Add singleton float value to MFFloat clipBoundary field.

Parameters:

newValue - is new value to add to the clipBoundary field.

Returns:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addClipBoundary

public ViewportObject addClipBoundary(SFFloatObject newValue)

Add singleton SFFloatObject value to MFFloat clipBoundary field.

Parameters:

newValue - is new value to add to the clipBoundary field.

Returns:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getMetadata

public X3DMetadataObject getMetadata()

Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DGroupingNode

Specified by:

getMetadata in interface Viewport

Specified by:

getMetadata in interface X3DViewportNode

Returns:

value of metadata field

See Also:

getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public ViewportObject setMetadata(X3DMetadataObject newValue)

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 X3DGroupingNode

Specified by:

setMetadata in interface Viewport

Specified by:

setMetadata in interface X3DViewportNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

ViewportObject - 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 ViewportObject clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

public ViewportObject 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:

ViewportObject - 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

setDEF

public final ViewportObject setDEF(java.lang.String newValue)

Assign String value to inputOutput SFString field named DEF.

Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in interface X3DChildNode

Specified by:

setDEF in interface X3DNode

Specified by:

setDEF in interface X3DGroupingNode

Specified by:

setDEF in interface Viewport

Specified by:

setDEF in interface X3DViewportNode

Specified by:

setDEF in class X3DConcreteNode

Parameters:

newValue - is new value for the DEF field.

Returns:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDEF

public ViewportObject 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:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public final ViewportObject setUSE(java.lang.String newValue)

Assign String value to inputOutput SFString field named USE.

Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.

Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.

Specified by:

setUSE in interface X3DChildNode

Specified by:

setUSE in interface X3DNode

Specified by:

setUSE in interface X3DGroupingNode

Specified by:

setUSE in interface Viewport

Specified by:

setUSE in interface X3DViewportNode

Specified by:

setUSE in class X3DConcreteNode

Parameters:

newValue - is new value for the USE field.

Returns:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public ViewportObject 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:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setCssClass

public final ViewportObject setCssClass(java.lang.String newValue)

Assign String value to inputOutput SFString field named class.

Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS

Specified by:

setCssClass in interface X3DChildNode

Specified by:

setCssClass in interface X3DNode

Specified by:

setCssClass in interface X3DGroupingNode

Specified by:

setCssClass in interface Viewport

Specified by:

setCssClass in interface X3DViewportNode

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

ViewportObject - 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 ViewportObject 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:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setIS

public ViewportObject setIS(ISObject newValue)

Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.

Specified by:

setIS in class X3DConcreteNode

Parameters:

newValue - is new value for the description field.

Returns:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

X3D Tooltips: IS, X3D Tooltips: connect

getIS

public ISObject getIS()

Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.

Specified by:

getIS in class X3DConcreteNode

Returns:

current ISObject, if any.

See Also:

X3D Tooltips: IS, X3D Tooltips: connect

setUSE

public ViewportObject setUSE(ViewportObject 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:

ViewportObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

toStringX3D

public java.lang.String toStringX3D(int indentLevel)

Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.

Specified by:

toStringX3D in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

X3D string

See Also:

X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form

toStringClassicVRML

public java.lang.String toStringClassicVRML(int indentLevel)

Recursive method to provide ClassicVRML string serialization.

Specified by:

toStringClassicVRML in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

ClassicVRML string

See Also:

X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar

toStringVRML97

public java.lang.String toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

Specified by:

toStringVRML97 in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

VRML97 string

See Also:

X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment

findElementByNameValue

public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

Warning: more than one element may be found that has the same name, this method does not handle that case.

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

Returns:

object reference to found element, null otherwise

See Also:

findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

findElementByNameValue

public X3DConcreteElement findElementByNameValue(java.lang.String nameValue,
                                                 java.lang.String elementName)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

Warning: more than one element may be found that has the same name, this method does not handle that case.

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

object reference to found element, null otherwise

See Also:

findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

hasElementByNameValue

public boolean hasElementByNameValue(java.lang.String nameValue,
                                     java.lang.String elementName)

Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

whether node is found

See Also:

findElementByNameValue(String, String)

findNodeByDEF

public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)

Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

Warning: more than one element may be found that has the same DEF, this method does not handle that case.

Specified by:

findNodeByDEF in class X3DConcreteElement

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

object reference to found node, null otherwise

See Also:

findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

hasNodeByDEF

public boolean hasNodeByDEF(java.lang.String DEFvalue)

Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

whether node is found

See Also:

findNodeByDEF(String)

validate

public java.lang.String validate()

Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)