Package org.web3d.x3d.jsail.Layering

Class LayerSet

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Layering.LayerSet

All Implemented Interfaces:

X3DNode, LayerSet

public class LayerSet
extends X3DConcreteNode
implements LayerSet

LayerSet defines a list of layers and a rendering order.

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. LayerSet node tooltip: (X3D version 3.2 or later) [X3DNode] LayerSet defines a list of layers and a rendering order. The rendering order is specified by the order field.

• Hint: the layer first specified in the order field is the first layer rendered and appears below any other layers. The layer last specified in the order field is the last layer rendered and correspondingly appears on top of all other layers.
• Warning: only one LayerSet node is allowed in a scene, and it shall be a root node at the top of the scene graph.
• Hint: X3D Architecture 35.2.1 Overview of layering https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/layering.html#OverviewOfLayering

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ACTIVELAYER_DEFAULT_VALUE	SFInt32 field named activeLayer has default value 0 (Java syntax) or 0 (XML syntax).
static final String	COMPONENT	String constant COMPONENT defines X3D component for the LayerSet element: Layering
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	fromField_ACTIVELAYER	fromField ROUTE name for SFInt32 field named activeLayer.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_LAYERS	fromField ROUTE name for MFNode field named layers.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_ORDER	fromField ROUTE name for MFInt32 field named order.
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: LayerSet.
static final ArrayList<Integer>	ORDER_DEFAULT_VALUE	MFInt32 field named order has default value {0} (Java syntax) or 0 (XML syntax).
static final String	toField_ACTIVELAYER	toField ROUTE name for SFInt32 field named activeLayer.
static final String	toField_LAYERS	toField ROUTE name for MFNode field named layers.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_ORDER	toField ROUTE name for MFInt32 field named order.

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

Method Summary

Modifier and Type	Method	Description
LayerSet	addComments(String newComment)	Add comment as String to contained commentsList.
LayerSet	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
LayerSet	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
LayerSet	addLayers(ProtoInstance newValue)	Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for layers field.
LayerSet	addLayers(X3DNode newValue)	Add single child node to existing array of layers nodes (if any).
void	addLayers(X3DNode[] newValue)	Add array of child layers nodes to array of existing nodes (if any).
LayerSet	addOrder(int newValue)	Add singleton int value to MFInt32 order field.
LayerSet	addOrder(SFInt32 newValue)	Add singleton SFInt32 value to MFInt32 order field.
LayerSet	clearIS()	Utility method to clear SFNode value of IS field.
LayerSet	clearLayers()	Utility method to clear MFNode value of layers field.
LayerSet	clearMetadata()	Utility method to clear SFNode value of metadata field.
LayerSet	clearOrder()	Utility method to clear MFInt32 value of order 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.
int	getActiveLayer()	Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named activeLayer.
final String	getComponent()	Defines X3D component for the LayerSet 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: LayerSet
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.
X3DNode[]	getLayers()	Provide array of org.web3d.x3d.sai.Layering.X3DLayerNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field layers.
ArrayList<X3DNode>	getLayersList()	Utility method to get ArrayList value of MFNode layers field, similar to getLayers().
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
int[]	getOrder()	Provide array of Integer results within allowed range of [0,infinity) from inputOutput MFInt32 field named order.
ArrayList<Integer>	getOrderList()	Utility method to get ArrayList value of MFInt32 order field, similar to getOrder().
String	getOrderString()	Utility method to get String value of MFInt32 order field, similar to getOrder().
String	getUSE()	Provide String value from inputOutput SFString field named USE.
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	hasLayers()	Indicate whether an object is available for inputOutput MFNode field layers.
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.
LayerSet	setActiveLayer(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named activeLayer.
LayerSet	setActiveLayer(SFInt32 newValue)	Assign typed object value to SFInt32 activeLayer field, similar to setActiveLayer(int).
final LayerSet	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
LayerSet	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final LayerSet	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
LayerSet	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final LayerSet	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
LayerSet	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
final LayerSet	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
LayerSet	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
LayerSet	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
LayerSet	setLayers(ArrayList<X3DLayerNode> newValue)	Assign ArrayList value of MFNode layers field, similar to setLayers(org.web3d.x3d.sai.Core.X3DNode[]).
void	setLayers(X3DNode newValue)	Set single child layers node, replacing prior array of existing nodes (if any).
LayerSet	setLayers(X3DNode[] newValue)	Accessor method to assign org.web3d.x3d.sai.Layering.X3DLayerNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field layers.
LayerSet	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
LayerSet	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
LayerSet	setOrder(int[] newValue)	Accessor method to assign Integer array to inputOutput MFInt32 field named order.
LayerSet	setOrder(ArrayList<Integer> newValue)	Assign ArrayList value of MFInt32 order field, similar to setOrder(int[]).
LayerSet	setOrder(MFInt32 newValue)	Assign typed object value to MFInt32 order field, similar to setOrder(int[]).
final LayerSet	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
LayerSet	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
LayerSet	setUSE(LayerSet 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

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

NAME

public static final String NAME

String constant NAME provides name of this element: LayerSet.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

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

ACTIVELAYER_DEFAULT_VALUE

public static final int ACTIVELAYER_DEFAULT_VALUE

SFInt32 field named activeLayer has default value 0 (Java syntax) or 0 (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).

ORDER_DEFAULT_VALUE

public static final ArrayList<Integer> ORDER_DEFAULT_VALUE

MFInt32 field named order has default value {0} (Java syntax) or 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, default value is provided for informational purposes.

See Also:

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

fromField_ACTIVELAYER

public static final String fromField_ACTIVELAYER

fromField ROUTE name for SFInt32 field named activeLayer.

See Also:

• Constant Field Values

toField_ACTIVELAYER

public static final String toField_ACTIVELAYER

toField ROUTE name for SFInt32 field named activeLayer.

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_LAYERS

public static final String fromField_LAYERS

fromField ROUTE name for MFNode field named layers.

See Also:

• Constant Field Values

toField_LAYERS

public static final String toField_LAYERS

toField ROUTE name for MFNode field named layers.

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_ORDER

public static final String fromField_ORDER

fromField ROUTE name for MFInt32 field named order.

See Also:

• Constant Field Values

toField_ORDER

public static final String toField_ORDER

toField ROUTE name for MFInt32 field named order.

See Also:

• Constant Field Values

Constructor Details

LayerSet

public LayerSet()

Constructor for LayerSet to initialize member variables with default values.

LayerSet

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

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

getActiveLayer

public int getActiveLayer()

Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named activeLayer.

Tooltip: [0,+infinity) activeLayer field specifies the layer in which navigation takes place.

• Hint: nodes that are not part of a layer are considered to be in layer 0.

Specified by:

getActiveLayer in interface LayerSet

Returns:

value of activeLayer field

setActiveLayer

public LayerSet setActiveLayer(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named activeLayer.

Tooltip: [0,+infinity) activeLayer field specifies the layer in which navigation takes place.

• Hint: nodes that are not part of a layer are considered to be in layer 0.

Specified by:

setActiveLayer in interface LayerSet

Parameters:

newValue - is new value for the activeLayer field.

Returns:

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

setActiveLayer

public LayerSet setActiveLayer(SFInt32 newValue)

Assign typed object value to SFInt32 activeLayer field, similar to setActiveLayer(int).

Parameters:

newValue - is new value for the activeLayer field.

Returns:

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

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

Utility method to clear SFNode value of IS field.

Returns:

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

getLayers

public X3DNode[] getLayers()

Provide array of org.web3d.x3d.sai.Layering.X3DLayerNode results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field layers.

Tooltip: [X3DLayerNode] The layers list defines a list of Layer nodes that contain the constituent parts of the scene. Each layer is assigned an ordinal number depending on its position in this contained list of nodes.

• Hint: Ordinal values start with the numeral 1 representing the first item in the list.
• Hint: nodes that are not part of a layer are considered to be in layer 0.

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

Specified by:

getLayers in interface LayerSet

Returns:

value of layers field

See Also:

• X3DLayerNode

getLayersList

public ArrayList<X3DNode> getLayersList()

Utility method to get ArrayList value of MFNode layers field, similar to getLayers().

Returns:

value of layers field

setLayers

public LayerSet setLayers(X3DNode[] newValue)

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

Tooltip: [X3DLayerNode] The layers list defines a list of Layer nodes that contain the constituent parts of the scene. Each layer is assigned an ordinal number depending on its position in this contained list of nodes.

• Hint: Ordinal values start with the numeral 1 representing the first item in the list.
• Hint: nodes that are not part of a layer are considered to be in layer 0.

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

Specified by:

setLayers in interface LayerSet

Parameters:

newValue - is new value for the layers field.

Returns:

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

setLayers

public LayerSet setLayers(ArrayList<X3DLayerNode> newValue)

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

Parameters:

newValue - is new value for the layers field.

Returns:

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

addLayers

public LayerSet addLayers(X3DNode newValue)

Add single child node to existing array of layers nodes (if any).

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

Parameters:

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

Returns:

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

addLayers

public LayerSet addLayers(ProtoInstance newValue)

Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for layers 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:

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

addLayers

public void addLayers(X3DNode[] newValue)

Add array of child layers nodes to array of existing nodes (if any).

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

Specified by:

addLayers in interface LayerSet

Parameters:

newValue - is new value array to be appended the layers field.

setLayers

public void setLayers(X3DNode newValue)

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

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

Specified by:

setLayers in interface LayerSet

Parameters:

newValue - is new node for the layers field (restricted to X3DLayerNode)

clearLayers

public LayerSet clearLayers()

Utility method to clear MFNode value of layers field.

Returns:

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

hasLayers

public boolean hasLayers()

Indicate whether an object is available for inputOutput MFNode field layers.

Returns:

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

See Also:

• getLayers()

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 LayerSet

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

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

getOrder

public int[] getOrder()

Provide array of Integer results within allowed range of [0,infinity) from inputOutput MFInt32 field named order.

Tooltip: [0,+infinity) The order list defines the order in which layers are rendered. Each value corresponds to the ordinals of the layers.

• Hint: the order list may contain repetitions of ordinal values, in which case the layer is rendered again.
• Warning: if order contains number values that are not ordinals assigned to layers, such numbers are ignored.
• Warning: layers that are not included in the order list are not rendered.

Specified by:

getOrder in interface LayerSet

Returns:

value of order field

getOrderList

public ArrayList<Integer> getOrderList()

Utility method to get ArrayList value of MFInt32 order field, similar to getOrder().

Returns:

value of order field

getOrderString

public String getOrderString()

Utility method to get String value of MFInt32 order field, similar to getOrder().

Returns:

value of order field

setOrder

public LayerSet setOrder(int[] newValue)

Accessor method to assign Integer array to inputOutput MFInt32 field named order.

Tooltip: [0,+infinity) The order list defines the order in which layers are rendered. Each value corresponds to the ordinals of the layers.

• Hint: the order list may contain repetitions of ordinal values, in which case the layer is rendered again.
• Warning: if order contains number values that are not ordinals assigned to layers, such numbers are ignored.
• Warning: layers that are not included in the order list are not rendered.

Specified by:

setOrder in interface LayerSet

Parameters:

newValue - is new value for the order field.

Returns:

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

setOrder

public LayerSet setOrder(MFInt32 newValue)

Assign typed object value to MFInt32 order field, similar to setOrder(int[]).

Parameters:

newValue - is new value for the order field.

Returns:

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

setOrder

public LayerSet setOrder(ArrayList<Integer> newValue)

Assign ArrayList value of MFInt32 order field, similar to setOrder(int[]).

Parameters:

newValue - is new value for the order field.

Returns:

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

clearOrder

public LayerSet clearOrder()

Utility method to clear MFInt32 value of order field.

Returns:

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

addOrder

public LayerSet addOrder(int newValue)

Add singleton int value to MFInt32 order field.

Parameters:

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

Returns:

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

addOrder

public LayerSet addOrder(SFInt32 newValue)

Add singleton SFInt32 value to MFInt32 order field.

Parameters:

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

Returns:

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

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

setUSE

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

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

addComments

public LayerSet addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

See Also:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public LayerSet addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public LayerSet addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

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)