Package org.web3d.x3d.sai.Geometry2D

Interface Circle2D

All Superinterfaces:

X3DGeometryNode, X3DNode

All Known Implementing Classes:

Circle2D

public interface Circle2D
extends X3DGeometryNode

Circle2D is a geometry node that defines a linear X-Y circle with center (0,0) in X-Y plane.

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. Circle2D node tooltip: [X3DGeometryNode] Circle2D is a geometry node that defines a linear X-Y circle with center (0,0) in X-Y plane.

• Hint: insert a Shape node before adding geometry or Appearance.
• Warning: requires X3D profile='Full' or else include <component name='Geometry2D' level='2'/> Examples: X3D Example Archives, X3D for Web Authors, Chapter 10 Geometry 2D https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter10Geometry2D

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: Circle2D
• X3D Tooltips: Circle2D
• 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.
Circle2D	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
Circle2D	setRadius(float newValue)	Accessor method to assign float value to initializeOnly SFFloat field named radius.

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

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

Circle2D - 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) circle radius.

• 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

Circle2D setRadius(float newValue)

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

Tooltip: (0,+infinity) circle radius.

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

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