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

Class BasePointProperties

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.shape.BasePointProperties

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLAppearanceChildNodeType, VRMLNodeType, VRMLPointPropertiesNodeType

Direct Known Subclasses:

NRPointProperties, OGLPointProperties

public abstract class BasePointProperties
extends AbstractNode
implements VRMLPointPropertiesNodeType

Common base implementation of a PointProperties node.

Version:

$Revision: 1.1 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected int	colorMode	Constant representing the mode used
protected static final int	FIELD_COLOR_MODE	Field index for colorMode
protected static final int	FIELD_POINTSIZE_ATTENUATION	Field index for pointsizeAttenuation
protected static final int	FIELD_POINTSIZE_MAX_VALUE	Field index for pointsizeMaxValue
protected static final int	FIELD_POINTSIZE_MIN_VALUE	Field index for pointsizeMinValue
protected static final int	FIELD_POINTSIZE_SCALE_FACTOR	Field index for pointsizeScaleFactor
protected static final int	NUM_FIELDS	Number of fields constant
protected static final String	POINT_COLORMODE	Constant describing point color mode
protected static final String	TEXTURE_AND_POINT_COLORMODE	Constant describing texture and point mode
protected static final String	TEXTURE_COLORMODE	Constant describing texture color mode
protected String	vfColorMode	exposedField SFString colorMode 0
protected float[]	vfPointsizeAttenuation	exposedField SFVec3f pointsizeAttenuation 1 0 0
protected float	vfPointsizeMaxValue	exposedField SFFloat pointsizeMaxValue 0
protected float	vfPointsizeMinValue	exposedField SFFloat pointsizeMinValue 0
protected float	vfPointsizeScaleFactor	exposedField SFFloat pointsizeScaleFactor 0

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

Fields inherited from interface org.web3d.vrml.nodes.VRMLPointPropertiesNodeType

DISABLE_COLOR_MODE, POINT_COLOR_MODE, TEXTURE_AND_POINT_COLOR_MODE, TEXTURE_COLOR_MODE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BasePointProperties()	Construct a default instance of the material
protected	BasePointProperties(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
int	getColorMode()	Get the currently set color mode.
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	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setColorMode(int mode)	Set the color mode to one of the new values.
void	setColorMode(String mode)	Set the color mode to the new value.
protected void	setPointSizeAttenuation(float[] factor)	Set the attenuation factor of the point size.
protected void	setPointSizeMax(float value)	Set the point size max value to the new value.
protected void	setPointSizeMin(float value)	Set the point size min value to the new value.
protected void	setPointSizeScale(float value)	Set the point size scale factor to the new value.
void	setValue(int index, float value)	Set the value of the field at the given index as a float.
void	setValue(int index, float[] value, int numValid)	Set the value of the field at the given index as an array of floats.
void	setValue(int index, String value)	Set the value of the field at the given index as an int.

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

addNodeListener, allEventsComplete, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getSecondaryType, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setupFinished, setUserData, 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

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, setupFinished, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Field Details

FIELD_POINTSIZE_SCALE_FACTOR

protected static final int FIELD_POINTSIZE_SCALE_FACTOR

Field index for pointsizeScaleFactor

See Also:

• Constant Field Values

FIELD_POINTSIZE_MIN_VALUE

protected static final int FIELD_POINTSIZE_MIN_VALUE

Field index for pointsizeMinValue

See Also:

• Constant Field Values

FIELD_POINTSIZE_MAX_VALUE

protected static final int FIELD_POINTSIZE_MAX_VALUE

Field index for pointsizeMaxValue

See Also:

• Constant Field Values

FIELD_POINTSIZE_ATTENUATION

protected static final int FIELD_POINTSIZE_ATTENUATION

Field index for pointsizeAttenuation

See Also:

• Constant Field Values

FIELD_COLOR_MODE

protected static final int FIELD_COLOR_MODE

Field index for colorMode

See Also:

• Constant Field Values

NUM_FIELDS

protected static final int NUM_FIELDS

Number of fields constant

See Also:

• Constant Field Values

vfPointsizeScaleFactor

protected float vfPointsizeScaleFactor

exposedField SFFloat pointsizeScaleFactor 0

vfPointsizeMinValue

protected float vfPointsizeMinValue

exposedField SFFloat pointsizeMinValue 0

vfPointsizeMaxValue

protected float vfPointsizeMaxValue

exposedField SFFloat pointsizeMaxValue 0

vfPointsizeAttenuation

protected float[] vfPointsizeAttenuation

exposedField SFVec3f pointsizeAttenuation 1 0 0

vfColorMode

protected String vfColorMode

exposedField SFString colorMode 0

colorMode

protected int colorMode

Constant representing the mode used

TEXTURE_COLORMODE

protected static final String TEXTURE_COLORMODE

Constant describing texture color mode

See Also:

• Constant Field Values

POINT_COLORMODE

protected static final String POINT_COLORMODE

Constant describing point color mode

See Also:

• Constant Field Values

TEXTURE_AND_POINT_COLORMODE

protected static final String TEXTURE_AND_POINT_COLORMODE

Constant describing texture and point mode

See Also:

• Constant Field Values

Constructor Details

BasePointProperties

protected BasePointProperties()

Construct a default instance of the material

BasePointProperties

protected BasePointProperties(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.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not a Group node

Method Details

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 InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as an int. This would be used to set String field types.

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 not in range or not appropriate for this field

setValue

public void setValue(int index,
 float value)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as a float. This would be used to set SFFloat field types.

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 not in range or not appropriate for this field

setValue

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

Set the value of the field at the given index as an array of floats. This would be used to set SFColor and SFVec3f field types.

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

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

Throws:

InvalidFieldException - The field index is not known

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

setPointSizeScale

protected void setPointSizeScale(float value)
                          throws InvalidFieldValueException

Set the point size scale factor to the new value.

Parameters:

value - The scale value to check

Throws:

InvalidFieldValueException - One of the colour components are out of range

setPointSizeMin

protected void setPointSizeMin(float value)
                        throws InvalidFieldValueException

Set the point size min value to the new value.

Parameters:

value - The min value to set

Throws:

InvalidFieldValueException - The submitted value is out of range

setPointSizeMax

protected void setPointSizeMax(float value)
                        throws InvalidFieldValueException

Set the point size max value to the new value.

Parameters:

value - The max value to set

Throws:

InvalidFieldValueException - The submitted value is out of range

setPointSizeAttenuation

protected void setPointSizeAttenuation(float[] factor)
                                throws InvalidFieldValueException

Set the attenuation factor of the point size.

Parameters:

factor - The new attenuation factor to use

Throws:

InvalidFieldValueException - Attenuation was not [0,1]

getColorMode

public int getColorMode()

Get the currently set color mode. Will be one of the above constant values.

Specified by:

getColorMode in interface VRMLPointPropertiesNodeType

Returns:

One of TEXTURE_COLORMODE, COLOR_COLORMODE, TEXTURE_AND_POINT_COLORMODE

setColorMode

public void setColorMode(int mode)
                  throws InvalidFieldValueException

Set the color mode to one of the new values. If the value is not known, issue an exception and leave the value at the current.

Parameters:

mode - Constant indicating the mode.

Throws:

InvalidFieldValueException - The value type is unknown

setColorMode

public void setColorMode(String mode)
                  throws InvalidFieldValueException

Set the color mode to the new value.

Specified by:

setColorMode in interface VRMLPointPropertiesNodeType

Parameters:

mode - The color mode to set

Throws:

InvalidFieldValueException - The submitted value is out of range