org.web3d.vrml.renderer.common.nodes.networking.BaseLoadSensor

All Implemented Interfaces:: VRMLNode, FrameStateListener, VRMLChildNodeType, VRMLContentStateListener, VRMLEnvironmentalSensorNodeType, VRMLNodeType, VRMLSensorNodeType, VRMLTimeDependentNodeType, VRMLWorldRootChildNodeType

Direct Known Subclasses:: NRLoadSensor, OGLLoadSensor

public class BaseLoadSensor extends BaseSensorNode implements VRMLEnvironmentalSensorNodeType, VRMLTimeDependentNodeType, VRMLContentStateListener

Base implementation of a LoadSensor node.

TODO: Likely need switch over to use a Set to track completion so that set_url during tracking doesn't cause extra counts. TODO: Changes of watchList might happen after an asset has loaded when using a set_url, set_watchList on the same frame

Version:: $Revision: 1.11 $
Author:: Alan Hudson

Field Summary

Fields

Modifier and Type

Field

Description

protected static final int

FIELD_IS_LOADED

The field index for isLoaded

protected static final int

FIELD_LOAD_TIME

The field index for loadTime

protected static final int

FIELD_PROGRESS

The field index for progress

protected static final int

FIELD_TIMEOUT

The field index for timeout

protected static final int

FIELD_WATCHLIST

The field index for watchList

protected static VRMLFieldDeclaration[]

fieldDecl

Array of VRMLFieldDeclarations

protected static final int

LAST_LOADSENSOR_INDEX

The last field index used by this class

protected static final int

NUM_FIELDS

Number of fields constant

protected boolean

vfIsLoaded

The value of the isLoaded field

protected double

vfLoadTime

The value of the loadTime field

protected float

vfProgress

The value of the progress field

protected double

vfTimeout

The value of the timeout field

protected List<VRMLNodeType>

vfWatchList

The value of the watchList field

Fields inherited from class org.web3d.vrml.renderer.common.nodes.BaseSensorNode
FIELD_ENABLED, FIELD_IS_ACTIVE, LAST_SENSOR_INDEX, vfEnabled, vfIsActive

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

BaseLoadSensor()

Construct a default instance of this node.

BaseLoadSensor(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

contentStateChanged(VRMLNodeType node, int index, int state)

Notification that the content state for this node has changed

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.

int[]

getSecondaryType()

Get the secondary type of this node.

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, boolean value)

Set the value of the field at the given index as a boolean.

void

setValue(int index, double value)

Set the value of the field at the given index as a double.

void

setValue(int index, VRMLNodeType child)

Set the value of the field at the given index as an array of nodes.

void

setValue(int index, VRMLNodeType[] children, int numValid)

Set the value of the field at the given index as an array of nodes.

void

setVRMLClock(VRMLClock clk)

Set the vrmlClock that this time dependent node will be running with.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.BaseSensorNode
copy, getEnabled, getIsActive, setEnabled

Methods inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode
addNodeListener, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setUserData, 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
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, updateRefCount

Methods inherited from interface org.web3d.vrml.nodes.VRMLSensorNodeType
getEnabled, getIsActive, setEnabled

Field Details
- FIELD_WATCHLIST
  protected static final int FIELD_WATCHLIST
  
  The field index for watchList
  
  See Also:
  
  Constant Field Values
- FIELD_TIMEOUT
  protected static final int FIELD_TIMEOUT
  
  The field index for timeout
  
  See Also:
  
  Constant Field Values
- FIELD_LOAD_TIME
  protected static final int FIELD_LOAD_TIME
  
  The field index for loadTime
  
  See Also:
  
  Constant Field Values
- FIELD_IS_LOADED
  protected static final int FIELD_IS_LOADED
  
  The field index for isLoaded
  
  See Also:
  
  Constant Field Values
- FIELD_PROGRESS
  protected static final int FIELD_PROGRESS
  
  The field index for progress
  
  See Also:
  
  Constant Field Values
- LAST_LOADSENSOR_INDEX
  protected static final int LAST_LOADSENSOR_INDEX
  
  The last field index used by this class
  
  See Also:
  
  Constant Field Values
- NUM_FIELDS
  protected static final int NUM_FIELDS
  
  Number of fields constant
  
  See Also:
  
  Constant Field Values
- fieldDecl
  
  protected static VRMLFieldDeclaration[] fieldDecl
  
  Array of VRMLFieldDeclarations
- vfWatchList
  
  protected List<VRMLNodeType> vfWatchList
  
  The value of the watchList field
- vfTimeout
  
  protected double vfTimeout
  
  The value of the timeout field
- vfLoadTime
  
  protected double vfLoadTime
  
  The value of the loadTime field
- vfIsLoaded
  
  protected boolean vfIsLoaded
  
  The value of the isLoaded field
- vfProgress
  
  protected float vfProgress
  
  The value of the progress field
Constructor Details
- BaseLoadSensor
  
  public BaseLoadSensor()
  
  Construct a default instance of this node. The defaults are set by the VRML specification.
- BaseLoadSensor
  
  public BaseLoadSensor(VRMLNodeType node)
  
  Construct a new instance of this node based on the details from the given node. If the node is not the right type, an exception will be thrown. A shallow copy of the watchList will be performed.
  
  Parameters:
  
  node - The node to copy
  
  Throws:
  
  IllegalArgumentException - The node is not the right 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
- setVRMLClock
  
  public void setVRMLClock(VRMLClock clk)
  
  Set the vrmlClock that this time dependent node will be running with.
  
  Specified by:
  
  setVRMLClock in interface VRMLTimeDependentNodeType
  
  Parameters:
  
  clk - The vrmlClock to use for this node
- 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
- getSecondaryType
  
  public int[] getSecondaryType()
  
  Get the secondary type of this node. Replaces the instanceof mechanism for use in switch statements.
  
  Specified by:
  
  getSecondaryType in interface VRMLNode
  
  Overrides:
  
  getSecondaryType in class AbstractNode
  
  Returns:
  
  The secondary 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 BaseSensorNode
  
  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 BaseSensorNode
  
  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, boolean value) throws InvalidFieldException, InvalidFieldValueException
  
  Set the value of the field at the given index as a boolean. This is be used to set SFBool field types isActive, enabled and loop.
  
  Specified by:
  
  setValue in interface VRMLNodeType
  
  Overrides:
  
  setValue in class BaseSensorNode
  
  Parameters:
  
  index - The index of destination field to set
  
  value - The new value to use for the node
  
  Throws:
  
  InvalidFieldException - The index is not a valid field
  
  InvalidFieldValueException - The field value is not legal for the field specified.
- setValue
  
  public void setValue(int index, double value) throws InvalidFieldException, InvalidFieldValueException
  
  Set the value of the field at the given index as a double.
  
  Specified by:
  
  setValue in interface VRMLNodeType
  
  Overrides:
  
  setValue in class AbstractNode
  
  Parameters:
  
  index - The index of destination field to set
  
  value - The new value to use for the node
  
  Throws:
  
  InvalidFieldException - The field index is not known
  
  InvalidFieldValueException - The value provided is out of range for the field type.
- setValue
  
  public void setValue(int index, VRMLNodeType child) throws InvalidFieldException
  
  Set the value of the field at the given index as an array of nodes. This would be used to set MFNode field types.
  
  Specified by:
  
  setValue in interface VRMLNodeType
  
  Overrides:
  
  setValue in class AbstractNode
  
  Parameters:
  
  index - The index of destination field to set
  
  child - The new value to use for the node
  
  Throws:
  
  InvalidFieldException - The field index is not know
- setValue
  
  public void setValue(int index, VRMLNodeType[] children, int numValid) throws InvalidFieldException, InvalidFieldValueException
  
  Set the value of the field at the given index as an array of nodes. This would be used to set MFNode field types.
  
  Specified by:
  
  setValue in interface VRMLNodeType
  
  Overrides:
  
  setValue in class AbstractNode
  
  Parameters:
  
  index - The index of destination field to set
  
  children - The new value to use for the node
  
  numValid - The number of valid values to copy from the array
  
  Throws:
  
  InvalidFieldException - The field index is not known
  
  InvalidFieldValueException - The value provided is out of range for the field type.
- 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. It is then responsible for calling its children's setupFinished.
  
  Specified by:
  
  setupFinished in interface VRMLNodeType
  
  Overrides:
  
  setupFinished in class AbstractNode
- contentStateChanged
  
  public void contentStateChanged(VRMLNodeType node, int index, int state)
  
  Notification that the content state for this node has changed
  
  Specified by:
  
  contentStateChanged in interface VRMLContentStateListener
  
  Parameters:
  
  node - The node that changed state
  
  index - The index of the field that has changed
  
  state - The new state that has changed

Class BaseLoadSensor

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

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

Field Details

FIELD_WATCHLIST

FIELD_TIMEOUT

FIELD_LOAD_TIME

FIELD_IS_LOADED

FIELD_PROGRESS

LAST_LOADSENSOR_INDEX

NUM_FIELDS

fieldDecl

vfWatchList

vfTimeout

vfLoadTime

vfIsLoaded

vfProgress

Constructor Details

BaseLoadSensor

BaseLoadSensor

Method Details

allEventsComplete

setVRMLClock

getFieldIndex

getNodeFieldIndices

getFieldDeclaration

getNumFields

getPrimaryType

getSecondaryType

getFieldValue

sendRoute

setValue

setValue

setValue

setValue

setupFinished

contentStateChanged