Package org.web3d.x3d.sai.Geometry2D
Interface ArcClose2D
- All Superinterfaces:
X3DGeometryNode
,X3DNode
- All Known Implementing Classes:
ArcClose2D
ArcClose2D is a polygonal geometry node that defines a linear circular arc, closed by PIE or CHORD line segments, with center (0,0) in X-Y plane, with angles measured starting at positive x-axis and sweeping towards positive y-axis.
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
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
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.
ArcClose2D node tooltip: [X3DGeometryNode] ArcClose2D is a polygonal geometry node that defines a linear circular arc, closed by PIE or CHORD line segments, with center (0,0) in X-Y plane, with angles measured starting at positive x-axis and sweeping towards positive y-axis.
- 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:
-
Method Summary
Modifier and TypeMethodDescriptionProvide String enumeration value (baseType xs:NMTOKEN) ["PIE" | "CHORD"] from initializeOnly SFString field named closureType.float
Provide float value unit axis, angle (in radians) within allowed range of (-6.2832,6.2832) from initializeOnly SFFloat field named endAngle.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.float
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.float
Provide float value unit axis, angle (in radians) within allowed range of (-6.2832,6.2832) from initializeOnly SFFloat field named startAngle.setClosureType
(String newValue) Accessor method to assign String enumeration value ("PIE" | "CHORD") to initializeOnly SFString field named closureType.setEndAngle
(float newValue) Accessor method to assign float value unit axis, angle (in radians) to initializeOnly SFFloat field named endAngle.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setRadius
(float newValue) Accessor method to assign float value to initializeOnly SFFloat field named radius.setSolid
(boolean newValue) Accessor method to assign boolean value to initializeOnly SFBool field named solid.setStartAngle
(float newValue) Accessor method to assign float value unit axis, angle (in radians) to initializeOnly SFFloat field named startAngle.
-
Method Details
-
getClosureType
String getClosureType()Provide String enumeration value (baseType xs:NMTOKEN) ["PIE" | "CHORD"] from initializeOnly SFString field named closureType.
Tooltip: Defines whether pair of line segments connect to center (PIE), or single line-segment chord connects arc endpoints (CHORD).- Warning: simple-geometry parameters cannot be changed after initial creation.
- Returns:
- value of closureType field
-
setClosureType
Accessor method to assign String enumeration value ("PIE" | "CHORD") to initializeOnly SFString field named closureType.
Tooltip: Defines whether pair of line segments connect to center (PIE), or single line-segment chord connects arc endpoints (CHORD).- Warning: simple-geometry parameters cannot be changed after initial creation.
- Parameters:
newValue
- is new value for the closureType field.- Returns:
ArcClose2D
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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, avoiding the need for potentially expensive tessellation at run time.
- Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
- Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian
- Returns:
- value of endAngle field
-
setEndAngle
Accessor method to assign float value unit axis, angle (in radians) 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, avoiding the need for potentially expensive tessellation at run time.
- Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
- Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian
- Parameters:
newValue
- is new value for the endAngle field.- Returns:
ArcClose2D
- 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 interfaceX3DGeometryNode
- Specified by:
getMetadata
in interfaceX3DNode
- Returns:
- value of metadata field
- See Also:
-
setMetadata
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 interfaceX3DGeometryNode
- Specified by:
setMetadata
in interfaceX3DNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
ArcClose2D
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
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, 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
Accessor method to assign float value 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, 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:
ArcClose2D
- 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
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:
ArcClose2D
- 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, avoiding the need for potentially expensive tessellation at run time.
- Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
- Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian
- Returns:
- value of startAngle field
-
setStartAngle
Accessor method to assign float value unit axis, angle (in radians) 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, avoiding the need for potentially expensive tessellation at run time.
- Hint: for size animation, modify the scale of a parent/ancestor Transform node instead.
- Hint: radian units for angular measure https://en.wikipedia.org/wiki/Radian
- Parameters:
newValue
- is new value for the startAngle field.- Returns:
ArcClose2D
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-