Package org.web3d.x3d.sai.Core

Interface MetadataFloat

All Superinterfaces:

X3DMetadataObject, X3DNode

All Known Implementing Classes:

MetadataFloat

public interface MetadataFloat
extends X3DNode, X3DMetadataObject

The metadata provided by this node is contained in the single-precision floating point numbers of the value field.

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. MetadataFloat node tooltip: [X3DNode,X3DMetadataObject] MetadataFloat contains a typed list of values providing metadata information about its parent node. Further information about this specific Metadata* node may be provided by a single child Metadata* node with containerField="metadata".

• Hint: typically use containerField="value" if the parent node is MetadataSet.
• Warning: default containerField="metadata" in X3D 3 changed to default containerField="value" in X3D 4.0, allowing construction of much terser MetadataSet vocabulary structures.
• Hint: explicitly defining containerField for Metadata nodes is always allowed and also unambiguous across each version of X3D.
• Hint: each of the Metadata nodes are allowed as top-level root nodes in a scene, if doing that be sure to explicitly define containerField='metadata'. https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-DIS/Part01/concepts.html#Rootnodes
• Warning: Metadata nodes can only contain other Metadata nodes.
• Hint: if present, an IS statement is the first child within any other node.
• Hint: an IS statement precedes any sibling Metadata* node, which in turn precedes any other sibling nodes.
• Hint: The choice of MetadataDouble versus MetadataFloat usually depends on the relevant tool utilizing the value, or else the relevant metadata reference defining the value.
• 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 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: MetadataFloat
• X3D Tooltips: MetadataFloat
• X3D Scene Authoring Hints: Metadata

Method Summary

Modifier and Type	Method	Description
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	getReference()	Provide String value from inputOutput SFString field named reference.
float[]	getValue()	Provide array of float results from inputOutput MFFloat field named value.
MetadataFloat	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
MetadataFloat	setName(String newValue)	Accessor method to assign String value to inputOutput SFString field named name.
MetadataFloat	setReference(String newValue)	Accessor method to assign String value to inputOutput SFString field named reference.
MetadataFloat	setValue(float[] newValue)	Accessor method to assign float array to inputOutput MFFloat field named value.

Method Details

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 X3DNode

Returns:

value of metadata field

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

MetadataFloat 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 X3DNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

getName

String getName()

Provide String value from inputOutput SFString field named name.

Tooltip: Depending on the metadata vocabulary, the attribute name is usually required for metadata nodes.

• Warning: name field is not included if this instance is a USE node, in order to avoid potential 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

Specified by:

getName in interface X3DMetadataObject

Returns:

value of name field

setName

MetadataFloat setName(String newValue)

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

Tooltip: Depending on the metadata vocabulary, the attribute name is usually required for metadata nodes.

• Warning: name field is not included if this instance is a USE node, in order to avoid potential 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

Specified by:

setName in interface X3DMetadataObject

Parameters:

newValue - is new value for the name field.

Returns:

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

getReference

String getReference()

Provide String value from inputOutput SFString field named reference.

Tooltip: Reference to the metadata standard or definition defining this particular metadata value. *

Specified by:

getReference in interface X3DMetadataObject

Returns:

value of reference field

setReference

MetadataFloat setReference(String newValue)

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

Tooltip: Reference to the metadata standard or definition defining this particular metadata value. *

Specified by:

setReference in interface X3DMetadataObject

Parameters:

newValue - is new value for the reference field.

Returns:

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

getValue

float[] getValue()

Provide array of float results from inputOutput MFFloat field named value.

Tooltip: The value attribute is a strictly typed data array providing relevant metadata information.

• 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 value field

setValue

MetadataFloat setValue(float[] newValue)

Accessor method to assign float array to inputOutput MFFloat field named value.

Tooltip: The value attribute is a strictly typed data array providing relevant metadata information.

• 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 value field.

Returns:

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