Package org.web3d.x3d.sai.Geometry3D

Interface Sphere

All Superinterfaces:

X3DGeometryNode, X3DNode

All Known Implementing Classes:

Sphere

public interface Sphere
extends X3DGeometryNode

Sphere is a geometry node, representing a perfectly round geometrical object that is the surface of a completely round ball.

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. Sphere node tooltip: [X3DGeometryNode] Sphere is a geometry node, representing a perfectly round geometrical object that is the surface of a completely round ball.

• Hint: Sphere https://en.wikipedia.org/wiki/Sphere
• Hint: insert a Shape node before adding geometry or Appearance.

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

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.
float	getRadius()	Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named radius.
boolean	getSolid()	Provide boolean value from initializeOnly SFBool field named solid.
Sphere	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
Sphere	setRadius(float newValue)	Accessor method to assign float value to initializeOnly SFFloat field named radius.
Sphere	setSolid(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named solid.

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 X3DGeometryNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

Sphere 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 X3DGeometryNode

Specified by:

setMetadata in interface X3DNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

getRadius

float getRadius()

Provide float value within allowed range of (0,infinity) from initializeOnly SFFloat field named radius.

Tooltip: (0,+infinity) Size in meters.

• Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, avoiding the need for potentially expensive tessellation at run time.
• Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.

Returns:

value of radius field

setRadius

Sphere setRadius(float newValue)

Accessor method to assign float value to initializeOnly SFFloat field named radius.

Tooltip: (0,+infinity) Size in meters.

• Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, avoiding the need for potentially expensive tessellation at run time.
• Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.

Parameters:

newValue - is new value for the radius field.

Returns:

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

getSolid

boolean getSolid()

Provide boolean value from initializeOnly SFBool field named solid.

Tooltip: Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off).

• Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick).
• Warning: default value true can completely hide geometry if viewed from wrong side!
• Hint: if in doubt, use solid='false' for maximum visibility.
• Warning: solid false not supported in VRML97.
• Hint: accessType relaxed to inputOutput in order to support animation and visualization.

Returns:

value of solid field

setSolid

Sphere setSolid(boolean newValue)

Accessor method to assign boolean value to initializeOnly SFBool field named solid.

Tooltip: Setting solid true means draw only one side of polygons (backface culling on), setting solid false means draw both sides of polygons (backface culling off).

• Hint: mnemonic "this geometry is solid like a brick" (you don't render the inside of a brick).
• Warning: default value true can completely hide geometry if viewed from wrong side!
• Hint: if in doubt, use solid='false' for maximum visibility.
• Warning: solid false not supported in VRML97.
• Hint: accessType relaxed to inputOutput in order to support animation and visualization.

Parameters:

newValue - is new value for the solid field.

Returns:

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