Class ProtoInstance

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Core.ProtoInstance

All Implemented Interfaces:

X3DChildNode, X3DNode, X3DPrototypeInstance

public class ProtoInstance
extends X3DConcreteNode
implements X3DPrototypeInstance, X3DChildNode

ProtoInstance can override field default values via fieldValue initializations. Non-recursive nested ProtoInstance and ProtoDeclare statements are allowed within a ProtoDeclare.

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. ProtoInstance statement tooltip: ProtoInstance creates an instance node of a locally or externally declared prototype definition. ProtoDeclare/ExternProtoDeclare definitions are abstract, corresponding ProtoInstance nodes are concrete. ProtoInstance nodes typically contain fieldValue statements to override default field values defined in the original ProtoDeclare statement.

• Hint: the node type of a ProtoInstance exactly matches the first node in the corresponding ProtoDeclare/ProtoBody declaration.
• Warning: be sure to correctly set the containerField value to match the intended field in the parent node.
• Warning: do not mismatch node types when placing a ProtoInstance in a scene graph. Most validation tools will not catch this error.
• Hint: scene authors can override default initializations of prototype fields by including contained <fieldValue> elements.
• Hint: Nested ProtoInstance and ProtoDeclare statements are allowed within a ProtoDeclare/ProtoBody.
• Hint: if contained within a ProtoDeclare, then a ProtoInstance node can also contain IS/connect statements for other defined fields.
• Warning: a ProtoInstance node may not be instantiated inside its own ProtoDeclare or ExternProtoDeclare declaration (i.e. recursive prototypes are illegal).
• Warning: the local context of each ProtoInstance node must match the node type of the first node in the original ProtoDeclare declaration.
• Warning: ProtoInstance substitution for a Metadata* node might not validate. Workaround: put metadata-typed ProtoInstance nodes as contained values within a parent MetadataSet node.
• Hint: X3D Scene Authoring Hints, Inlines and Prototypes https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#InlinesPrototypes
• Hint: X3D Architecture 4.4.4 Prototype semantics, https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/concepts.html#PROTOdefinitionsemantics Examples: X3D Example Archives, X3D for Web Authors, Chapter 14 Prototypes https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT	String constant COMPONENT defines X3D component for the ProtoInstance element: Core
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
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 Core component level for this element: 2
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: ProtoInstance.
static final String	NAME_DEFAULT_VALUE	SFString field named name has default value equal to an empty string.

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

containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

Constructor	Description
ProtoInstance()	Constructor for ProtoInstance to initialize member variables with default values.
ProtoInstance(String prototypeName)	Utility constructor that assigns ProtoInstance name after initializing member variables with default values.
ProtoInstance(String prototypeName, String DEFlabel)	Utility constructor that assigns ProtoInstance prototypeName and DEF after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
ProtoInstance	addComments(String newComment)	Add comment as String to contained commentsList.
ProtoInstance	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
ProtoInstance	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
ProtoInstance	addFieldValue(fieldValue newFieldValue)	Add fieldValue
ProtoInstance	clearFieldValue()	Utility method to clear MFNode value of fieldValueList field.
void	clearFieldValues()	Clear all fieldValues
ProtoInstance	clearIS()	Utility method to clear SFNode value of IS field.
ProtoInstance	clearMetadata()	Utility method to clear SFNode value of metadata field.
X3DConcreteElement	findElementByNameValue(String nameValue)	Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteElement	findElementByNameValue(String nameValue, String elementName)	Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
fieldValue	findFieldValueByName(String fieldValueName)	Find contained fieldValue statement by name, if present.
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.
final String	getComponent()	Defines X3D component for the ProtoInstance element: Core
final int	getComponentLevel()	Provides default X3D component level for this element: 2
String	getContainerField()	Utility method that provides ProtoInstance containerField value Hint: ProtoInstance containerField is important for determining parent-child node relationships.
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: ProtoInstance
ExternProtoDeclare	getExternProtoDeclare()	Provide corresponding ExternProtoDeclare with same name if connected in this scene graph.
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
ArrayList<fieldValue>	getFieldValueList()	Provide array of fieldValue results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field fieldValue.
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	getName()	Provide String value from inputOutput SFString field named name.
String	getNodeType()	This method helps determine node type of ProtoInstance by inspecting first node within corresponding ProtoDeclare ProtoBody.
String	getOriginalName()	Utility method to find original ProtoInstance name if this ProtoInstance is a USE node (which does not include name).
ProtoDeclare	getProtoDeclare()	Provide corresponding ProtoDeclare with same name if connected in this scene graph.
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	hasExternProtoDeclare()	Determine whether a corresponding ExternProtoDeclare with same name is connected in this scene graph.
boolean	hasFieldValue()	Indicate whether an object is available for inputOutput MFNode field fieldValueList.
boolean	hasFieldValue(String fieldValueName)	Determine if fieldValue statement is present.
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	hasProtoDeclare()	Determine whether a corresponding ProtoDeclare with same name is connected in this scene graph.
final void	initialize()	Initialize all member variables to default values.
boolean	removeFieldValue(String fieldValueName)	Remove a fieldValue by name from contained fieldValueList
boolean	removeFieldValue(fieldValue fieldValueToRemove)	Remove a fieldValue from contained fieldValueList
ProtoInstance	setContainerField(String containerFieldName)	Utility method that assigns ProtoInstance containerField value Hint: ProtoInstance containerField is important for determining parent-child node relationships.
final ProtoInstance	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
ProtoInstance	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final ProtoInstance	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
ProtoInstance	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final ProtoInstance	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
ProtoInstance	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
ProtoInstance	setFieldValue(fieldValue newValue)	Set single child fieldValue node, replacing prior array of existing nodes (if any).
ProtoInstance	setFieldValueList(ArrayList<fieldValue> newValue)	Accessor method to assign fieldValue array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field fieldValue.
final ProtoInstance	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
ProtoInstance	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
ProtoInstance	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
ProtoInstance	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
ProtoInstance	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
final ProtoInstance	setName(String newValue)	Accessor method to assign String value to inputOutput SFString field named name.
ProtoInstance	setName(SFString newValue)	Assign typed object value to SFString name field, similar to setName(String).
final ProtoInstance	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
ProtoInstance	setUSE(ProtoInstance DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
ProtoInstance	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
String	validate()	Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

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

getContainerFieldAllowedValues, getContainerFieldOverride, 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: ProtoInstance.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

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

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

NAME_DEFAULT_VALUE

public static final String NAME_DEFAULT_VALUE

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

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, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "children";
containerField_ALLOWED_VALUES = {"children" }; type xs:NMTOKEN

See Also:

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

Constructor Details

ProtoInstance

public ProtoInstance()

Constructor for ProtoInstance to initialize member variables with default values.

ProtoInstance

public ProtoInstance(String prototypeName)

Utility constructor that assigns ProtoInstance name after initializing member variables with default values.

Parameters:

prototypeName - initial name for this ProtoInstance statement

ProtoInstance

public ProtoInstance(String prototypeName,
 String DEFlabel)

Utility constructor that assigns ProtoInstance prototypeName and DEF after initializing member variables with default values.

Parameters:

prototypeName - initial name for this ProtoInstance statement

DEFlabel - unique DEF name for this X3D node

Method Details

getElementName

public final String getElementName()

Provides name of this element: ProtoInstance

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the ProtoInstance 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: 2

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 statement

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 statement

Returns:

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

See Also:

• ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

getContainerFieldDefault

public final String getContainerFieldDefault()

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

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

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

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getFieldValueList

public ArrayList<fieldValue> getFieldValueList()

Provide array of fieldValue results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field fieldValue.

Tooltip: Include fieldValue statements if this ProtoInstance overrides default values in any of the original field declarations. *


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

Returns:

value of fieldValue field

See Also:

• fieldValue

setFieldValueList

public ProtoInstance setFieldValueList(ArrayList<fieldValue> newValue)

Accessor method to assign fieldValue array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field fieldValue.

Tooltip: Include fieldValue statements if this ProtoInstance overrides default values in any of the original field declarations. *


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

Parameters:

newValue - is new value for the fieldValue field.

Returns:

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

setFieldValue

public ProtoInstance setFieldValue(fieldValue newValue)

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

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

Parameters:

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

Returns:

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

clearFieldValue

public ProtoInstance clearFieldValue()

Utility method to clear MFNode value of fieldValueList field. This method does not initialize withFIELDVALUE_DEFAULT_VALUE.

Returns:

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

hasFieldValue

public boolean hasFieldValue()

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

Returns:

whether a concrete statement array or CommentsBlock is available.

See Also:

• getFieldValueList()

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

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

Utility method to clear SFNode value of IS field.

Returns:

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

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DPrototypeInstance

Returns:

value of metadata field

See Also:

• getMetadataProtoInstance()
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public ProtoInstance 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 X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DPrototypeInstance

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

• setMetadata(ProtoInstance)
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public ProtoInstance clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

getName

public String getName()

Provide String value from inputOutput SFString field named name.

Tooltip: name of the prototype node being instanced.

• Hint: must match name of corresponding ProtoDeclare or ExternProtoDeclare in this scene.
• Warning: name must be specified unless this ProtoInstance is a USE node. Do not include name with ProtoInstance USE since it is duplicative (i.e. name is already defined in the DEF instance) and this approach avoids potential name mismatches.
• 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:

getName in class X3DConcreteNode

Returns:

value of name field

setName

public final ProtoInstance setName(String newValue)

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

Tooltip: name of the prototype node being instanced.

• Hint: must match name of corresponding ProtoDeclare or ExternProtoDeclare in this scene.
• Warning: name must be specified unless this ProtoInstance is a USE node. Do not include name with ProtoInstance USE since it is duplicative (i.e. name is already defined in the DEF instance) and this approach avoids potential name mismatches.
• 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

@see X3D Scene Authoring Hints: Naming Conventions

Parameters:

newValue - is new value for the name field.

Returns:

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

setName

public ProtoInstance setName(SFString newValue)

Assign typed object value to SFString name field, similar to setName(String).

Parameters:

newValue - is new value for the name field.

Returns:

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

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

setDEF

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

ProtoInstance - 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.
• Warning: do not define a name field in a USE node, the correct name can already be found in the original ProtoInstance DEF node.

Overrides:

getUSE in class X3DConcreteNode

Returns:

value of USE field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setUSE

public final ProtoInstance 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.
• Warning: do not define a name field in a USE node, the correct name can already be found in the original ProtoInstance DEF node.

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:

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

setUSE

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

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

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

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

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

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

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

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

setUSE

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

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

getContainerField

public String getContainerField()

Utility method that provides ProtoInstance containerField value Hint: ProtoInstance containerField is important for determining parent-child node relationships.

Returns:

containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3DConcreteNode.setContainerFieldOverride(String)
• X3D Tooltips: ProtoInstance.containerField
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField

setContainerField

public ProtoInstance setContainerField(String containerFieldName)

Utility method that assigns ProtoInstance containerField value Hint: ProtoInstance containerField is important for determining parent-child node relationships.

Parameters:

containerFieldName - overriding value

Returns:

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

See Also:

• X3DConcreteNode.setContainerFieldOverride(String)
• X3D Tooltips: ProtoInstance.containerField
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField

getOriginalName

public String getOriginalName()

Utility method to find original ProtoInstance name if this ProtoInstance is a USE node (which does not include name).

Returns:

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

hasProtoDeclare

public boolean hasProtoDeclare()

Determine whether a corresponding ProtoDeclare with same name is connected in this scene graph.

Returns:

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

See Also:

• hasExternProtoDeclare()
• getProtoDeclare()
• getExternProtoDeclare()

hasExternProtoDeclare

public boolean hasExternProtoDeclare()

Determine whether a corresponding ExternProtoDeclare with same name is connected in this scene graph.

Returns:

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

See Also:

• hasProtoDeclare()
• getProtoDeclare()
• getExternProtoDeclare()

getProtoDeclare

public ProtoDeclare getProtoDeclare()

Provide corresponding ProtoDeclare with same name if connected in this scene graph.

Returns:

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

See Also:

• hasProtoDeclare()
• hasExternProtoDeclare()
• getExternProtoDeclare()

getExternProtoDeclare

public ExternProtoDeclare getExternProtoDeclare()

Provide corresponding ExternProtoDeclare with same name if connected in this scene graph.

Returns:

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

See Also:

• hasProtoDeclare()
• hasExternProtoDeclare()
• getProtoDeclare()

getNodeType

public String getNodeType()

This method helps determine node type of ProtoInstance by inspecting first node within corresponding ProtoDeclare ProtoBody.

Returns:

name of X3D node corresponding to node type for this ProtoInstance statement

See Also:

• X3D Abstract Specification: 4.4.4.3 PROTO definition semantics
• ProtoDeclare.getNodeType()
• ProtoBody.getNodeType()
• ExternProtoDeclare.getNodeType()
• Scene

addComments

public ProtoInstance addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

ProtoInstance - 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 ProtoInstance addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public ProtoInstance addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

addFieldValue

public ProtoInstance addFieldValue(fieldValue newFieldValue)

Add fieldValue

Parameters:

newFieldValue - is fieldValue to add

Returns:

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

findFieldValueByName

public fieldValue findFieldValueByName(String fieldValueName)

Find contained fieldValue statement by name, if present.

Parameters:

fieldValueName - is name attribute for fieldValue of interest

Returns:

fieldValue reference of interest, null otherwise

removeFieldValue

public boolean removeFieldValue(fieldValue fieldValueToRemove)

Remove a fieldValue from contained fieldValueList

Parameters:

fieldValueToRemove - matching fieldValue of interest

Returns:

whether fieldValue was removed

See Also:

• removeFieldValue(String)

removeFieldValue

public boolean removeFieldValue(String fieldValueName)

Remove a fieldValue by name from contained fieldValueList

Parameters:

fieldValueName - matching fieldValue of interest

Returns:

whether fieldValue was removed

See Also:

• removeFieldValue(fieldValue)

clearFieldValues

public void clearFieldValues()

Clear all fieldValues

hasFieldValue

public boolean hasFieldValue(String fieldValueName)

Determine if fieldValue statement is present.

Parameters:

fieldValueName - is name attribute for fieldValue of interest

Returns:

whether fieldValue is found