org.web3d.x3d.sai.Geometry2D

Interface Arc2D

All Superinterfaces:

X3DGeometryNode, X3DNode

All Known Implementing Classes:

Arc2DObject

public interface Arc2D
extends X3DGeometryNode

Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: [X3DGeometryNode] Arc2D is a line-based geometry node that defines a linear circular arc with center (0,0) in X-Y plane, with angles measured starting at positive x-axis and sweeping towards positive y-axis.

• Hint: Material emissiveColor in corresponding Appearance is used for rendering lines.
• Warning: lines are not lit, are not texture-mapped, and do not participate in collision detection.
• Warning: use a different Material emissiveColor than the Background color, otherwise geometry is invisible.
• Hint: adding LineProperties to the corresponding Appearance node can modify the rendering style of these lines.
• Hint: insert a Shape node before adding geometry or Appearance.
• Warning: requires X3D profile='Full' or else include <component name='Geometry2D' level='2'/> Example: X3D Example Archives, X3D for Web Authors, Chapter 10 Geometry 2D
  https://x3dgraphics.com/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: TODO, X3D Abstract Specification: Arc2D, X3D Tooltips: Arc2D, X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method and Description
float	getEndAngle() Provide float value unit axis, angle (in radians) within allowed range of (-6.2832,6.2832) from initializeOnly SFFloat field named endAngle.
X3DMetadataObject	getMetadata() Provide 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.
float	getStartAngle() Provide float value unit axis, angle (in radians) within allowed range of (-6.2832,6.2832) from initializeOnly SFFloat field named startAngle.
Arc2D	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
Arc2D	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
Arc2D	setEndAngle(float newValue) Assign float value unit axis, angle (in radians) within allowed range of (-6.2832,6.2832) to initializeOnly SFFloat field named endAngle.
Arc2D	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
Arc2D	setRadius(float newValue) Assign float value within allowed range of (0,infinity) to initializeOnly SFFloat field named radius.
Arc2D	setStartAngle(float newValue) Assign float value unit axis, angle (in radians) within allowed range of (-6.2832,6.2832) to initializeOnly SFFloat field named startAngle.
Arc2D	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.

Method Detail

getEndAngle

float getEndAngle()

Provide float value unit axis, angle (in radians) within allowed range of (-6.2832,6.2832) from initializeOnly SFFloat field named endAngle.

Tooltip: [0,2pi] Arc extends from startAngle counterclockwise to endAngle, in radians.

• Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor Transform scale instead.
• Hint:
  https://en.wikipedia.org/wiki/Radian

Returns:

value of endAngle field

setEndAngle

Arc2D setEndAngle(float newValue)

Assign float value unit axis, angle (in radians) within allowed range of (-6.2832,6.2832) to initializeOnly SFFloat field named endAngle.

Tooltip: [0,2pi] Arc extends from startAngle counterclockwise to endAngle, in radians. Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor Transform scale instead. Hint: https://en.wikipedia.org/wiki/Radian

Parameters:

newValue - is new value for the endAngle field.

Returns:

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

getMetadata

X3DMetadataObject getMetadata()

Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field 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

Arc2D setMetadata(X3DMetadataObject newValue)

Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in interface X3DGeometryNode

Specified by:

setMetadata in interface X3DNode

Parameters:

newValue - is new value for the metadata field.

Returns:

Arc2D - 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, of which the arc is a portion.

• Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor Transform scale instead.

Returns:

value of radius field

setRadius

Arc2D setRadius(float newValue)

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

Tooltip: (0,+infinity) circle radius, of which the arc is a portion. Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor Transform scale instead.

Parameters:

newValue - is new value for the radius field.

Returns:

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

getStartAngle

float getStartAngle()

Provide float value unit axis, angle (in radians) within allowed range of (-6.2832,6.2832) from initializeOnly SFFloat field named startAngle.

Tooltip: [0,2pi] Arc extends from startAngle counterclockwise to endAngle, in radians.

• Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor Transform scale instead.
• Hint:
  https://en.wikipedia.org/wiki/Radian

Returns:

value of startAngle field

setStartAngle

Arc2D setStartAngle(float newValue)

Assign float value unit axis, angle (in radians) within allowed range of (-6.2832,6.2832) to initializeOnly SFFloat field named startAngle.

Tooltip: [0,2pi] Arc extends from startAngle counterclockwise to endAngle, in radians. Warning: simple-geometry dimensions are initializeOnly and cannot be changed after initial creation, for size animation use an ancestor Transform scale instead. Hint: https://en.wikipedia.org/wiki/Radian

Parameters:

newValue - is new value for the startAngle field.

Returns:

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

setDEF

Arc2D setDEF(java.lang.String newValue)

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 http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in interface X3DGeometryNode

Specified by:

setDEF in interface X3DNode

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setUSE

Arc2D setUSE(java.lang.String newValue)

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.

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

Specified by:

setUSE in interface X3DNode

Parameters:

newValue - is new value for the USE field.

Returns:

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

setCssClass

Arc2D setCssClass(java.lang.String newValue)

Assign String value to inputOutput SFString field named class.

Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS

Specified by:

setCssClass in interface X3DGeometryNode

Specified by:

setCssClass in interface X3DNode

Parameters:

newValue - is new value for the class field.

Returns:

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