org.web3d.x3d.jsail.PointingDeviceSensor

Class SphereSensorObject

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.PointingDeviceSensor.SphereSensorObject

All Implemented Interfaces:

X3DChildNode, X3DNode, X3DSensorNode, SphereSensor, X3DDragSensorNode, X3DPointingDeviceSensorNode

public class SphereSensorObject
extends X3DConcreteNode
implements SphereSensor

X3D 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
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/pointingsensor.html#OverviewOfPointingDeviceSensors
• Hint: X3D Architecture 20.2.2 Drag sensors
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/pointingsensor.html#DragSensors
• Hint: X3D Architecture 20.2.3 Activating and manipulating pointing device sensors
  http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/pointingsensor.html#Activatingandmanipulating

Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.

See Also:

X3D Abstract Specification: SphereSensor, X3D Tooltips: SphereSensor, X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	AUTOOFFSET_DEFAULT_VALUE SFBool field named autoOffset has default value true (Java syntax) or true (XML syntax).
static java.lang.String	COMPONENT String constant COMPONENT defines X3D component for the SphereSensor element: PointingDeviceSensor
static java.lang.String	containerField_DEFAULT_VALUE containerField describes typical field relationship of a node to its parent.
static java.lang.String	DESCRIPTION_DEFAULT_VALUE SFString field named description has default value equal to an empty string.
static boolean	ENABLED_DEFAULT_VALUE SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
static java.lang.String	fromField_AUTOOFFSET fromField ROUTE name for SFBool field named autoOffset.
static java.lang.String	fromField_DESCRIPTION fromField ROUTE name for SFString field named description.
static java.lang.String	fromField_ENABLED fromField ROUTE name for SFBool field named enabled.
static java.lang.String	fromField_ISACTIVE fromField ROUTE name for SFBool field named isActive.
static java.lang.String	fromField_ISOVER fromField ROUTE name for SFBool field named isOver.
static java.lang.String	fromField_METADATA fromField ROUTE name for SFNode field named metadata.
static java.lang.String	fromField_OFFSET fromField ROUTE name for SFRotation field named offset.
static java.lang.String	fromField_ROTATION_CHANGED fromField ROUTE name for SFRotation field named rotation_changed.
static java.lang.String	fromField_TRACKPOINT_CHANGED fromField ROUTE name for SFVec3f field named trackPoint_changed.
static int	LEVEL Integer constant LEVEL provides default X3D PointingDeviceSensor component level for this element: 1
static java.lang.String	NAME String constant NAME provides name of this element: SphereSensor.
static float[]	OFFSET_DEFAULT_VALUE SFRotation field named offset has default value {0f,1f,0f,0f} (Java syntax) or 0 1 0 0 (XML syntax).
static java.lang.String	toField_AUTOOFFSET toField ROUTE name for SFBool field named autoOffset.
static java.lang.String	toField_DESCRIPTION toField ROUTE name for SFString field named description.
static java.lang.String	toField_ENABLED toField ROUTE name for SFBool field named enabled.
static java.lang.String	toField_METADATA toField ROUTE name for SFNode field named metadata.
static java.lang.String	toField_OFFSET toField ROUTE name for SFRotation field named offset.

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

validationResult

Constructor Summary

Constructors

Constructor and Description
SphereSensorObject() Constructor for SphereSensorObject to initialize member variables with default values.
SphereSensorObject(java.lang.String DEFlabel) Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method and Description
SphereSensorObject	addComments(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.
SphereSensorObject	addComments(java.lang.String newComment) Add comment as String to contained commentsList.
SphereSensorObject	addComments(java.lang.String[] newComments) Add comments as String[] array to contained commentsList.
SphereSensorObject	clearMetadata() Utility method to clear SFNode value of metadata field.
X3DConcreteElement	findElementByNameValue(java.lang.String nameValue) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteElement	findElementByNameValue(java.lang.String nameValue, java.lang.String elementName) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteNode	findNodeByDEF(java.lang.String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
java.lang.String	getAccessType(java.lang.String fieldName) Indicate accessType corresponding to given fieldName.
boolean	getAutoOffset() Provide boolean value from inputOutput SFBool field named autoOffset.
java.lang.String	getComponent() Defines X3D component for the SphereSensor element: PointingDeviceSensor
int	getComponentLevel() Provides default X3D component level for this element: 1
java.lang.String	getContainerFieldDefault() containerField describes typical field relationship of a node to its parent.
java.lang.String	getDescription() Provide String value from inputOutput SFString field named description.
java.lang.String	getElementName() Provides name of this element: SphereSensor
boolean	getEnabled() Provide boolean value from inputOutput SFBool field named enabled.
java.lang.String	getFieldType(java.lang.String fieldName) Indicate type corresponding to given fieldName.
ISObject	getIS() Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
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 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.
boolean	hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName) Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
boolean	hasMetadata() Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(java.lang.String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
void	initialize() Initialize all member variables to default values.
SphereSensorObject	setAutoOffset(boolean newValue) Assign boolean value to inputOutput SFBool field named autoOffset.
SphereSensorObject	setAutoOffset(SFBoolObject newValue) Assign typed object value to SFBool autoOffset field, similar to setAutoOffset(boolean).
SphereSensorObject	setCssClass(SFStringObject newValue) Assign typed object value to SFString cssClass field, similar to setCssClass(String).
SphereSensorObject	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
SphereSensorObject	setDEF(SFStringObject newValue) Assign typed object value to SFString DEF field, similar to setDEF(String).
SphereSensorObject	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
SphereSensorObject	setDescription(SFStringObject newValue) Assign typed object value to SFString description field, similar to setDescription(String).
SphereSensorObject	setDescription(java.lang.String newValue) Assign String value to inputOutput SFString field named description.
SphereSensorObject	setEnabled(boolean newValue) Assign boolean value to inputOutput SFBool field named enabled.
SphereSensorObject	setEnabled(SFBoolObject newValue) Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
SphereSensorObject	setIS(ISObject newValue) Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
SphereSensorObject	setMetadata(ProtoInstanceObject newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
SphereSensorObject	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
SphereSensorObject	setOffset(float[] newValue) Assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named offset.
SphereSensorObject	setOffset(float x, float y, float z, float angleRadians) Assign values to SFRotation offset field, similar to setOffset(float[]).
SphereSensorObject	setOffset(SFRotationObject newValue) Assign typed object value to SFRotation offset field, similar to setOffset(float[]).
SphereSensorObject	setUSE(SFStringObject newValue) Assign typed object value to SFString USE field, similar to setUSE(String).
SphereSensorObject	setUSE(SphereSensorObject DEFnode) Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
SphereSensorObject	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.
java.lang.String	toStringClassicVRML(int indentLevel) Recursive method to provide ClassicVRML string serialization.
java.lang.String	toStringVRML97(int indentLevel) Recursive method to provide VRML97 string serialization.
java.lang.String	toStringX3D(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
java.lang.String	validate() Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final java.lang.String NAME

String constant NAME provides name of this element: SphereSensor.

See Also:

Constant Field Values

COMPONENT

public static final java.lang.String COMPONENT

String constant COMPONENT defines X3D component for the SphereSensor element: PointingDeviceSensor

See Also:

Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D PointingDeviceSensor component level for this element: 1

See Also:

Constant Field Values

AUTOOFFSET_DEFAULT_VALUE

public static final boolean AUTOOFFSET_DEFAULT_VALUE

SFBool field named autoOffset has default value true (Java syntax) or true (XML syntax).

See Also:

Constant Field Values

DESCRIPTION_DEFAULT_VALUE

public static final java.lang.String DESCRIPTION_DEFAULT_VALUE

SFString field named description has default value equal to an empty string.

See Also:

Constant Field Values

ENABLED_DEFAULT_VALUE

public static final boolean ENABLED_DEFAULT_VALUE

SFBool field named enabled has default value true (Java syntax) or true (XML syntax).

See Also:

Constant Field Values

OFFSET_DEFAULT_VALUE

public static final float[] OFFSET_DEFAULT_VALUE

SFRotation field named offset has default value {0f,1f,0f,0f} (Java syntax) or 0 1 0 0 (XML syntax).

containerField_DEFAULT_VALUE

public static final java.lang.String containerField_DEFAULT_VALUE

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.

See Also:

X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values

fromField_AUTOOFFSET

public static final java.lang.String fromField_AUTOOFFSET

fromField ROUTE name for SFBool field named autoOffset.

See Also:

Constant Field Values

toField_AUTOOFFSET

public static final java.lang.String toField_AUTOOFFSET

toField ROUTE name for SFBool field named autoOffset.

See Also:

Constant Field Values

fromField_DESCRIPTION

public static final java.lang.String fromField_DESCRIPTION

fromField ROUTE name for SFString field named description.

See Also:

Constant Field Values

toField_DESCRIPTION

public static final java.lang.String toField_DESCRIPTION

toField ROUTE name for SFString field named description.

See Also:

Constant Field Values

fromField_ENABLED

public static final java.lang.String fromField_ENABLED

fromField ROUTE name for SFBool field named enabled.

See Also:

Constant Field Values

toField_ENABLED

public static final java.lang.String toField_ENABLED

toField ROUTE name for SFBool field named enabled.

See Also:

Constant Field Values

fromField_ISACTIVE

public static final java.lang.String fromField_ISACTIVE

fromField ROUTE name for SFBool field named isActive.

See Also:

Constant Field Values

fromField_ISOVER

public static final java.lang.String fromField_ISOVER

fromField ROUTE name for SFBool field named isOver.

See Also:

Constant Field Values

fromField_METADATA

public static final java.lang.String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

Constant Field Values

toField_METADATA

public static final java.lang.String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

Constant Field Values

fromField_OFFSET

public static final java.lang.String fromField_OFFSET

fromField ROUTE name for SFRotation field named offset.

See Also:

Constant Field Values

toField_OFFSET

public static final java.lang.String toField_OFFSET

toField ROUTE name for SFRotation field named offset.

See Also:

Constant Field Values

fromField_ROTATION_CHANGED

public static final java.lang.String fromField_ROTATION_CHANGED

fromField ROUTE name for SFRotation field named rotation_changed.

See Also:

Constant Field Values

fromField_TRACKPOINT_CHANGED

public static final java.lang.String fromField_TRACKPOINT_CHANGED

fromField ROUTE name for SFVec3f field named trackPoint_changed.

See Also:

Constant Field Values

Constructor Detail

SphereSensorObject

public SphereSensorObject()

Constructor for SphereSensorObject to initialize member variables with default values.

SphereSensorObject

public SphereSensorObject(java.lang.String DEFlabel)

Utility constructor that assigns DEF label after initializing member variables with default values.

Parameters:

DEFlabel - unique DEF name for this X3D node

Method Detail

getElementName

public final java.lang.String getElementName()

Provides name of this element: SphereSensor

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final java.lang.String getComponent()

Defines X3D component for the SphereSensor element: PointingDeviceSensor

Specified by:

getComponent in class X3DConcreteElement

Returns:

X3D component for this element

getComponentLevel

public final int getComponentLevel()

Provides default X3D component level for this element: 1

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public java.lang.String getFieldType(java.lang.String fieldName)

Indicate type corresponding to given fieldName.

Specified by:

getFieldType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized

See Also:

ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE

getAccessType

public java.lang.String getAccessType(java.lang.String fieldName)

Indicate accessType corresponding to given fieldName.

Specified by:

getAccessType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized

See Also:

ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

getContainerFieldDefault

public final java.lang.String getContainerFieldDefault()

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getAutoOffset

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

Specified by:

getAutoOffset in interface X3DDragSensorNode

Returns:

value of autoOffset field

setAutoOffset

public SphereSensorObject setAutoOffset(boolean newValue)

Assign boolean value to inputOutput SFBool field named autoOffset.

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

Specified by:

setAutoOffset in interface SphereSensor

Specified by:

setAutoOffset in interface X3DDragSensorNode

Parameters:

newValue - is new value for the autoOffset field.

Returns:

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

setAutoOffset

public SphereSensorObject setAutoOffset(SFBoolObject newValue)

Assign typed object value to SFBool autoOffset field, similar to setAutoOffset(boolean).

Parameters:

newValue - is new value for the autoOffset field.

Returns:

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

getDescription

public java.lang.String getDescription()

Provide String value from inputOutput SFString field named description.

Tooltip: Author-provided text tooltip that tells users the expected action 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 SphereSensor

Specified by:

getDescription in interface X3DDragSensorNode

Specified by:

getDescription in interface X3DPointingDeviceSensorNode

Returns:

value of description field

setDescription

public SphereSensorObject setDescription(java.lang.String newValue)

Assign String value to inputOutput SFString field named description.

Tooltip: Author-provided text tooltip that tells users the expected action 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 SphereSensor

Specified by:

setDescription in interface X3DDragSensorNode

Specified by:

setDescription in interface X3DPointingDeviceSensorNode

Parameters:

newValue - is new value for the description field.

Returns:

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

setDescription

public SphereSensorObject setDescription(SFStringObject newValue)

Assign typed object value to SFString description field, similar to setDescription(String).

Parameters:

newValue - is new value for the description field.

Returns:

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

getEnabled

public boolean getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation. *

Specified by:

getEnabled in interface X3DSensorNode

Specified by:

getEnabled in interface SphereSensor

Specified by:

getEnabled in interface X3DDragSensorNode

Specified by:

getEnabled in interface X3DPointingDeviceSensorNode

Returns:

value of enabled field

setEnabled

public SphereSensorObject setEnabled(boolean newValue)

Assign boolean value to inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation.

Specified by:

setEnabled in interface X3DSensorNode

Specified by:

setEnabled in interface SphereSensor

Specified by:

setEnabled in interface X3DDragSensorNode

Specified by:

setEnabled in interface X3DPointingDeviceSensorNode

Parameters:

newValue - is new value for the enabled field.

Returns:

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

setEnabled

public SphereSensorObject setEnabled(SFBoolObject newValue)

Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).

Parameters:

newValue - is new value for the enabled field.

Returns:

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

getIsActive

public boolean getIsActive()

Provide boolean value from outputOnly SFBool field named isActive.

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

• Warning: it is an error to define this transient outputOnly field in an X3D file.

Specified by:

getIsActive in interface X3DSensorNode

Specified by:

getIsActive in interface SphereSensor

Specified by:

getIsActive in interface X3DDragSensorNode

Specified by:

getIsActive in interface X3DPointingDeviceSensorNode

Returns:

value of isActive field

getIsOver

public 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.

Specified by:

getIsOver in interface SphereSensor

Specified by:

getIsOver in interface X3DDragSensorNode

Specified by:

getIsOver in interface X3DPointingDeviceSensorNode

Returns:

value of isOver field

getMetadata

public X3DMetadataObject getMetadata()

Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DSensorNode

Specified by:

getMetadata in interface SphereSensor

Specified by:

getMetadata in interface X3DDragSensorNode

Specified by:

getMetadata in interface X3DPointingDeviceSensorNode

Returns:

value of metadata field

See Also:

getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public SphereSensorObject setMetadata(X3DMetadataObject newValue)

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

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DSensorNode

Specified by:

setMetadata in interface SphereSensor

Specified by:

setMetadata in interface X3DDragSensorNode

Specified by:

setMetadata in interface X3DPointingDeviceSensorNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public SphereSensorObject clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

SphereSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

public SphereSensorObject setMetadata(ProtoInstanceObject newValue)

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

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

setMetadata(X3DMetadataObject)

hasMetadata

public boolean hasMetadata()

Indicate whether an object is available for inputOutput SFNode field metadata.

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes

getOffset

public 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.

Specified by:

getOffset in interface SphereSensor

Returns:

value of offset field

setOffset

public SphereSensorObject setOffset(float[] newValue)

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.

Specified by:

setOffset in interface SphereSensor

Parameters:

newValue - is new value for the offset field.

Returns:

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

setOffset

public SphereSensorObject setOffset(SFRotationObject newValue)

Assign typed object value to SFRotation offset field, similar to setOffset(float[]).

Parameters:

newValue - is new value for the offset field.

Returns:

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

setOffset

public SphereSensorObject setOffset(float x,
                                    float y,
                                    float z,
                                    float angleRadians)

Assign values to SFRotation offset field, similar to setOffset(float[]).

Parameters:

x - first component of axis

y - second component of axis

z - third component of axis

angleRadians - fourth component of rotation around axis

Returns:

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

getRotation

public 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.

Specified by:

getRotation in interface SphereSensor

Returns:

value of rotation_changed field

getTrackPoint

public 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.

Specified by:

getTrackPoint in interface SphereSensor

Specified by:

getTrackPoint in interface X3DDragSensorNode

Returns:

value of trackPoint_changed field

setDEF

public final SphereSensorObject 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 X3DChildNode

Specified by:

setDEF in interface X3DNode

Specified by:

setDEF in interface X3DSensorNode

Specified by:

setDEF in interface SphereSensor

Specified by:

setDEF in interface X3DDragSensorNode

Specified by:

setDEF in interface X3DPointingDeviceSensorNode

Specified by:

setDEF in class X3DConcreteNode

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setDEF

public SphereSensorObject setDEF(SFStringObject newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setUSE

public final SphereSensorObject 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 X3DChildNode

Specified by:

setUSE in interface X3DNode

Specified by:

setUSE in interface X3DSensorNode

Specified by:

setUSE in interface SphereSensor

Specified by:

setUSE in interface X3DDragSensorNode

Specified by:

setUSE in interface X3DPointingDeviceSensorNode

Specified by:

setUSE in class X3DConcreteNode

Parameters:

newValue - is new value for the USE field.

Returns:

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

setUSE

public SphereSensorObject setUSE(SFStringObject newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

Parameters:

newValue - is new value for the USE field.

Returns:

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

setCssClass

public final SphereSensorObject 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 X3DChildNode

Specified by:

setCssClass in interface X3DNode

Specified by:

setCssClass in interface X3DSensorNode

Specified by:

setCssClass in interface SphereSensor

Specified by:

setCssClass in interface X3DDragSensorNode

Specified by:

setCssClass in interface X3DPointingDeviceSensorNode

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

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

See Also:

W3C Cascading Style Sheets

setCssClass

public SphereSensorObject setCssClass(SFStringObject newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String).

Parameters:

newValue - is new value for the class field.

Returns:

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

setIS

public SphereSensorObject setIS(ISObject newValue)

Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.

Specified by:

setIS in class X3DConcreteNode

Parameters:

newValue - is new value for the description field.

Returns:

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

See Also:

X3D Tooltips: IS, X3D Tooltips: connect

getIS

public ISObject getIS()

Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.

Specified by:

getIS in class X3DConcreteNode

Returns:

current ISObject, if any.

See Also:

X3D Tooltips: IS, X3D Tooltips: connect

setUSE

public SphereSensorObject setUSE(SphereSensorObject DEFnode)

Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

Warning: note that 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.

Parameters:

DEFnode - must have a DEF value defined

Returns:

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

addComments

public SphereSensorObject addComments(java.lang.String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

SphereSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public SphereSensorObject addComments(java.lang.String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

SphereSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public SphereSensorObject addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

SphereSensorObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

toStringX3D

public java.lang.String toStringX3D(int indentLevel)

Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.

Specified by:

toStringX3D in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

X3D string

See Also:

X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form

toStringClassicVRML

public java.lang.String toStringClassicVRML(int indentLevel)

Recursive method to provide ClassicVRML string serialization.

Specified by:

toStringClassicVRML in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

ClassicVRML string

See Also:

X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar

toStringVRML97

public java.lang.String toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

Specified by:

toStringVRML97 in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

VRML97 string

See Also:

X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment

findElementByNameValue

public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

Warning: more than one element may be found that has the same name, this method does not handle that case.

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

Returns:

object reference to found element, null otherwise

See Also:

findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

findElementByNameValue

public X3DConcreteElement findElementByNameValue(java.lang.String nameValue,
                                                 java.lang.String elementName)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

Warning: more than one element may be found that has the same name, this method does not handle that case.

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

object reference to found element, null otherwise

See Also:

findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

hasElementByNameValue

public boolean hasElementByNameValue(java.lang.String nameValue,
                                     java.lang.String elementName)

Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

whether node is found

See Also:

findElementByNameValue(String, String)

findNodeByDEF

public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)

Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

Warning: more than one element may be found that has the same DEF, this method does not handle that case.

Specified by:

findNodeByDEF in class X3DConcreteElement

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

object reference to found node, null otherwise

See Also:

findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

hasNodeByDEF

public boolean hasNodeByDEF(java.lang.String DEFvalue)

Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

whether node is found

See Also:

findNodeByDEF(String)

validate

public java.lang.String validate()

Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)