Package org.web3d.x3d.jsail.Navigation

Class ViewpointGroup

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Navigation.ViewpointGroup

All Implemented Interfaces:

X3DChildNode, X3DNode, ViewpointGroup

public class ViewpointGroup
extends X3DConcreteNode
implements ViewpointGroup

ViewpointGroup can contain Viewpoint, OrthoViewpoint, GeoViewpoint and other ViewpointGroup nodes for better user-navigation support with a shared description on the viewpoint list.

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. ViewpointGroup node tooltip: (X3D version 3.2 or later) [X3DChildNode] ViewpointGroup can contain Viewpoint, OrthoViewpoint, GeoViewpoint and other ViewpointGroup nodes for better user-navigation support with a shared description on the viewpoint list.

• Hint: use ViewpointGroup as parent for Viewpoint, OrthoViewpoint, GeoViewpoint and other ViewpointGroup nodes to constrain location proximity where contained viewpoints are available to user.
• Hint: ViewpointGroup and OrthoViewpoint require Navigation component level 3, which is higher than CADInterchange profile.
• Hint: Viewpoint and ViewpointGroup descriptions together build simple menu/submenu lists for simple user navigation. ViewpointGroup is not an X3DGroupingNode, and can only contain a Metadata* node, Viewpoint, OrthoViewpoint, GeoViewpoint and other ViewpointGroup nodes.

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: ViewpointGroup
• X3D Tooltips: ViewpointGroup
• X3D Scene Authoring Hints: Viewpoints

Field Summary

Fields

Modifier and Type	Field	Description
static final float[]	CENTER_DEFAULT_VALUE	SFVec3f field named center has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
static final String	COMPONENT	String constant COMPONENT defines X3D component for the ViewpointGroup element: Navigation
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	DESCRIPTION_DEFAULT_VALUE	SFString field named description has default value equal to an empty string.
static final boolean	DISPLAYED_DEFAULT_VALUE	SFBool field named displayed has default value true (Java syntax) or true (XML syntax).
static final String	fromField_CENTER	fromField ROUTE name for SFVec3f field named center.
static final String	fromField_CHILDREN	fromField ROUTE name for MFNode field named children.
static final String	fromField_DESCRIPTION	fromField ROUTE name for SFString field named description.
static final String	fromField_DISPLAYED	fromField ROUTE name for SFBool field named displayed.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_RETAINUSEROFFSETS	fromField ROUTE name for SFBool field named retainUserOffsets.
static final String	fromField_SIZE	fromField ROUTE name for SFVec3f field named size.
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D Navigation component level for this element: 3
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final String	NAME	String constant NAME provides name of this element: ViewpointGroup.
static final boolean	RETAINUSEROFFSETS_DEFAULT_VALUE	SFBool field named retainUserOffsets has default value false (Java syntax) or false (XML syntax).
static final float[]	SIZE_DEFAULT_VALUE	SFVec3f field named size has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
static final String	toField_CENTER	toField ROUTE name for SFVec3f field named center.
static final String	toField_CHILDREN	toField ROUTE name for MFNode field named children.
static final String	toField_DESCRIPTION	toField ROUTE name for SFString field named description.
static final String	toField_DISPLAYED	toField ROUTE name for SFBool field named displayed.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_RETAINUSEROFFSETS	toField ROUTE name for SFBool field named retainUserOffsets.
static final String	toField_SIZE	toField ROUTE name for SFVec3f field named size.

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

containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ViewpointGroup	addChild(X3DNode newValue)	Utility method to add single child element to contained list of existing children nodes (if any).
ViewpointGroup	addChildren(ProtoInstance newValue)	Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for children field.
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).
ViewpointGroup	addComments(String newComment)	Add comment as CommentsBlock to children field
ViewpointGroup	addComments(String[] newComments)	Add comments as String[] array to children field
ViewpointGroup	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to children field
ViewpointGroup	clearChildren()	Utility method to clear MFNode value of children field.
ViewpointGroup	clearIS()	Utility method to clear SFNode value of IS field.
ViewpointGroup	clearMetadata()	Utility method to clear SFNode value of metadata field.
X3DConcreteElement	findElementByNameValue(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(String nameValue, 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(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
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) with acceptable node types limited to X3DViewpointNode|ViewpointGroup, from inputOutput MFNode field children.
ArrayList<X3DNode>	getChildrenList()	Utility method to get ArrayList value of MFNode children field, similar to getChildren().
final String	getComponent()	Defines X3D component for the ViewpointGroup element: Navigation
final int	getComponentLevel()	Provides default X3D component level for this element: 3
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
String	getDescription()	Provide String value from inputOutput SFString field named description.
boolean	getDisplayed()	Provide boolean value from inputOutput SFBool field named displayed.
final String	getElementName()	Provides name of this element: ViewpointGroup
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
boolean	getRetainUserOffsets()	Provide boolean value from inputOutput SFBool field named retainUserOffsets.
float[]	getSize()	Provide array of 3-tuple float results from inputOutput SFVec3f field named size.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	hasChildren()	Indicate whether an object is available for inputOutput MFNode field children.
boolean	hasElementByNameValue(String nameValue, 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	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
boolean	hasMetadata()	Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
final void	initialize()	Initialize all member variables to default values.
ViewpointGroup	setCenter(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setCenter(float[]).
ViewpointGroup	setCenter(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setCenter(float[]).
ViewpointGroup	setCenter(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named center.
ViewpointGroup	setCenter(float x, float y, float z)	Assign values to SFVec3f center field, similar to setCenter(float[]).
ViewpointGroup	setCenter(SFVec3f newValue)	Assign typed object value to SFVec3f center field, similar to setCenter(float[]).
ViewpointGroup	setChildren(ArrayList<X3DNode> newValue)	Assign ArrayList value of MFNode children field, similar to setChildren(org.web3d.x3d.sai.Core.X3DNode[]).
void	setChildren(X3DNode newValue)	Set single children node, replacing prior array of existing nodes (if any).
ViewpointGroup	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.
final ViewpointGroup	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
ViewpointGroup	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final ViewpointGroup	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
ViewpointGroup	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final ViewpointGroup	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
ViewpointGroup	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
ViewpointGroup	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
ViewpointGroup	setDescription(SFString newValue)	Assign typed object value to SFString description field, similar to setDescription(String).
ViewpointGroup	setDisplayed(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named displayed.
ViewpointGroup	setDisplayed(SFBool newValue)	Assign typed object value to SFBool displayed field, similar to setDisplayed(boolean).
final ViewpointGroup	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
ViewpointGroup	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
ViewpointGroup	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
ViewpointGroup	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
ViewpointGroup	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
ViewpointGroup	setRetainUserOffsets(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named retainUserOffsets.
ViewpointGroup	setRetainUserOffsets(SFBool newValue)	Assign typed object value to SFBool retainUserOffsets field, similar to setRetainUserOffsets(boolean).
ViewpointGroup	setSize(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSize(float[]).
ViewpointGroup	setSize(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setSize(float[]).
ViewpointGroup	setSize(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named size.
ViewpointGroup	setSize(float x, float y, float z)	Assign values to SFVec3f size field, similar to setSize(float[]).
ViewpointGroup	setSize(SFVec3f newValue)	Assign typed object value to SFVec3f size field, similar to setSize(float[]).
final ViewpointGroup	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
ViewpointGroup	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
ViewpointGroup	setUSE(ViewpointGroup DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
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

getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

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

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

String constant NAME provides name of this element: ViewpointGroup.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the ViewpointGroup element: Navigation

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D Navigation component level for this element: 3

See Also:

• Constant Field Values

CENTER_DEFAULT_VALUE

public static final float[] CENTER_DEFAULT_VALUE

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

DESCRIPTION_DEFAULT_VALUE

public static final String DESCRIPTION_DEFAULT_VALUE

SFString field named description has default value equal to an empty string.

See Also:

• Constant Field Values

DISPLAYED_DEFAULT_VALUE

public static final boolean DISPLAYED_DEFAULT_VALUE

SFBool field named displayed has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

RETAINUSEROFFSETS_DEFAULT_VALUE

public static final boolean RETAINUSEROFFSETS_DEFAULT_VALUE

SFBool field named retainUserOffsets has default value false (Java syntax) or false (XML syntax).

See Also:

• Constant Field Values

SIZE_DEFAULT_VALUE

public static final float[] SIZE_DEFAULT_VALUE

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

containerField_DEFAULT_VALUE

public static final String containerField_DEFAULT_VALUE

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "children";
containerField_ALLOWED_VALUES = {"children" }; type xs:NMTOKEN

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_CENTER

public static final String fromField_CENTER

fromField ROUTE name for SFVec3f field named center.

See Also:

• Constant Field Values

toField_CENTER

public static final String toField_CENTER

toField ROUTE name for SFVec3f field named center.

See Also:

• Constant Field Values

fromField_CHILDREN

public static final String fromField_CHILDREN

fromField ROUTE name for MFNode field named children.

See Also:

• Constant Field Values

toField_CHILDREN

public static final String toField_CHILDREN

toField ROUTE name for MFNode field named children.

See Also:

• Constant Field Values

fromField_DESCRIPTION

public static final String fromField_DESCRIPTION

fromField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

toField_DESCRIPTION

public static final String toField_DESCRIPTION

toField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

fromField_DISPLAYED

public static final String fromField_DISPLAYED

fromField ROUTE name for SFBool field named displayed.

See Also:

• Constant Field Values

toField_DISPLAYED

public static final String toField_DISPLAYED

toField ROUTE name for SFBool field named displayed.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

fromField_RETAINUSEROFFSETS

public static final String fromField_RETAINUSEROFFSETS

fromField ROUTE name for SFBool field named retainUserOffsets.

See Also:

• Constant Field Values

toField_RETAINUSEROFFSETS

public static final String toField_RETAINUSEROFFSETS

toField ROUTE name for SFBool field named retainUserOffsets.

See Also:

• Constant Field Values

fromField_SIZE

public static final String fromField_SIZE

fromField ROUTE name for SFVec3f field named size.

See Also:

• Constant Field Values

toField_SIZE

public static final String toField_SIZE

toField ROUTE name for SFVec3f field named size.

See Also:

• Constant Field Values

Constructor Details

ViewpointGroup

public ViewpointGroup()

Constructor for ViewpointGroup to initialize member variables with default values.

ViewpointGroup

public ViewpointGroup(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 Details

getElementName

public final String getElementName()

Provides name of this element: ViewpointGroup

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the ViewpointGroup element: Navigation

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

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public String getFieldType(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 String getAccessType(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 String getContainerFieldDefault()

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

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getCenter

public float[] getCenter()

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

Tooltip: center specifies center point of proximity box within which ViewpointGroup is usable and displayed on viewpoint list. *

Specified by:

getCenter in interface ViewpointGroup

Returns:

value of center field

setCenter

public ViewpointGroup setCenter(float[] newValue)

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

Tooltip: center specifies center point of proximity box within which ViewpointGroup is usable and displayed on viewpoint list. *

Specified by:

setCenter in interface ViewpointGroup

Parameters:

newValue - is new value for the center field.

Returns:

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

setCenter

public ViewpointGroup setCenter(SFVec3f newValue)

Assign typed object value to SFVec3f center field, similar to setCenter(float[]).

Parameters:

newValue - is new value for the center field.

Returns:

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

setCenter

public ViewpointGroup setCenter(float x,
 float y,
 float z)

Assign values to SFVec3f center field, similar to setCenter(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setCenter

public ViewpointGroup setCenter(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setCenter(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setCenter

public ViewpointGroup setCenter(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setCenter(float[]).

Parameters:

newArray - is new value for field

Returns:

ViewpointGroup - 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 org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to X3DViewpointNode|ViewpointGroup, from inputOutput MFNode field children.

Tooltip: [X3DChildNode] ViewpointGroup contains Viewpoint, OrthoViewpoint, GeoViewpoint and other ViewpointGroup nodes that each have containerField='children' default value.

• 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 X3DViewpointNode|ViewpointGroup.

Specified by:

getChildren in interface ViewpointGroup

Returns:

value of children field

See Also:

• X3DViewpointNode
• ViewpointGroup

getChildrenList

public ArrayList<X3DNode> getChildrenList()

Utility method to get ArrayList value of MFNode children field, similar to getChildren().

Returns:

value of children field

setChildren

public ViewpointGroup 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] ViewpointGroup contains Viewpoint, OrthoViewpoint, GeoViewpoint and other ViewpointGroup nodes that each have containerField='children' default value.

• 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 X3DViewpointNode|ViewpointGroup.

Specified by:

setChildren in interface ViewpointGroup

Parameters:

newValue - is new value for the children field.

Returns:

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

setChildren

public ViewpointGroup setChildren(ArrayList<X3DNode> newValue)

Assign ArrayList value of MFNode children field, similar to setChildren(org.web3d.x3d.sai.Core.X3DNode[]).

Parameters:

newValue - is new value for the children field.

Returns:

ViewpointGroup - 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 X3DViewpointNode|ViewpointGroup and ProtoInstance.

Parameters:

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

addChildren

public ViewpointGroup addChildren(ProtoInstance newValue)

Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for children field.

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

Parameters:

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

Returns:

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

addChild

public ViewpointGroup addChild(X3DNode 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:

ViewpointGroup - 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 X3DViewpointNode|ViewpointGroup.

Specified by:

addChildren in interface ViewpointGroup

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 X3DViewpointNode|ViewpointGroup.

Specified by:

setChildren in interface ViewpointGroup

Parameters:

newValue - is new node for the children field (restricted to X3DViewpointNode|ViewpointGroup)

clearChildren

public ViewpointGroup clearChildren()

Utility method to clear MFNode value of children field. This method does not initialize withCHILDREN_DEFAULT_VALUE.

Returns:

ViewpointGroup - 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 ViewpointGroup addComments(String newComment)

Add comment as CommentsBlock to children field

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

addComments

public ViewpointGroup addComments(String[] newComments)

Add comments as String[] array to children field

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public ViewpointGroup addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to children field

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

getDescription

public String getDescription()

Provide String value from inputOutput SFString field named description.

Tooltip: Text description or navigation hint to identify this ViewpointGroup.

• Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable.
• Warning: without description, this ViewpointGroup is unlikely to appear on browser Viewpoint menus.
• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

getDescription in interface ViewpointGroup

Returns:

value of description field

setDescription

public ViewpointGroup setDescription(String newValue)

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

Tooltip: Text description or navigation hint to identify this ViewpointGroup.

• Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable.
• Warning: without description, this ViewpointGroup is unlikely to appear on browser Viewpoint menus.
• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

setDescription in interface ViewpointGroup

Parameters:

newValue - is new value for the description field.

Returns:

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

setDescription

public ViewpointGroup setDescription(SFString newValue)

Assign typed object value to SFString description field, similar to setDescription(String).

Parameters:

newValue - is new value for the description field.

Returns:

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

getDisplayed

public boolean getDisplayed()

Provide boolean value from inputOutput SFBool field named displayed.

Tooltip: displayed determines whether this ViewpointGroup is displayed in the current viewpoint list. *

Specified by:

getDisplayed in interface ViewpointGroup

Returns:

value of displayed field

setDisplayed

public ViewpointGroup setDisplayed(boolean newValue)

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

Tooltip: displayed determines whether this ViewpointGroup is displayed in the current viewpoint list. *

Specified by:

setDisplayed in interface ViewpointGroup

Parameters:

newValue - is new value for the displayed field.

Returns:

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

setDisplayed

public ViewpointGroup setDisplayed(SFBool newValue)

Assign typed object value to SFBool displayed field, similar to setDisplayed(boolean).

Parameters:

newValue - is new value for the displayed field.

Returns:

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

getIS

public IS getIS()

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

Specified by:

getIS in class X3DConcreteNode

Returns:

value of IS field

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

setIS

public ViewpointGroup setIS(IS newValue)

Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.

Specified by:

setIS in class X3DConcreteNode

Parameters:

newValue - is new value for the IS field.

Returns:

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

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

clearIS

public ViewpointGroup clearIS()

Utility method to clear SFNode value of IS field.

Returns:

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

hasIS

public boolean hasIS()

Indicate whether an object is available for inputOutput SFNode field IS.

Returns:

whether a concrete statement or CommentsBlock is available.

See Also:

• getIS()

getMetadata

public X3DMetadataObject getMetadata()

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

Specified by:

getMetadata in interface ViewpointGroup

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

• 
  
  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
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public ViewpointGroup setMetadata(X3DMetadataObject newValue)

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

Specified by:

setMetadata in interface ViewpointGroup

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

• 
  
  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
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public ViewpointGroup clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

public ViewpointGroup setMetadata(ProtoInstance 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:

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

See Also:

• setMetadata(org.web3d.x3d.sai.Core.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

getRetainUserOffsets

public boolean getRetainUserOffsets()

Provide boolean value from inputOutput SFBool field named retainUserOffsets.

Tooltip: Retain (true) or reset to zero (false) any prior user navigation offsets from defined viewpoint position, orientation. *

Specified by:

getRetainUserOffsets in interface ViewpointGroup

Returns:

value of retainUserOffsets field

setRetainUserOffsets

public ViewpointGroup setRetainUserOffsets(boolean newValue)

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

Tooltip: Retain (true) or reset to zero (false) any prior user navigation offsets from defined viewpoint position, orientation. *

Specified by:

setRetainUserOffsets in interface ViewpointGroup

Parameters:

newValue - is new value for the retainUserOffsets field.

Returns:

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

setRetainUserOffsets

public ViewpointGroup setRetainUserOffsets(SFBool newValue)

Assign typed object value to SFBool retainUserOffsets field, similar to setRetainUserOffsets(boolean).

Parameters:

newValue - is new value for the retainUserOffsets field.

Returns:

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

getSize

public float[] getSize()

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

Tooltip: [0,+infinity) size of Proximity box around center location, oriented within local transformation frame, within which ViewpointGroup is usable and displayed on viewpoint list.

• Hint: size 0 0 0 specifies that ViewpointGroup is always usable and displayable.

Specified by:

getSize in interface ViewpointGroup

Returns:

value of size field

setSize

public ViewpointGroup setSize(float[] newValue)

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

Tooltip: [0,+infinity) size of Proximity box around center location, oriented within local transformation frame, within which ViewpointGroup is usable and displayed on viewpoint list.

• Hint: size 0 0 0 specifies that ViewpointGroup is always usable and displayable.

Specified by:

setSize in interface ViewpointGroup

Parameters:

newValue - is new value for the size field.

Returns:

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

setSize

public ViewpointGroup setSize(SFVec3f newValue)

Assign typed object value to SFVec3f size field, similar to setSize(float[]).

Parameters:

newValue - is new value for the size field.

Returns:

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

setSize

public ViewpointGroup setSize(float x,
 float y,
 float z)

Assign values to SFVec3f size field, similar to setSize(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setSize

public ViewpointGroup setSize(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setSize(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setSize

public ViewpointGroup setSize(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setSize(float[]).

Parameters:

newArray - is new value for field

Returns:

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

getDEF

public String getDEF()

Provide String value from inputOutput SFString field named DEF.

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

• 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Overrides:

getDEF in class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

public final ViewpointGroup setDEF(String newValue)

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

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

• 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in class X3DConcreteNode

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setDEF

public ViewpointGroup setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

Parameters:

newValue - is new value for the DEF field.

Returns:

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

getUSE

public String getUSE()

Provide String value from inputOutput SFString field named USE.

Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).

• Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
• Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
• Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.

Overrides:

getUSE in class X3DConcreteNode

Returns:

value of USE field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setUSE

public final ViewpointGroup setUSE(String newValue)

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

Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).

• Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
• Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
• Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.

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

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

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

Specified by:

setUSE in class X3DConcreteNode

Parameters:

newValue - is new value for the USE field.

Returns:

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

setUSE

public ViewpointGroup setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

Parameters:

newValue - is new value for the USE field.

Returns:

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

getCssClass

public String getCssClass()

Provide String value from inputOutput SFString field named class.

Overrides:

getCssClass in class X3DConcreteElement

Returns:

value of class field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final ViewpointGroup setCssClass(String newValue)

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

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

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

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public ViewpointGroup setCssClass(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String).

Parameters:

newValue - is new value for the class field.

Returns:

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

getHtmlID

public String getHtmlID()

Provide String value from inputOutput SFString field named id.

Overrides:

getHtmlID in class X3DConcreteElement

Returns:

value of id field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public final ViewpointGroup setHtmlID(String newValue)

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

Specified by:

setHtmlID in class X3DConcreteNode

Parameters:

newValue - is new value for the id field.

Returns:

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

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public ViewpointGroup setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).

Parameters:

newValue - is new value for the id field.

Returns:

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

getCssStyle

public String getCssStyle()

Provide String value from inputOutput SFString field named style.

Overrides:

getCssStyle in class X3DConcreteElement

Returns:

value of style field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final ViewpointGroup setCssStyle(String newValue)

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

Specified by:

setCssStyle in class X3DConcreteNode

Parameters:

newValue - is new value for the style field.

Returns:

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

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public ViewpointGroup setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String).

Parameters:

newValue - is new value for the style field.

Returns:

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

setUSE

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

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

toStringX3D

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

• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D.toStringXML()
• X3D.toFileXML(String)
• X3D.toFileX3D(String)
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

toStringClassicVRML

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

• X3D.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 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:

• X3D.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(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

findElementByNameValue

public X3DConcreteElement findElementByNameValue(String nameValue,
 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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasElementByNameValue

public boolean hasElementByNameValue(String nameValue,
 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(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasNodeByDEF

public boolean hasNodeByDEF(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 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. TODO document specific validation methods.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)