Package org.web3d.x3d.sai.Core

Interface WorldInfo

All Superinterfaces:

X3DChildNode, X3DInfoNode, X3DNode

All Known Implementing Classes:

WorldInfo

public interface WorldInfo
extends X3DInfoNode

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.

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. WorldInfo node tooltip: [X3DInfoNode] WorldInfo incldes a browsesr-displayable title and persistent string information about an X3D scene. For X3D4 models, WorldInfo can also contain a single MetadataSet node with further metadata information about the 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: WorldInfo is part of Core component and Core profile. https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#t-CoresupportLevels
• Hint: X3D for Web Authors, Chapter 15, Metadata Information https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter15-Metadata/Chapter15-MetadataInformation.html

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

• SAI Java Specification
• X3D Abstract Specification: WorldInfo
• X3D Tooltips: WorldInfo
• X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method	Description
String[]	getInfo()	Provide array of String results from inputOutput MFString field named info.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
String	getTitle()	Provide String value from inputOutput SFString field named title.
WorldInfo	setInfo(String[] newValue)	Accessor method to assign String array to inputOutput MFString field named info.
WorldInfo	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
WorldInfo	setTitle(String newValue)	Accessor method to assign String value to inputOutput SFString field named title.

Method Details

getInfo

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 "https://www.web3d.org" "https://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).

Returns:

value of info field

setInfo

WorldInfo setInfo(String[] newValue)

Accessor method to 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 "https://www.web3d.org" "https://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).

Parameters:

newValue - is new value for the info field.

Returns:

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

getMetadata

X3DMetadataObject getMetadata()

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

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

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:

• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

WorldInfo setMetadata(X3DMetadataObject newValue)

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

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

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DInfoNode

Specified by:

setMetadata in interface X3DNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

getTitle

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

Returns:

value of title field

setTitle

WorldInfo setTitle(String newValue)

Accessor method to 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).

Parameters:

newValue - is new value for the title field.

Returns:

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