Package org.web3d.x3d.sai.PointingDeviceSensor

Interface SphereSensor

All Superinterfaces:

X3DChildNode, X3DDragSensorNode, X3DNode, X3DPointingDeviceSensorNode, X3DSensorNode

All Known Implementing Classes:

SphereSensor

public interface SphereSensor
extends X3DDragSensorNode

SphereSensor converts pointing device motion into a spherical rotation about the origin of the local coordinate system.

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. SphereSensor node tooltip: [X3DDragSensorNode] SphereSensor converts pointing device motion into a spherical rotation about the origin of the local coordinate system.

• Hint: this sensor detects user interactions affecting peer nodes and their child geometry.
• Hint: add semi-transparent surrounding geometry to see the effect of the sensor.
• Hint: X3D Architecture 20.2.1 Overview of pointing device sensors https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/pointingDeviceSensor.html#OverviewOfPointingDeviceSensors
• Hint: X3D Architecture 20.2.2 Drag sensors https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/pointingDeviceSensor.html#DragSensors
• Hint: X3D Architecture 20.2.3 Activating and manipulating pointing device sensors https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/pointingDeviceSensor.html#Activatingandmanipulating

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

Method Summary

Modifier and Type	Method	Description
boolean	getAutoOffset()	Provide boolean value from inputOutput SFBool field named autoOffset.
String	getDescription()	Provide String value from inputOutput SFString field named description.
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
boolean	getIsActive()	Provide boolean value from outputOnly SFBool field named isActive.
boolean	getIsOver()	Provide boolean value from outputOnly SFBool field named isOver.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float[]	getOffset()	Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named offset.
float[]	getRotation()	Provide array of 4-tuple float results unit axis, angle (in radians) from outputOnly SFRotation field named rotation_changed.
float[]	getTrackPoint()	Provide array of 3-tuple float results from outputOnly SFVec3f field named trackPoint_changed.
SphereSensor	setAutoOffset(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named autoOffset.
SphereSensor	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
SphereSensor	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
SphereSensor	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
SphereSensor	setOffset(float[] newValue)	Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named offset.

Method Details

getAutoOffset

boolean getAutoOffset()

Provide boolean value from inputOutput SFBool field named autoOffset.

Tooltip: Determines whether previous offset values are remembered/accumulated. *

Specified by:

getAutoOffset in interface X3DDragSensorNode

Returns:

value of autoOffset field

setAutoOffset

SphereSensor setAutoOffset(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named autoOffset.

Tooltip: Determines whether previous offset values are remembered/accumulated. *

Specified by:

setAutoOffset in interface X3DDragSensorNode

Parameters:

newValue - is new value for the autoOffset field.

Returns:

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

getDescription

String getDescription()

Provide String value from inputOutput SFString field named description.

Tooltip: Author-provided prose that describes intended purpose of this node.

• Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable.
• 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).

Specified by:

getDescription in interface X3DDragSensorNode

Specified by:

getDescription in interface X3DPointingDeviceSensorNode

Specified by:

getDescription in interface X3DSensorNode

Returns:

value of description field

setDescription

SphereSensor setDescription(String newValue)

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

Tooltip: Author-provided prose that describes intended purpose of this node.

• Hint: include space characters since a description is not a DEF identifier. Write short phrases that make descriptions clear and readable.
• 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).

Specified by:

setDescription in interface X3DDragSensorNode

Specified by:

setDescription in interface X3DPointingDeviceSensorNode

Specified by:

setDescription in interface X3DSensorNode

Parameters:

newValue - is new value for the description field.

Returns:

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

getEnabled

boolean getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation. *

Specified by:

getEnabled in interface X3DDragSensorNode

Specified by:

getEnabled in interface X3DPointingDeviceSensorNode

Specified by:

getEnabled in interface X3DSensorNode

Returns:

value of enabled field

setEnabled

SphereSensor setEnabled(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation. *

Specified by:

setEnabled in interface X3DDragSensorNode

Specified by:

setEnabled in interface X3DPointingDeviceSensorNode

Specified by:

setEnabled in interface X3DSensorNode

Parameters:

newValue - is new value for the enabled field.

Returns:

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

getIsActive

boolean getIsActive()

Provide boolean value from outputOnly SFBool field named isActive.

Tooltip: Select geometry by activating the pointing device (for example, clicking the mouse) to generate isActive events. Output event isActive=true is sent when geometry is selected (for example, when primary mouse button is pressed), output event isActive=false is sent when geometry is deselected (for example, when primary mouse button is released).

• Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

Specified by:

getIsActive in interface X3DDragSensorNode

Specified by:

getIsActive in interface X3DPointingDeviceSensorNode

Specified by:

getIsActive in interface X3DSensorNode

Returns:

value of isActive field

getIsOver

boolean getIsOver()

Provide boolean value from outputOnly SFBool field named isOver.

Tooltip: Hover over geometry by aiming the mouse (or pointing device) to generate isOver events. Sensor sends output event isOver=true event when pointing device moves over sensor's geometry, and later sends output event isOver=false event when pointing device moves off.

• Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

Specified by:

getIsOver in interface X3DDragSensorNode

Specified by:

getIsOver in interface X3DPointingDeviceSensorNode

Returns:

value of isOver field

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 X3DChildNode

Specified by:

getMetadata in interface X3DDragSensorNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DPointingDeviceSensorNode

Specified by:

getMetadata in interface X3DSensorNode

Returns:

value of metadata field

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

SphereSensor 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 X3DChildNode

Specified by:

setMetadata in interface X3DDragSensorNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DPointingDeviceSensorNode

Specified by:

setMetadata in interface X3DSensorNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

getOffset

float[] getOffset()

Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named offset.

Tooltip: Sends event and remembers last value sensed.

• Warning: ROUTE connecting rotation_changed to set_offset creates a self-reinforcing positive feedback loop and results in unmanageable response.

Returns:

value of offset field

setOffset

SphereSensor setOffset(float[] newValue)

Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named offset.

Tooltip: Sends event and remembers last value sensed.

• Warning: ROUTE connecting rotation_changed to set_offset creates a self-reinforcing positive feedback loop and results in unmanageable response.

Parameters:

newValue - is new value for the offset field.

Returns:

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

getRotation

float[] getRotation()

Provide array of 4-tuple float results unit axis, angle (in radians) from outputOnly SFRotation field named rotation_changed.

Tooltip: rotation_changed events equal sum of relative bearing changes plus offset value.

• Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

Returns:

value of rotation_changed field

getTrackPoint

float[] getTrackPoint()

Provide array of 3-tuple float results from outputOnly SFVec3f field named trackPoint_changed.

Tooltip: trackPoint_changed events give intersection point of bearing with sensor's virtual geometry.

• Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
• Warning: trackPoint_changed events represent unclamped intersection points on plane surface. Browsers can interpret drags off of the surface in various ways. Note that translation_changed events are clamped by minPosition/maxPosition and thus may be preferable.

Specified by:

getTrackPoint in interface X3DDragSensorNode

Returns:

value of trackPoint_changed field