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

Class OGLPointProperties

java.lang.Object

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

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

org.web3d.vrml.renderer.ogl.nodes.shape.OGLPointProperties

All Implemented Interfaces:

org.j3d.aviatrix3d.NodeUpdateListener, VRMLNode, FrameStateListener, VRMLAppearanceChildNodeType, VRMLNodeType, VRMLPointPropertiesNodeType, OGLVRMLNode

public class OGLPointProperties
extends BasePointProperties
implements OGLVRMLNode, org.j3d.aviatrix3d.NodeUpdateListener

Aviatrix3D renderer implementation of an PointProperties node.

Version:

$Revision: 1.2 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
int	defColorMode	Default value of colorMode

Fields inherited from class org.web3d.vrml.renderer.common.nodes.shape.BasePointProperties

colorMode, FIELD_COLOR_MODE, FIELD_POINTSIZE_ATTENUATION, FIELD_POINTSIZE_MAX_VALUE, FIELD_POINTSIZE_MIN_VALUE, FIELD_POINTSIZE_SCALE_FACTOR, NUM_FIELDS, POINT_COLORMODE, TEXTURE_AND_POINT_COLORMODE, TEXTURE_COLORMODE, vfColorMode, vfPointsizeAttenuation, vfPointsizeMaxValue, vfPointsizeMinValue, vfPointsizeScaleFactor

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

Constructor	Description
OGLPointProperties()	Default constructor.
OGLPointProperties(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 OpenGL scene graph object representation of this node.
void	setColorMode(String value)	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)	Override the base setting to update the Java3D representation of the point style.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	updateNodeBoundsChanges(Object src)	Notification that its safe to update the node now with any operations that could potentially effect the node's bounds.
void	updateNodeDataChanges(Object src)	Notification that its safe to update the node now with any operations that only change the node's properties, but do not change the bounds.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.shape.BasePointProperties

getColorMode, getFieldDeclaration, getFieldIndex, getFieldValue, getNodeFieldIndices, getNumFields, getPrimaryType, sendRoute, setColorMode, setValue, setValue, setValue

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

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

Field Details

defColorMode

public int defColorMode

Default value of colorMode

Constructor Details

OGLPointProperties

public OGLPointProperties()

Default constructor.

OGLPointProperties

public OGLPointProperties(VRMLNodeType node)

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

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not a Group node

Method Details

getSceneGraphObject

public org.j3d.aviatrix3d.SceneGraphObject getSceneGraphObject()

Get the OpenGL scene graph object representation of this node. Scripts always return null.

Specified by:

getSceneGraphObject in interface OGLVRMLNode

Returns:

null

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

updateNodeBoundsChanges

public void updateNodeBoundsChanges(Object src)

Notification that its safe to update the node now with any operations that could potentially effect the node's bounds.

Specified by:

updateNodeBoundsChanges in interface org.j3d.aviatrix3d.NodeUpdateListener

Parameters:

src - The node or Node Component that is to be updated.

updateNodeDataChanges

public void updateNodeDataChanges(Object src)

Notification that its safe to update the node now with any operations that only change the node's properties, but do not change the bounds.

Specified by:

updateNodeDataChanges in interface org.j3d.aviatrix3d.NodeUpdateListener

Parameters:

src - The node or Node Component that is to be updated.

setPointSizeScale

protected void setPointSizeScale(float value)
                          throws InvalidFieldValueException

Override the base setting to update the Java3D representation of the point style.

Overrides:

setPointSizeScale in class BasePointProperties

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

Description copied from class: BasePointProperties

Set the point size min value to the new value.

Overrides:

setPointSizeMin in class BasePointProperties

Parameters:

value - The min value to set

Throws:

InvalidFieldValueException - The submitted value is out of range

setPointSizeMax

protected void setPointSizeMax(float value)
                        throws InvalidFieldValueException

Description copied from class: BasePointProperties

Set the point size max value to the new value.

Overrides:

setPointSizeMax in class BasePointProperties

Parameters:

value - The max value to set

Throws:

InvalidFieldValueException - The submitted value is out of range

setPointSizeAttenuation

protected void setPointSizeAttenuation(float[] factor)
                                throws InvalidFieldValueException

Description copied from class: BasePointProperties

Set the attenuation factor of the point size.

Overrides:

setPointSizeAttenuation in class BasePointProperties

Parameters:

factor - The new attenuation factor to use

Throws:

InvalidFieldValueException - Attenuation was not [0,1]

setColorMode

public void setColorMode(String value)
                  throws InvalidFieldValueException

Description copied from class: BasePointProperties

Set the color mode to the new value.

Specified by:

setColorMode in interface VRMLPointPropertiesNodeType

Overrides:

setColorMode in class BasePointProperties

Parameters:

value - The color mode to set

Throws:

InvalidFieldValueException - The submitted value is out of range