Package org.web3d.vrml.renderer.common.nodes.sound

Class BaseMidiSource

java.lang.Object

org.web3d.vrml.renderer.common.nodes.AbstractNode

org.web3d.vrml.renderer.common.nodes.sound.BaseMidiSource

All Implemented Interfaces:

AutoCloseable, Receiver, VRMLNode, FrameStateListener, VRMLChildNodeType, VRMLNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:

OGLMidiSource

public class BaseMidiSource
extends AbstractNode
implements VRMLChildNodeType, Receiver

Common implementation of a MIDI Event Source.

Version:

$Revision: 1.11 $

Author:

Alan Hudson

Field Summary

Fields

Modifier and Type	Field	Description
protected String[]	vfAvailable	outputOnly MFString available
protected int[]	vfEventChannel	outputOnly MFInt32 eventChannel
protected int[]	vfEventCommand	outputOnly MFInt32 eventValue
protected int[]	vfEventData1	outputOnly MFInt32 eventData1
protected int[]	vfEventData2	outputOnly MFInt32 eventValue
protected String[]	vfSelected	inputOnly MFString selected

Fields inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

errorReporter, FIELD_METADATA, fieldLocalData, hasChanged, inSetup, isDEF, isStatic, LAST_NODE_INDEX, layerIds, nodeName, pMetadata, refCounts, removedLayerIds, stateManager, STATIC_SCENE_GRAPH, vfMetadata, vrmlMajorVersion, vrmlMinorVersion

Constructor Summary

Constructors

Constructor	Description
BaseMidiSource()	Construct a default node with an empty info array any the title set to the empty string.
BaseMidiSource(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
void	allEventsComplete()	Notification that the rendering of the event model is complete and that rendering is about to begin.
void	close()
VRMLFieldDeclaration	getFieldDeclaration(int index)	Get the declaration of the field at the given index.
int	getFieldIndex(String fieldName)	Get the index of the given field name.
VRMLFieldData	getFieldValue(int index)	Get the value of a field.
int[]	getNodeFieldIndices()	Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode).
int	getNumFields()	Get the number of fields.
int	getPrimaryType()	Get the primary type of this node.
void	send(MidiMessage message, long lTimeStamp)
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	setValue(int index, String value)	Set the value of the field from the raw string.
void	setValue(int index, String[] value, int numValid)	Set the value of the field from the raw collection of strings.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

addNodeListener, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getSecondaryType, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setUserData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setVersion, throwInitOnlyWriteException, throwInputOnlyWriteException, throwInvalidNodeException, throwInvalidProtoException, throwOutputOnlyWriteException, updateRefCount, updateRefs

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.web3d.vrml.lang.VRMLNode

getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

Methods inherited from interface org.web3d.vrml.nodes.VRMLNodeType

addNodeListener, clearRemovedLayerIds, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, hasFieldChanged, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setFrameStateManager, setMetadataObject, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Field Details

vfSelected

protected String[] vfSelected

inputOnly MFString selected

vfAvailable

protected String[] vfAvailable

outputOnly MFString available

vfEventChannel

protected int[] vfEventChannel

outputOnly MFInt32 eventChannel

vfEventCommand

protected int[] vfEventCommand

outputOnly MFInt32 eventValue

vfEventData1

protected int[] vfEventData1

outputOnly MFInt32 eventData1

vfEventData2

protected int[] vfEventData2

outputOnly MFInt32 eventValue

Constructor Details

BaseMidiSource

public BaseMidiSource()

Construct a default node with an empty info array any the title set to the empty string.

BaseMidiSource

public BaseMidiSource(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node. If the node is not the same type, an exception will be thrown.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not the same type

Method Details

allEventsComplete

public void allEventsComplete()

Notification that the rendering of the event model is complete and that rendering is about to begin. Used to update the transformation matrix only once per frame.

Specified by:

allEventsComplete in interface FrameStateListener

Overrides:

allEventsComplete in class AbstractNode

setupFinished

public void setupFinished()

Notification that the construction phase of this node has finished. If the node would like to do any internal processing, such as setting up geometry, then go for it now.

Specified by:

setupFinished in interface VRMLNodeType

Overrides:

setupFinished in class AbstractNode

getFieldIndex

public int getFieldIndex(String fieldName)

Get the index of the given field name. If the name does not exist for this node then return a value of -1.

Specified by:

getFieldIndex in interface VRMLNode

Parameters:

fieldName - The name of the field we want the index from

Returns:

The index of the field name or -1

getNodeFieldIndices

public int[] getNodeFieldIndices()

Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode). Used for blind scene graph traversal without needing to spend time querying for all fields etc. If a node does not have any fields that contain nodes, this shall return null. The field list covers all field types, regardless of whether they are readable or not at the VRML-level.

Specified by:

getNodeFieldIndices in interface VRMLNode

Returns:

The list of field indices that correspond to SF/MFnode fields or null if none

getFieldDeclaration

public VRMLFieldDeclaration getFieldDeclaration(int index)

Get the declaration of the field at the given index. This allows for reverse lookup if needed. If the field does not exist, this will give a value of null.

Specified by:

getFieldDeclaration in interface VRMLNode

Parameters:

index - The index of the field to get information

Returns:

A representation of this field's information

getNumFields

public int getNumFields()

Get the number of fields.

Specified by:

getNumFields in interface VRMLNode

Returns:

The number of fields.

getPrimaryType

public int getPrimaryType()

Get the primary type of this node. Replaces the instanceof mechanism for use in switch statements.

Specified by:

getPrimaryType in interface VRMLNode

Returns:

The primary type

getFieldValue

public VRMLFieldData getFieldValue(int index)
                            throws InvalidFieldException

Get the value of a field. If the field is a primitive type, it will return a class representing the value. For arrays or nodes it will return the instance directly.

Specified by:

getFieldValue in interface VRMLNodeType

Overrides:

getFieldValue in class AbstractNode

Parameters:

index - The index of the field to change.

Returns:

The class representing the field value

Throws:

InvalidFieldException - The field index is not known

sendRoute

public void sendRoute(double time,
 int srcIndex,
 VRMLNodeType destNode,
 int destIndex)

Send a routed value from this node to the given destination node. The route should use the appropriate setValue() method of the destination node. It should not attempt to cast the node up to a higher level. Routing should also follow the standard rules for the loop breaking and other appropriate rules for the specification.

Specified by:

sendRoute in interface VRMLNodeType

Overrides:

sendRoute in class AbstractNode

Parameters:

time - The time that this route occurred (not necessarily epoch time. Should be treated as a relative value only)

srcIndex - The index of the field in this node that the value should be sent from

destNode - The node reference that we will be sending the value to

destIndex - The index of the field in the destination node that the value should be sent to.

setValue

public void setValue(int index,
 String value)
              throws InvalidFieldFormatException,
InvalidFieldException

Set the value of the field from the raw string. This requires the implementation to parse the string in the given format for the field type. If the field type does not match the requirements for that index then an exception will be thrown. If the destination field is a string, then the leading and trailing quote characters will be stripped before calling this method.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The raw value string to be parsed

Throws:

InvalidFieldFormatException - The string was not in a correct form for this field.

InvalidFieldException - The field index is not known

setValue

public void setValue(int index,
 String[] value,
 int numValid)
              throws InvalidFieldFormatException,
InvalidFieldException,
InvalidFieldValueException

Set the value of the field from the raw collection of strings. Like the single value version above, this needs to process things into the correct form. If this field represents an MFString field it will be guaranteed to be one SFString per index - with leading and trailing quotes already stripped.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The raw value strings to be parsed

numValid - The number of valid values to copy from the array

Throws:

InvalidFieldFormatException - The string was not in a correct form for this field.

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is not in range or not appropriate for this field

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Receiver

send

public void send(MidiMessage message,
 long lTimeStamp)

Specified by:

send in interface Receiver