Package org.web3d.x3d.jsail.Layering

Class Layer

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Layering.Layer

All Implemented Interfaces:

X3DNode, Layer, X3DLayerNode, X3DPickableObject

public class Layer
extends X3DConcreteNode
implements Layer

Layer contains a list of children nodes that define the contents of the layer.

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. Layer node tooltip: (X3D version 3.2 or later) [X3DLayerNode] Layer contains a list of children nodes that define the contents of the layer.

• Hint: no transformations are possible above each LayerSet/Layer combination in the scene graph hierarchy.
• Hint: each Layer node contains its own binding stacks and thus has its own viewpoints and navigation.

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the Layer element: Layering
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	fromField_CHILDREN	fromField ROUTE name for MFNode field named children.
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_OBJECTTYPE	fromField ROUTE name for MFString field named objectType.
static final String	fromField_PICKABLE	fromField ROUTE name for SFBool field named pickable.
static final String	fromField_VIEWPORT	fromField ROUTE name for SFNode field named viewport.
static final String	fromField_VISIBLE	fromField ROUTE name for SFBool field named visible.
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 Layering component level for this element: 1
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: Layer.
static final String	OBJECTTYPE_ALL	Tooltip: each node is available for picking.
static final ArrayList<String>	OBJECTTYPE_DEFAULT_VALUE	MFString field named objectType has default quoted value new String[] {"ALL"} (Java syntax) or quoted value "ALL" (XML syntax).
static final String	OBJECTTYPE_NONE	Tooltip: no node is available for picking.
static final String	OBJECTTYPE_TERRAIN	Tooltip: TERRAIN is an example value.
static final boolean	PICKABLE_DEFAULT_VALUE	SFBool field named pickable has default value true (Java syntax) or true (XML syntax).
static final String	toField_ADDCHILDREN	toField ROUTE name for MFNode field named addChildren.
static final String	toField_CHILDREN	toField ROUTE name for MFNode field named children.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_OBJECTTYPE	toField ROUTE name for MFString field named objectType.
static final String	toField_PICKABLE	toField ROUTE name for SFBool field named pickable.
static final String	toField_REMOVECHILDREN	toField ROUTE name for MFNode field named removeChildren.
static final String	toField_VIEWPORT	toField ROUTE name for SFNode field named viewport.
static final String	toField_VISIBLE	toField ROUTE name for SFBool field named visible.
static final X3DViewportNode	VIEWPORT_DEFAULT_VALUE	SFNode field named viewport has default value null (Java syntax) or NULL (XML syntax).
static final boolean	VISIBLE_DEFAULT_VALUE	SFBool field named visible has default value true (Java syntax) or true (XML syntax).

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

containerField_ALTERNATE_VALUES, 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
Layer()	Constructor for Layer to initialize member variables with default values.
Layer(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
Layer	addChild(X3DChildNode newValue)	Utility method to add single child element to contained list of existing children nodes (if any).
Layer	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).
Layer	addComments(String newComment)	Add comment as CommentsBlock to children field
Layer	addComments(String[] newComments)	Add comments as String[] array to children field
Layer	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to children field
Layer	addObjectType(String newValue)	Add singleton String value to MFString objectType field.
Layer	addObjectType(SFString newValue)	Add singleton SFString value to MFString objectType field.
Layer	clearChildren()	Utility method to clear MFNode value of children field.
Layer	clearIS()	Utility method to clear SFNode value of IS field.
Layer	clearMetadata()	Utility method to clear SFNode value of metadata field.
Layer	clearObjectType()	Utility method to clear MFString value of objectType field.
Layer	clearViewport()	Utility method to clear SFNode value of viewport 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.
X3DNode[]	getChildren()	Provide array of org.web3d.x3d.sai.Core.X3DChildNode results (using an array consisting of properly typed nodes or ProtoInstances) 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 Layer element: Layering
final int	getComponentLevel()	Provides default X3D component level for this element: 1
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.
final String	getElementName()	Provides name of this element: Layer
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.
String[]	getObjectType()	Provide array of String enumeration results with quoted value(s) ["ALL","NONE","TERRAIN",...] from inputOutput MFString field named objectType.
ArrayList<String>	getObjectTypeList()	Utility method to get ArrayList value of MFString objectType field, similar to getObjectType().
String	getObjectTypeString()	Utility method to get String value of MFString objectType field, similar to getObjectType().
boolean	getPickable()	Provide boolean value from inputOutput SFBool field named pickable.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
X3DViewportNode	getViewport()	Provide org.web3d.x3d.sai.Layering.X3DViewportNode instance (using a properly typed node) from inputOutput SFNode field viewport.
boolean	getVisible()	Provide boolean value from inputOutput SFBool field named visible.
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.
boolean	hasViewport()	Indicate whether an object is available for inputOutput SFNode field viewport.
final void	initialize()	Initialize all member variables to default values.
Layer	setChildren(ArrayList<X3DChildNode> 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).
Layer	setChildren(X3DNode[] newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DChildNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.
final Layer	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
Layer	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final Layer	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
Layer	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final Layer	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
Layer	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
final Layer	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
Layer	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
Layer	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
Layer	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
Layer	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
Layer	setObjectType(String newValue)	Assign singleton String value to MFString objectType field, similar to setObjectType(String[]).
Layer	setObjectType(String[] newValue)	Accessor method to assign String enumeration array (""ALL"" | ""NONE"" | ""TERRAIN"") to inputOutput MFString field named objectType.
Layer	setObjectType(ArrayList<String> newValue)	Assign ArrayList value of MFString objectType field, similar to setObjectType(String[]).
Layer	setObjectType(MFString newValue)	Assign typed object value to MFString objectType field, similar to setObjectType(String[]).
Layer	setObjectType(SFString newValue)	Assign single SFString object value to MFString objectType field, similar to setObjectType(String[]).
Layer	setPickable(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named pickable.
Layer	setPickable(SFBool newValue)	Assign typed object value to SFBool pickable field, similar to setPickable(boolean).
final Layer	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
Layer	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
Layer	setUSE(Layer DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
Layer	setViewport(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field viewport.
Layer	setViewport(X3DViewportNode newValue)	Accessor method to assign org.web3d.x3d.sai.Layering.X3DViewportNode instance (using a properly typed node) to inputOutput SFNode field viewport.
Layer	setVisible(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named visible.
Layer	setVisible(SFBool newValue)	Assign typed object value to SFBool visible field, similar to setVisible(boolean).
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

getContainerFieldAlternateValues, 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

OBJECTTYPE_ALL

public static final String OBJECTTYPE_ALL

Tooltip: each node is available for picking. MFString field named objectType with X3DUOM simpleType pickableObjectTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "ALL" (Java syntax) or '"ALL"' (XML syntax).

See Also:

• XML Schema: pickableObjectTypeValues
• Constant Field Values

OBJECTTYPE_NONE

public static final String OBJECTTYPE_NONE

Tooltip: no node is available for picking. MFString field named objectType with X3DUOM simpleType pickableObjectTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "NONE" (Java syntax) or '"NONE"' (XML syntax).

See Also:

• XML Schema: pickableObjectTypeValues
• Constant Field Values

OBJECTTYPE_TERRAIN

public static final String OBJECTTYPE_TERRAIN

Tooltip: TERRAIN is an example value. MFString field named objectType with X3DUOM simpleType pickableObjectTypeValues and with X3DUOM baseType MFString is an array that can include this quoted enumeration value (and also may include alternate values) "TERRAIN" (Java syntax) or '"TERRAIN"' (XML syntax).

See Also:

• XML Schema: pickableObjectTypeValues
• Constant Field Values

NAME

public static final String NAME

String constant NAME provides name of this element: Layer.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the Layer 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

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

OBJECTTYPE_DEFAULT_VALUE

public static final ArrayList<String> OBJECTTYPE_DEFAULT_VALUE

MFString field named objectType has default quoted value new String[] {"ALL"} (Java syntax) or quoted value "ALL" (XML syntax).

PICKABLE_DEFAULT_VALUE

public static final boolean PICKABLE_DEFAULT_VALUE

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

See Also:

• Constant Field Values

VIEWPORT_DEFAULT_VALUE

public static final X3DViewportNode VIEWPORT_DEFAULT_VALUE

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

VISIBLE_DEFAULT_VALUE

public static final boolean VISIBLE_DEFAULT_VALUE

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

See Also:

• Constant Field Values

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, 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 String toField_ADDCHILDREN

toField ROUTE name for MFNode field named addChildren.

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_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_OBJECTTYPE

public static final String fromField_OBJECTTYPE

fromField ROUTE name for MFString field named objectType.

See Also:

• Constant Field Values

toField_OBJECTTYPE

public static final String toField_OBJECTTYPE

toField ROUTE name for MFString field named objectType.

See Also:

• Constant Field Values

fromField_PICKABLE

public static final String fromField_PICKABLE

fromField ROUTE name for SFBool field named pickable.

See Also:

• Constant Field Values

toField_PICKABLE

public static final String toField_PICKABLE

toField ROUTE name for SFBool field named pickable.

See Also:

• Constant Field Values

toField_REMOVECHILDREN

public static final String toField_REMOVECHILDREN

toField ROUTE name for MFNode field named removeChildren.

See Also:

• Constant Field Values

fromField_VIEWPORT

public static final String fromField_VIEWPORT

fromField ROUTE name for SFNode field named viewport.

See Also:

• Constant Field Values

toField_VIEWPORT

public static final String toField_VIEWPORT

toField ROUTE name for SFNode field named viewport.

See Also:

• Constant Field Values

fromField_VISIBLE

public static final String fromField_VISIBLE

fromField ROUTE name for SFBool field named visible.

See Also:

• Constant Field Values

toField_VISIBLE

public static final String toField_VISIBLE

toField ROUTE name for SFBool field named visible.

See Also:

• Constant Field Values

Constructor Details

Layer

public Layer()

Constructor for Layer to initialize member variables with default values.

Layer

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the Layer 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 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. 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

getChildren

public X3DNode[] getChildren()

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

Tooltip: [X3DChildNode] Nodes making up this layer.

• Hint: no transformations are possible above each LayerSet/Layer combination in the scene graph hierarchy.
• Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
• Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
• Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/grouping.html#GroupingAndChildrenNodes

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

Specified by:

getChildren in interface Layer

Returns:

value of children field

See Also:

• X3DChildNode

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

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

Tooltip: [X3DChildNode] Nodes making up this layer.

• Hint: no transformations are possible above each LayerSet/Layer combination in the scene graph hierarchy.
• Hint: inputOnly MFNode addChildren field can append new X3DChildNode nodes via a ROUTE connection, duplicate input nodes (i.e. matching DEF, USE values) are ignored.
• Hint: inputOnly MFNode removeChildren field can remove nodes from the children list, unrecognized input nodes (i.e. nonmatching DEF, USE values) are ignored.
• Hint: X3D Architecture 10.2.1 Grouping and children node types, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/grouping.html#GroupingAndChildrenNodes

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

Specified by:

setChildren in interface Layer

Parameters:

newValue - is new value for the children field.

Returns:

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

setChildren

public Layer setChildren(ArrayList<X3DChildNode> 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:

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

addChildren

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

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

addChild

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

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

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 Layer

Parameters:

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

clearChildren

public Layer clearChildren()

Utility method to clear MFNode value of children field.

Returns:

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

Add comment as CommentsBlock to children field

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

addComments

public Layer addComments(String[] newComments)

Add comments as String[] array to children field

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public Layer addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to children field

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

Layer - 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 Layer clearIS()

Utility method to clear SFNode value of IS field.

Returns:

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

Specified by:

getMetadata in interface X3DLayerNode

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

Specified by:

setMetadata in interface X3DLayerNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

getObjectType

public String[] getObjectType()

Provide array of String enumeration results with quoted value(s) ["ALL","NONE","TERRAIN",...] from inputOutput MFString field named objectType.

Tooltip: The objectType field specifies a set of labels used in the picking process. Each string specified is treated as an independent label that needs to be matched against the same type in one of the pick sensor instances. Example: labeling a PickableGroup with the objectType value "WATER" and then attempting to intersect a pick sensor with objectType value "GROUND" fails since the objectType values do not match. Example: the special value "ALL" means that each node is available for picking regardless of the type specified by the pick sensor. Example: the special value "NONE" effectively disables all picking for this node and is the equivalent of setting the pickable field to false.

• Hint: authors may define any value for objectType.
• Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Available enumeration values for string comparison: ALL, NONE, TERRAIN.

Specified by:

getObjectType in interface Layer

Specified by:

getObjectType in interface X3DLayerNode

Returns:

value of objectType field

getObjectTypeList

public ArrayList<String> getObjectTypeList()

Utility method to get ArrayList value of MFString objectType field, similar to getObjectType().

Returns:

value of objectType field

getObjectTypeString

public String getObjectTypeString()

Utility method to get String value of MFString objectType field, similar to getObjectType().

Returns:

value of objectType field

setObjectType

public Layer setObjectType(String[] newValue)

Accessor method to assign String enumeration array (""ALL"" | ""NONE"" | ""TERRAIN"") to inputOutput MFString field named objectType.

Hint: authors have option to choose from an extendible list of predefined enumeration values (ALL, NONE, TERRAIN).

Tooltip: The objectType field specifies a set of labels used in the picking process. Each string specified is treated as an independent label that needs to be matched against the same type in one of the pick sensor instances. Example: labeling a PickableGroup with the objectType value "WATER" and then attempting to intersect a pick sensor with objectType value "GROUND" fails since the objectType values do not match. Example: the special value "ALL" means that each node is available for picking regardless of the type specified by the pick sensor. Example: the special value "NONE" effectively disables all picking for this node and is the equivalent of setting the pickable field to false.

• Hint: authors may define any value for objectType.
• Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Specified by:

setObjectType in interface Layer

Specified by:

setObjectType in interface X3DLayerNode

Parameters:

newValue - is new value for the objectType field.

Returns:

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

setObjectType

public Layer setObjectType(MFString newValue)

Assign typed object value to MFString objectType field, similar to setObjectType(String[]).

Parameters:

newValue - is new value for the objectType field.

Returns:

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

setObjectType

public Layer setObjectType(SFString newValue)

Assign single SFString object value to MFString objectType field, similar to setObjectType(String[]).

Parameters:

newValue - is new value for the objectType field.

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

setObjectType

public Layer setObjectType(String newValue)

Assign singleton String value to MFString objectType field, similar to setObjectType(String[]).

Parameters:

newValue - is new value for the objectType field.

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

setObjectType

public Layer setObjectType(ArrayList<String> newValue)

Assign ArrayList value of MFString objectType field, similar to setObjectType(String[]).

Parameters:

newValue - is new value for the objectType field.

Returns:

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

clearObjectType

public Layer clearObjectType()

Utility method to clear MFString value of objectType field.

Returns:

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

addObjectType

public Layer addObjectType(String newValue)

Add singleton String value to MFString objectType field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

addObjectType

public Layer addObjectType(SFString newValue)

Add singleton SFString value to MFString objectType field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

getPickable

public boolean getPickable()

Provide boolean value from inputOutput SFBool field named pickable.

Tooltip: pickable determines whether pick traversal is performed for this layer. *

Specified by:

getPickable in interface Layer

Specified by:

getPickable in interface X3DLayerNode

Specified by:

getPickable in interface X3DPickableObject

Returns:

value of pickable field

setPickable

public Layer setPickable(boolean newValue)

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

Tooltip: pickable determines whether pick traversal is performed for this layer. *

Specified by:

setPickable in interface Layer

Specified by:

setPickable in interface X3DLayerNode

Specified by:

setPickable in interface X3DPickableObject

Parameters:

newValue - is new value for the pickable field.

Returns:

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

setPickable

public Layer setPickable(SFBool newValue)

Assign typed object value to SFBool pickable field, similar to setPickable(boolean).

Parameters:

newValue - is new value for the pickable field.

Returns:

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

getViewport

public X3DViewportNode getViewport()

Provide org.web3d.x3d.sai.Layering.X3DViewportNode instance (using a properly typed node) from inputOutput SFNode field viewport.

Specified by:

getViewport in interface Layer

Specified by:

getViewport in interface X3DLayerNode

Returns:

value of viewport field

See Also:

• 
  
  Tooltip: [X3DViewportNode] The viewport field is a single Viewport node that constrains layer output to a sub-region of the render surface. *
  

setViewport

public Layer setViewport(X3DViewportNode newValue)

Accessor method to assign org.web3d.x3d.sai.Layering.X3DViewportNode instance (using a properly typed node) to inputOutput SFNode field viewport.

Specified by:

setViewport in interface Layer

Specified by:

setViewport in interface X3DLayerNode

Parameters:

newValue - is new value for the viewport field.

Returns:

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

See Also:

• 
  
  Tooltip: [X3DViewportNode] The viewport field is a single Viewport node that constrains layer output to a sub-region of the render surface. *
  

clearViewport

public Layer clearViewport()

Utility method to clear SFNode value of viewport field.

Returns:

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

setViewport

public Layer setViewport(ProtoInstance newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field viewport.

Parameters:

newValue - is new value for the viewport field.

Returns:

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

See Also:

• setViewport(org.web3d.x3d.sai.Layering.X3DViewportNode)

hasViewport

public boolean hasViewport()

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

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

• getViewport()
• getViewportProtoInstance()

getVisible

public boolean getVisible()

Provide boolean value from inputOutput SFBool field named visible.

Tooltip: Whether or not renderable content within this node is visually displayed.

• Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
• Hint: content must be visible to be collidable and to be pickable.

Specified by:

getVisible in interface Layer

Specified by:

getVisible in interface X3DLayerNode

Returns:

value of visible field

setVisible

public Layer setVisible(boolean newValue)

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

Tooltip: Whether or not renderable content within this node is visually displayed.

• Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
• Hint: content must be visible to be collidable and to be pickable.

Specified by:

setVisible in interface Layer

Specified by:

setVisible in interface X3DLayerNode

Parameters:

newValue - is new value for the visible field.

Returns:

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

setVisible

public Layer setVisible(SFBool newValue)

Assign typed object value to SFBool visible field, similar to setVisible(boolean).

Parameters:

newValue - is new value for the visible field.

Returns:

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

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

setUSE

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

Layer - 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)