org.web3d.x3d.sai.EventUtilities

Interface BooleanTrigger

All Superinterfaces:

X3DChildNode, X3DNode, X3DTriggerNode

All Known Implementing Classes:

BooleanTriggerObject

public interface BooleanTrigger
extends X3DTriggerNode

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

X3D node tooltip: [X3DTriggerNode] BooleanTrigger converts time events to boolean true events.

• Hint: example scenes and authoring assets at
  http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting
• Hint: X3D Event-Utility Node Diagrams
  http://x3dgraphics.com/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting/X3dEventUtilityNodeEventDiagrams.pdf

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

Method Summary

Modifier and Type	Method and Description
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
boolean	getTriggerTrue() Provide boolean value from outputOnly SFBool field named triggerTrue.
BooleanTrigger	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
BooleanTrigger	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
BooleanTrigger	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
BooleanTrigger	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.

Method Detail

getMetadata

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 X3DTriggerNode

Returns:

value of metadata field

See Also:

X3D Scene Authoring Hints: Metadata Nodes

setMetadata

BooleanTrigger 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 X3DTriggerNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

getTriggerTrue

boolean getTriggerTrue()

Provide boolean value from outputOnly SFBool field named triggerTrue.

Tooltip: triggerTrue outputs a true value whenever a triggerTime event is received.

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

Returns:

value of triggerTrue field

setDEF

BooleanTrigger 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 X3DTriggerNode

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setUSE

BooleanTrigger 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 X3DTriggerNode

Parameters:

newValue - is new value for the USE field.

Returns:

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

setCssClass

BooleanTrigger 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 X3DTriggerNode

Parameters:

newValue - is new value for the class field.

Returns:

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