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

Class OGLMidiSource

java.lang.Object

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

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

org.web3d.vrml.renderer.ogl.nodes.sound.OGLMidiSource

All Implemented Interfaces:

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

public class OGLMidiSource
extends BaseMidiSource
implements OGLVRMLNode

OpenGL implementation of a Midi Source.

Version:

$Revision: 1.1 $

Author:

Alan Hudson

Field Summary

Fields inherited from class org.web3d.vrml.renderer.common.nodes.sound.BaseMidiSource

vfAvailable, vfEventChannel, vfEventCommand, vfEventData1, vfEventData2, vfSelected

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
OGLMidiSource()	Construct a default node with an empty info array any the title set to the empty string.
OGLMidiSource(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
org.j3d.aviatrix3d.SceneGraphObject	getSceneGraphObject()	Get the Java3D scene graph object representation of this node.
void	setCapabilityOverrideMap(Map capBits, Map freqBits)	Provide the set of mappings that override anything that the loader might set.
void	setCapabilityRequiredMap(Map capBits, Map freqBits)	Set the mapping of capability bits that the user would like to make sure is set.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.sound.BaseMidiSource

allEventsComplete, close, getFieldDeclaration, getFieldIndex, getFieldValue, getNodeFieldIndices, getNumFields, getPrimaryType, send, sendRoute, setupFinished, setValue, setValue

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.nodes.FrameStateListener

allEventsComplete

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

getFieldDeclaration, getFieldIndex, getNodeFieldIndices, getNumFields, getPrimaryType, getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

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

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

Constructor Details

OGLMidiSource

public OGLMidiSource()

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

OGLMidiSource

public OGLMidiSource(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

getSceneGraphObject

public org.j3d.aviatrix3d.SceneGraphObject getSceneGraphObject()

Get the Java3D scene graph object representation of this node. This will need to be cast to the appropriate parent type when being used.

Specified by:

getSceneGraphObject in interface OGLVRMLNode

Returns:

The OGL representation.

setCapabilityOverrideMap

public void setCapabilityOverrideMap(Map capBits,
 Map freqBits)

Provide the set of mappings that override anything that the loader might set. Default implementation does nothing.

If the key is set, but the value is null or zero length, then all capabilities on that node will be disabled. If the key is set the values override all settings that the loader may wish to normally make. This can be very dangerous if the loader is used for a file format that includes its own internal animation engine, so be very careful with this request.

Parameters:

capBits - The capability bits to be set

freqBits - The frequency bits to be set

setCapabilityRequiredMap

public void setCapabilityRequiredMap(Map capBits,
 Map freqBits)

Set the mapping of capability bits that the user would like to make sure is set. The end output is that the capabilities are the union of what the loader wants and what the user wants. Default implementation does nothing.

If the map contains a key, but the value is null or zero length, the request is ignored.

Parameters:

capBits - The capability bits to be set

freqBits - The frequency bits to be set