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

Class BaseArc2D

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.geom2d.BaseArc2D

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLGeometryNodeType, VRMLNodeType

Direct Known Subclasses:

NRArc2D, OGLArc2D

public class BaseArc2D
extends AbstractNode
implements VRMLGeometryNodeType

An abstract implementation of the BaseArc2D

Version:

$Id: BaseArc2D.java 12346 2015-09-04 01:03:17Z brutzman $

Author:

Terry Norbraten, NPS MOVES

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	FIELD_END_ANGLE	Index of the end angle
protected static final int	FIELD_RADIUS	Index of the arc radius
protected static final int	FIELD_START_ANGLE	Index of the start angle
protected float	vfEndAngle
protected float	vfRadius
protected float	vfStartAngle

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

Modifier	Constructor	Description
protected	BaseArc2D()	Construct a default instance of this class with the bind flag set to false and no time information set (effective value of zero).
protected	BaseArc2D(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	addLocalColorsListener(LocalColorsListener l)	Add a listener for local color changes.
void	addTexCoordGenModeChanged(TexCoordGenModeListener l)	Add a listener for texture coordinate generation mode changes.
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 i.e. MFNode and SFNode).
int	getNumFields()	Get the number of fields defined for this node.
int	getNumSets()	Get the number of texture coordinate sets contained by this node
int	getPrimaryType()	Get the primary type of this node.
String	getTexCoordGenMode(int setNum)	Get the texture coordinate generation mode.
boolean	hasLocalColorAlpha()	Specified whether this node has alpha values in the local colour information.
boolean	hasLocalColors()	Specified whether this node has color information.
boolean	isCCW()	Get the value of the CCW field.
boolean	isLightingEnabled()	Specifies whether this node requires lighting.
boolean	isSolid()	Get the value of the solid field.
void	removeLocalColorsListener(LocalColorsListener l)	Remove a listener for local color changes.
void	removeTexCoordGenModeChanged(TexCoordGenModeListener l)	Remove a listener for texture coordinate generation mode changes.
void	setTextureCount(int count)	Set the number of textures that were found on the accompanying Appearance node.
void	setValue(int index, float value)	Set the value of the field at the given index as a float.

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, sendRoute, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setupFinished, setUserData, setValue, 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

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, sendRoute, setDEF, setFrameStateManager, setMetadataObject, setupFinished, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Field Details

FIELD_START_ANGLE

protected static final int FIELD_START_ANGLE

Index of the start angle

See Also:

• Constant Field Values

FIELD_END_ANGLE

protected static final int FIELD_END_ANGLE

Index of the end angle

See Also:

• Constant Field Values

FIELD_RADIUS

protected static final int FIELD_RADIUS

Index of the arc radius

See Also:

• Constant Field Values

vfStartAngle

protected float vfStartAngle

vfEndAngle

protected float vfEndAngle

vfRadius

protected float vfRadius

Constructor Details

BaseArc2D

protected BaseArc2D()

Construct a default instance of this class with the bind flag set to false and no time information set (effective value of zero).

BaseArc2D

protected BaseArc2D(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 - Incorrect Node Type

Method Details

getPrimaryType

public int getPrimaryType()

Description copied from interface: VRMLNode

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

getFieldIndex

public int getFieldIndex(String fieldName)

Description copied from interface: VRMLNode

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

getNumFields

public int getNumFields()

Description copied from interface: VRMLNode

Get the number of fields defined for this node.

Specified by:

getNumFields in interface VRMLNode

Returns:

The number of fields.

getNodeFieldIndices

public int[] getNodeFieldIndices()

Description copied from interface: VRMLNode

Get the list of indices that correspond to fields that contain nodes i.e. 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)

Description copied from interface: VRMLNode

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

isSolid

public boolean isSolid()

Description copied from interface: VRMLGeometryNodeType

Get the value of the solid field.

Specified by:

isSolid in interface VRMLGeometryNodeType

Returns:

true This object is solid (ie single sided)

isCCW

public boolean isCCW()

Description copied from interface: VRMLGeometryNodeType

Get the value of the CCW field. If the node does not have one, this will return true.

Specified by:

isCCW in interface VRMLGeometryNodeType

Returns:

true if the vertices are CCW ordered

isLightingEnabled

public boolean isLightingEnabled()

Description copied from interface: VRMLGeometryNodeType

Specifies whether this node requires lighting.

Specified by:

isLightingEnabled in interface VRMLGeometryNodeType

Returns:

true Should lighting be enabled

setTextureCount

public void setTextureCount(int count)

Description copied from interface: VRMLGeometryNodeType

Set the number of textures that were found on the accompanying Appearance node. Used to set the number of texture coordinates that need to be passed in to the renderer when no explicit texture coordinates were given.

Specified by:

setTextureCount in interface VRMLGeometryNodeType

Parameters:

count - The number of texture coordinate sets to add

getNumSets

public int getNumSets()

Description copied from interface: VRMLGeometryNodeType

Get the number of texture coordinate sets contained by this node

Specified by:

getNumSets in interface VRMLGeometryNodeType

Returns:

the number of texture coordinate sets

getTexCoordGenMode

public String getTexCoordGenMode(int setNum)

Description copied from interface: VRMLGeometryNodeType

Get the texture coordinate generation mode. The values are constants defined in the X3D Spec under TextureCoordinateGenerator. NULL is returned if the texture coordinates are not generated.

Specified by:

getTexCoordGenMode in interface VRMLGeometryNodeType

Parameters:

setNum - The set which this tex gen mode refers.

Returns:

The mode or NULL

hasLocalColors

public boolean hasLocalColors()

Description copied from interface: VRMLGeometryNodeType

Specified whether this node has color information. If so, then it will be used for diffuse terms instead of materials.

Specified by:

hasLocalColors in interface VRMLGeometryNodeType

Returns:

true Use local color information for diffuse lighting.

hasLocalColorAlpha

public boolean hasLocalColorAlpha()

Description copied from interface: VRMLGeometryNodeType

Specified whether this node has alpha values in the local colour information. If so, then it will be used to override the material's transparency value.

Specified by:

hasLocalColorAlpha in interface VRMLGeometryNodeType

Returns:

true when the local color value has inbuilt alpha

addLocalColorsListener

public void addLocalColorsListener(LocalColorsListener l)

Description copied from interface: VRMLGeometryNodeType

Add a listener for local color changes. Nulls and duplicates will be ignored.

Specified by:

addLocalColorsListener in interface VRMLGeometryNodeType

Parameters:

l - The listener.

removeLocalColorsListener

public void removeLocalColorsListener(LocalColorsListener l)

Description copied from interface: VRMLGeometryNodeType

Remove a listener for local color changes. Nulls will be ignored.

Specified by:

removeLocalColorsListener in interface VRMLGeometryNodeType

Parameters:

l - The listener.

addTexCoordGenModeChanged

public void addTexCoordGenModeChanged(TexCoordGenModeListener l)

Description copied from interface: VRMLGeometryNodeType

Add a listener for texture coordinate generation mode changes. Nulls and duplicates will be ignored.

Specified by:

addTexCoordGenModeChanged in interface VRMLGeometryNodeType

Parameters:

l - The listener.

removeTexCoordGenModeChanged

public void removeTexCoordGenModeChanged(TexCoordGenModeListener l)

Description copied from interface: VRMLGeometryNodeType

Remove a listener for texture coordinate generation mode changes. Nulls will be ignored.

Specified by:

removeTexCoordGenModeChanged in interface VRMLGeometryNodeType

Parameters:

l - The listener.

setValue

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

Description copied from interface: VRMLNodeType

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

getFieldValue

public VRMLFieldData getFieldValue(int index)
                            throws InvalidFieldException

Description copied from interface: VRMLNodeType

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