Package org.web3d.x3d.sai.EventUtilities

Interface IntegerTrigger

All Superinterfaces:

X3DChildNode, X3DNode, X3DTriggerNode

All Known Implementing Classes:

IntegerTrigger

public interface IntegerTrigger
extends X3DTriggerNode

IntegerTrigger converts set_boolean true input events to an integer value (for example, useful when animating whichChoice in a Switch node).

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. IntegerTrigger node tooltip: [X3DTriggerNode] IntegerTrigger converts set_boolean true input events to an integer value (for example, useful when animating whichChoice in a Switch node).

• Hint: example scenes and authoring assets at https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting
• Hint: X3D Event-Utility Node Diagrams https://www.web3d.org/x3d/content/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
• X3D Abstract Specification: IntegerTrigger
• X3D Tooltips: IntegerTrigger
• X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method	Description
int	getIntegerKey()	Provide int value from inputOutput SFInt32 field named integerKey.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
int	getTriggerValue()	Provide int value from outputOnly SFInt32 field named triggerValue.
IntegerTrigger	setIntegerKey(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named integerKey.
IntegerTrigger	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Method Details

getIntegerKey

int getIntegerKey()

Provide int value from inputOutput SFInt32 field named integerKey.

Tooltip: integerKey is value for output when triggered.

• Hint: directly setting a new value for the integerKey field generates a corresponding integerKey output event.

Returns:

value of integerKey field

setIntegerKey

IntegerTrigger setIntegerKey(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named integerKey.

Tooltip: integerKey is value for output when triggered.

• Hint: directly setting a new value for the integerKey field generates a corresponding integerKey output event.

Parameters:

newValue - is new value for the integerKey field.

Returns:

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

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 X3DNode

Specified by:

getMetadata in interface X3DTriggerNode

Returns:

value of metadata field

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

IntegerTrigger 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 X3DNode

Specified by:

setMetadata in interface X3DTriggerNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

getTriggerValue

int getTriggerValue()

Provide int value from outputOnly SFInt32 field named triggerValue.

Tooltip: triggerValue provides integer event output matching integerKey when true set_boolean received.

• 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 triggerValue field