Package org.web3d.x3d.sai.EventUtilities
Interface TimeTrigger
- All Superinterfaces:
X3DChildNode
,X3DNode
,X3DTriggerNode
- All Known Implementing Classes:
TimeTriggerObject
public interface TimeTrigger extends X3DTriggerNode
TimeTrigger converts boolean true events to time events.
X3D node tooltip: [X3DTriggerNode] TimeTrigger converts boolean true events to time events.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
X3D node tooltip: [X3DTriggerNode] TimeTrigger converts boolean true events to time 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).
-
Method Summary
Modifier and Type Method Description X3DMetadataObject
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.double
getTriggerTime()
Provide double value in seconds from outputOnly SFTime field named triggerTime.TimeTrigger
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
-
Method Details
-
getMetadata
X3DMetadataObject getMetadata()Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DTriggerNode
- Returns:
- value of metadata field
- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DTriggerNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
TimeTrigger
- 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
-
getTriggerTime
double getTriggerTime()Provide double value in seconds from outputOnly SFTime field named triggerTime.
Tooltip: triggerTime is output time event, sent when input event set_boolean is true.- 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 triggerTime field
-