org.web3d.x3d.sai.Navigation

Interface X3DViewpointNode

All Superinterfaces:

X3DBindableNode, X3DChildNode, X3DNode

All Known Subinterfaces:

GeoViewpoint, OrthoViewpoint, Viewpoint

All Known Implementing Classes:

GeoViewpointObject, OrthoViewpointObject, ViewpointObject

public interface X3DViewpointNode
extends X3DBindableNode

Node type X3DViewpointNode defines a specific location in the local coordinate system from which the user may view the scene, and also defines a viewpoint binding stack.


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: TODO, X3D Tooltips, X3D Scene Authoring Hints: Viewpoints

Method Summary

Modifier and Type	Method and Description
double	getBindTime() Provide double value in seconds from outputOnly SFTime field named bindTime.
java.lang.String	getDescription() Provide String value from inputOutput SFString field named description.
boolean	getIsBound() Provide boolean value from outputOnly SFBool field named isBound.
boolean	getJump() Provide boolean value from inputOutput SFBool field named jump.
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float[]	getOrientation() Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named orientation.
boolean	getRetainUserOffsets() Provide boolean value from inputOutput SFBool field named retainUserOffsets.
X3DViewpointNode	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
X3DViewpointNode	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
X3DViewpointNode	setDescription(java.lang.String newValue) Assign String value to inputOutput SFString field named description.
X3DViewpointNode	setJump(boolean newValue) Assign boolean value to inputOutput SFBool field named jump.
X3DViewpointNode	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
X3DViewpointNode	setOrientation(float[] newValue) Assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.
X3DViewpointNode	setRetainUserOffsets(boolean newValue) Assign boolean value to inputOutput SFBool field named retainUserOffsets.
X3DViewpointNode	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.

Method Detail

getBindTime

double getBindTime()

Provide double value in seconds from outputOnly SFTime field named bindTime.

Specified by:

getBindTime in interface X3DBindableNode

Returns:

value of bindTime field

getDescription

java.lang.String getDescription()

Provide String value from inputOutput SFString field named description.

Returns:

value of description field

setDescription

X3DViewpointNode setDescription(java.lang.String newValue)

Assign String value to inputOutput SFString field named description.

Parameters:

newValue - is new value for the description field.

Returns:

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

getIsBound

boolean getIsBound()

Provide boolean value from outputOnly SFBool field named isBound.

Specified by:

getIsBound in interface X3DBindableNode

Returns:

value of isBound field

getJump

boolean getJump()

Provide boolean value from inputOutput SFBool field named jump.

Returns:

value of jump field

setJump

X3DViewpointNode setJump(boolean newValue)

Assign boolean value to inputOutput SFBool field named jump.

Parameters:

newValue - is new value for the jump field.

Returns:

X3DViewpointNode - 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 X3DBindableNode

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

X3D Scene Authoring Hints: Metadata Nodes

setMetadata

X3DViewpointNode setMetadata(X3DMetadataObject newValue)

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

Specified by:

setMetadata in interface X3DBindableNode

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

getOrientation

float[] getOrientation()

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

Returns:

value of orientation field

setOrientation

X3DViewpointNode setOrientation(float[] newValue)

Assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.

Parameters:

newValue - is new value for the orientation field.

Returns:

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

getRetainUserOffsets

boolean getRetainUserOffsets()

Provide boolean value from inputOutput SFBool field named retainUserOffsets.

Returns:

value of retainUserOffsets field

setRetainUserOffsets

X3DViewpointNode setRetainUserOffsets(boolean newValue)

Assign boolean value to inputOutput SFBool field named retainUserOffsets.

Parameters:

newValue - is new value for the retainUserOffsets field.

Returns:

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

setDEF

X3DViewpointNode setDEF(java.lang.String newValue)

Assign String value to inputOutput SFString field named DEF.

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in interface X3DBindableNode

Specified by:

setDEF in interface X3DChildNode

Specified by:

setDEF in interface X3DNode

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setUSE

X3DViewpointNode setUSE(java.lang.String newValue)

Assign String value to inputOutput SFString field named USE.

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 X3DBindableNode

Specified by:

setUSE in interface X3DChildNode

Specified by:

setUSE in interface X3DNode

Parameters:

newValue - is new value for the USE field.

Returns:

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

setCssClass

X3DViewpointNode setCssClass(java.lang.String newValue)

Assign String value to inputOutput SFString field named class.

Specified by:

setCssClass in interface X3DBindableNode

Specified by:

setCssClass in interface X3DChildNode

Specified by:

setCssClass in interface X3DNode

Parameters:

newValue - is new value for the class field.

Returns:

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