org.web3d.x3d.jsail.Core

Class WorldInfoObject

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Core.WorldInfoObject

All Implemented Interfaces:

WorldInfo, X3DChildNode, X3DInfoNode, X3DNode

public class WorldInfoObject
extends X3DConcreteNode
implements WorldInfo

WorldInfo contains a title and simple persistent metadata information about an X3D scene. This node is strictly for documentation purposes and has no effect on the visual appearance or behaviour of the world.

X3D node tooltip: [X3DInfoNode] WorldInfo contains a title and persistent documentation or simple metadata information about an X3D scene.

• Hint: comments are not readable when a model file is loaded for viewing, but WorldInfo and Metadata* nodes are persistent and inspectable at run time.
• Hint: X3D for Web Authors, Chapter 15, Metadata Information
  http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter15-Metadata/Chapter15-MetadataInformation.html

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: WorldInfo, X3D Tooltips: WorldInfo, X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT String constant COMPONENT defines X3D component for the WorldInfo element: Core
static java.lang.String	containerField_DEFAULT_VALUE containerField describes typical field relationship of a node to its parent.
static java.lang.String	fromField_INFO fromField ROUTE name for MFString field named info.
static java.lang.String	fromField_METADATA fromField ROUTE name for SFNode field named metadata.
static java.lang.String	fromField_TITLE fromField ROUTE name for SFString field named title.
static java.util.ArrayList<java.lang.String>	INFO_DEFAULT_VALUE MFString field named info has default value equal to an empty list.
static int	LEVEL Integer constant LEVEL provides default X3D Core component level for this element: 1
static java.lang.String	NAME String constant NAME provides name of this element: WorldInfo.
static java.lang.String	TITLE_DEFAULT_VALUE SFString field named title has default value equal to an empty string.
static java.lang.String	toField_INFO toField ROUTE name for MFString field named info.
static java.lang.String	toField_METADATA toField ROUTE name for SFNode field named metadata.
static java.lang.String	toField_TITLE toField ROUTE name for SFString field named title.

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

CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

validationResult

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
WorldInfoObject	addComments(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.
WorldInfoObject	addComments(java.lang.String newComment) Add comment as String to contained commentsList.
WorldInfoObject	addComments(java.lang.String[] newComments) Add comments as String[] array to contained commentsList.
WorldInfoObject	addInfo(SFStringObject newValue) Add singleton SFStringObject value to MFString info field.
WorldInfoObject	addInfo(java.lang.String newValue) Add singleton String value to MFString info field.
WorldInfoObject	clearInfo() Utility method to clear MFString value of info field.
WorldInfoObject	clearMetadata() Utility method to clear SFNode value of metadata field.
X3DConcreteElement	findElementByNameValue(java.lang.String nameValue) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteElement	findElementByNameValue(java.lang.String nameValue, java.lang.String elementName) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteNode	findNodeByDEF(java.lang.String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
java.lang.String	getAccessType(java.lang.String fieldName) Indicate accessType corresponding to given fieldName.
java.lang.String	getComponent() Defines X3D component for the WorldInfo element: Core
int	getComponentLevel() Provides default X3D component level for this element: 1
java.lang.String	getContainerFieldDefault() containerField describes typical field relationship of a node to its parent.
java.lang.String	getElementName() Provides name of this element: WorldInfo
java.lang.String	getFieldType(java.lang.String fieldName) Indicate type corresponding to given fieldName.
java.lang.String[]	getInfo() Provide array of String results from inputOutput MFString field named info.
java.util.ArrayList<java.lang.String>	getInfoList() Utility method to get ArrayList value of MFString info field, similar to getInfo().
ISObject	getIS() Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
java.lang.String	getTitle() Provide String value from inputOutput SFString field named title.
boolean	hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName) Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
boolean	hasMetadata() Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(java.lang.String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
void	initialize() Initialize all member variables to default values.
WorldInfoObject	setCssClass(SFStringObject newValue) Assign typed object value to SFString cssClass field, similar to setCssClass(String).
WorldInfoObject	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
WorldInfoObject	setDEF(SFStringObject newValue) Assign typed object value to SFString DEF field, similar to setDEF(String).
WorldInfoObject	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
WorldInfoObject	setInfo(java.util.ArrayList<java.lang.String> newValue) Assign ArrayList value of MFString info field, similar to setInfo(String[]).
WorldInfoObject	setInfo(MFStringObject newValue) Assign typed object value to MFString info field, similar to setInfo(String[]).
WorldInfoObject	setInfo(SFStringObject newValue) Assign single SFString object value to MFString info field, similar to setInfo(String[]).
WorldInfoObject	setInfo(java.lang.String newValue) Assign singleton String value to MFString info field, similar to setInfo(String[]).
WorldInfoObject	setInfo(java.lang.String[] newValue) Assign String array to inputOutput MFString field named info.
WorldInfoObject	setIS(ISObject newValue) Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
WorldInfoObject	setMetadata(ProtoInstanceObject newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
WorldInfoObject	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
WorldInfoObject	setTitle(SFStringObject newValue) Assign typed object value to SFString title field, similar to setTitle(String).
WorldInfoObject	setTitle(java.lang.String newValue) Assign String value to inputOutput SFString field named title.
WorldInfoObject	setUSE(SFStringObject newValue) Assign typed object value to SFString USE field, similar to setUSE(String).
WorldInfoObject	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.
WorldInfoObject	setUSE(WorldInfoObject DEFnode) Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
java.lang.String	toStringClassicVRML(int indentLevel) Recursive method to provide ClassicVRML string serialization.
java.lang.String	toStringVRML97(int indentLevel) Recursive method to provide VRML97 string serialization.
java.lang.String	toStringX3D(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
java.lang.String	validate() Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

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

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

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

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

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

String constant NAME provides name of this element: WorldInfo.

See Also:

Constant Field Values

COMPONENT

public static final java.lang.String COMPONENT

String constant COMPONENT defines X3D component for the WorldInfo element: Core

See Also:

Constant Field Values

LEVEL

public static final int LEVEL

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

See Also:

Constant Field Values

INFO_DEFAULT_VALUE

public static final java.util.ArrayList<java.lang.String> INFO_DEFAULT_VALUE

MFString field named info has default value equal to an empty list.

TITLE_DEFAULT_VALUE

public static final java.lang.String TITLE_DEFAULT_VALUE

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

See Also:

Constant Field Values

containerField_DEFAULT_VALUE

public static final java.lang.String containerField_DEFAULT_VALUE

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

See Also:

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

fromField_INFO

public static final java.lang.String fromField_INFO

fromField ROUTE name for MFString field named info.

See Also:

Constant Field Values

toField_INFO

public static final java.lang.String toField_INFO

toField ROUTE name for MFString field named info.

See Also:

Constant Field Values

fromField_METADATA

public static final java.lang.String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

Constant Field Values

toField_METADATA

public static final java.lang.String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

Constant Field Values

fromField_TITLE

public static final java.lang.String fromField_TITLE

fromField ROUTE name for SFString field named title.

See Also:

Constant Field Values

toField_TITLE

public static final java.lang.String toField_TITLE

toField ROUTE name for SFString field named title.

See Also:

Constant Field Values

Constructor Detail

WorldInfoObject

public WorldInfoObject()

Constructor for WorldInfoObject to initialize member variables with default values.

WorldInfoObject

public WorldInfoObject(java.lang.String DEFlabel)

Utility constructor that assigns DEF label after initializing member variables with default values.

Parameters:

DEFlabel - unique DEF name for this X3D node

Method Detail

getElementName

public final java.lang.String getElementName()

Provides name of this element: WorldInfo

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final java.lang.String getComponent()

Defines X3D component for the WorldInfo element: Core

Specified by:

getComponent in class X3DConcreteElement

Returns:

X3D component for this element

getComponentLevel

public final int getComponentLevel()

Provides default X3D component level for this element: 1

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

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

Indicate type corresponding to given fieldName.

Specified by:

getFieldType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

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

See Also:

ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE

getAccessType

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

Indicate accessType corresponding to given fieldName.

Specified by:

getAccessType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

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

See Also:

ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

getContainerFieldDefault

public final java.lang.String getContainerFieldDefault()

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

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

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

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getInfo

public java.lang.String[] getInfo()

Provide array of String results from inputOutput MFString field named info.

Tooltip: Additional information about this model.

• Hint: MFString arrays can have multiple values, so separate each individual string by quote marks
  "http://www.web3d.org"
  "http://www.web3d.org/about" "etc."
• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

getInfo in interface WorldInfo

Returns:

value of info field

getInfoList

public java.util.ArrayList<java.lang.String> getInfoList()

Utility method to get ArrayList value of MFString info field, similar to getInfo().

Returns:

value of info field

setInfo

public WorldInfoObject setInfo(java.lang.String[] newValue)

Assign String array to inputOutput MFString field named info.

Tooltip: Additional information about this model. Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "http://www.web3d.org" "http://www.web3d.org/about" "etc." Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

setInfo in interface WorldInfo

Parameters:

newValue - is new value for the info field.

Returns:

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

setInfo

public WorldInfoObject setInfo(MFStringObject newValue)

Assign typed object value to MFString info field, similar to setInfo(String[]).

Parameters:

newValue - is new value for the info field.

Returns:

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

setInfo

public WorldInfoObject setInfo(SFStringObject newValue)

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

Parameters:

newValue - is new value for the info field.

Returns:

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

setInfo

public WorldInfoObject setInfo(java.lang.String newValue)

Assign singleton String value to MFString info field, similar to setInfo(String[]).

Parameters:

newValue - is new value for the info field.

Returns:

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

setInfo

public WorldInfoObject setInfo(java.util.ArrayList<java.lang.String> newValue)

Assign ArrayList value of MFString info field, similar to setInfo(String[]).

Parameters:

newValue - is new value for the info field.

Returns:

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

clearInfo

public WorldInfoObject clearInfo()

Utility method to clear MFString value of info field.

Returns:

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

addInfo

public WorldInfoObject addInfo(java.lang.String newValue)

Add singleton String value to MFString info field.

Parameters:

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

Returns:

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

See Also:

MFStringObject.cleanupEnumerationValues(String)

addInfo

public WorldInfoObject addInfo(SFStringObject newValue)

Add singleton SFStringObject value to MFString info field.

Parameters:

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

Returns:

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

See Also:

MFStringObject.cleanupEnumerationValues(String)

getMetadata

public X3DMetadataObject getMetadata()

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

Specified by:

getMetadata in interface WorldInfo

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DInfoNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public WorldInfoObject setMetadata(X3DMetadataObject newValue)

Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in interface WorldInfo

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DInfoNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public WorldInfoObject clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

public WorldInfoObject setMetadata(ProtoInstanceObject newValue)

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

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

setMetadata(X3DMetadataObject)

hasMetadata

public boolean hasMetadata()

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

Returns:

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

See Also:

getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes

getTitle

public java.lang.String getTitle()

Provide String value from inputOutput SFString field named title.

Tooltip: title of this world, placed in window title.

• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

getTitle in interface WorldInfo

Returns:

value of title field

setTitle

public WorldInfoObject setTitle(java.lang.String newValue)

Assign String value to inputOutput SFString field named title.

Tooltip: title of this world, placed in window title. Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

setTitle in interface WorldInfo

Parameters:

newValue - is new value for the title field.

Returns:

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

setTitle

public WorldInfoObject setTitle(SFStringObject newValue)

Assign typed object value to SFString title field, similar to setTitle(String).

Parameters:

newValue - is new value for the title field.

Returns:

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

setDEF

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

Assign String value to inputOutput SFString field named DEF.

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

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in interface WorldInfo

Specified by:

setDEF in interface X3DChildNode

Specified by:

setDEF in interface X3DInfoNode

Specified by:

setDEF in interface X3DNode

Specified by:

setDEF in class X3DConcreteNode

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setDEF

public WorldInfoObject setDEF(SFStringObject newValue)

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

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setUSE

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

Assign String value to inputOutput SFString field named USE.

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

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

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

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

Specified by:

setUSE in interface WorldInfo

Specified by:

setUSE in interface X3DChildNode

Specified by:

setUSE in interface X3DInfoNode

Specified by:

setUSE in interface X3DNode

Specified by:

setUSE in class X3DConcreteNode

Parameters:

newValue - is new value for the USE field.

Returns:

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

setUSE

public WorldInfoObject setUSE(SFStringObject newValue)

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

Parameters:

newValue - is new value for the USE field.

Returns:

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

setCssClass

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

Assign String value to inputOutput SFString field named class.

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

Specified by:

setCssClass in interface WorldInfo

Specified by:

setCssClass in interface X3DChildNode

Specified by:

setCssClass in interface X3DInfoNode

Specified by:

setCssClass in interface X3DNode

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

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

See Also:

W3C Cascading Style Sheets

setCssClass

public WorldInfoObject setCssClass(SFStringObject newValue)

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

Parameters:

newValue - is new value for the class field.

Returns:

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

setIS

public WorldInfoObject setIS(ISObject newValue)

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

Specified by:

setIS in class X3DConcreteNode

Parameters:

newValue - is new value for the description field.

Returns:

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

See Also:

X3D Tooltips: IS, X3D Tooltips: connect

getIS

public ISObject getIS()

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

Specified by:

getIS in class X3DConcreteNode

Returns:

current ISObject, if any.

See Also:

X3D Tooltips: IS, X3D Tooltips: connect

setUSE

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

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

addComments

public WorldInfoObject addComments(java.lang.String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

addComments

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

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public WorldInfoObject addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

toStringX3D

public java.lang.String toStringX3D(int indentLevel)

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

Specified by:

toStringX3D in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

X3D string

See Also:

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

toStringClassicVRML

public java.lang.String toStringClassicVRML(int indentLevel)

Recursive method to provide ClassicVRML string serialization.

Specified by:

toStringClassicVRML in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

ClassicVRML string

See Also:

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

toStringVRML97

public java.lang.String toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

Specified by:

toStringVRML97 in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

VRML97 string

See Also:

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

findElementByNameValue

public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)

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

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

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

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

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

Returns:

object reference to found element, null otherwise

See Also:

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

findElementByNameValue

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

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

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

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

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

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

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

Returns:

object reference to found element, null otherwise

See Also:

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

hasElementByNameValue

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

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

Parameters:

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

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

Returns:

whether node is found

See Also:

findElementByNameValue(String, String)

findNodeByDEF

public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)

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

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

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

Specified by:

findNodeByDEF in class X3DConcreteElement

Parameters:

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

Returns:

object reference to found node, null otherwise

See Also:

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

hasNodeByDEF

public boolean hasNodeByDEF(java.lang.String DEFvalue)

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

Parameters:

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

Returns:

whether node is found

See Also:

findNodeByDEF(String)

validate

public java.lang.String validate()

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

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)