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

Class BaseCustomViewport

java.lang.Object

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

org.web3d.vrml.renderer.common.nodes.layering.BaseCustomViewport

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLNodeType, VRMLViewportNodeType

Direct Known Subclasses:

NRCustomViewport, OGLCustomViewport

public class BaseCustomViewport
extends AbstractNode
implements VRMLViewportNodeType

Base representation of the CustomViewport node.

The node is defined as:

 CustomViewport : X3DViewportNode {
   SFNode  [in,out] metadata    NULL
   SFBool  []       fixedX      TRUE
   SFBool  []       fixedY      TRUE
   SFBool  []       fixedHeight TRUE
   SFBool  []       fixedWidth  TRUE
   SFFloat []       x           0
   SFFloat []       y           0
   SFFloat []       height      0
   SFFloat []       width       0
 }
 

Version:

$Revision: 1.4 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	vfFixedHeight	initializeOnly SFBool height 0
protected boolean	vfFixedWidth	initializeOnly SFBool width 0
protected boolean	vfFixedX	initializeOnly SFBool x 0
protected boolean	vfFixedY	initializeOnly SFBool y 0
protected float	vfHeight	initializeOnly SFFloat height 0
protected float	vfWidth	initializeOnly SFFloat width 0
protected float	vfX	initializeOnly SFFloat x 0
protected float	vfY	initializeOnly SFFloat y 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.VRMLViewportNodeType

VIEWPORT_CUSTOM, VIEWPORT_FIXED, VIEWPORT_FULLWINDOW, VIEWPORT_PROPORTIONAL, VIEWPORT_UNDEFINED

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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.
float	getViewHeight()	Get the height of the viewport.
int	getViewportType()	Get the type of viewport layout policy that this node represents.
float	getViewWidth()	Get the width of the viewport.
float	getViewX()	Get the starting X coordinate of the viewport.
float	getViewY()	Get the starting Y coordinate of the viewport.
boolean	isFixedHeight()	Query whether the viewport height uses fixed (pixel) addressing or is proportional to the screen size.
boolean	isFixedWidth()	Query whether the viewport width uses fixed (pixel) addressing or is proportional to the screen size.
boolean	isFixedX()	Query whether the viewport X component uses fixed (pixel) addressing or is proportional to the screen size.
boolean	isFixedY()	Query whether the viewport Y component uses fixed (pixel) addressing or is proportional to the screen size.
void	setValue(int index, boolean value)	Set the value of the field at the given index as an integer.
void	setValue(int index, float value)	Set the value of the field at the given index as an integer.

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

Field Details

vfFixedX

protected boolean vfFixedX

initializeOnly SFBool x 0

vfFixedY

protected boolean vfFixedY

initializeOnly SFBool y 0

vfFixedWidth

protected boolean vfFixedWidth

initializeOnly SFBool width 0

vfFixedHeight

protected boolean vfFixedHeight

initializeOnly SFBool height 0

vfX

protected float vfX

initializeOnly SFFloat x 0

vfY

protected float vfY

initializeOnly SFFloat y 0

vfWidth

protected float vfWidth

initializeOnly SFFloat width 0

vfHeight

protected float vfHeight

initializeOnly SFFloat height 0

Constructor Details

BaseCustomViewport

protected BaseCustomViewport()

Construct a new default instance of this class.

BaseCustomViewport

protected BaseCustomViewport(VRMLNodeType other)

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

Parameters:

other - The node to copy

Throws:

IllegalArgumentException - Incorrect Node Type

Method Details

getViewportType

public int getViewportType()

Get the type of viewport layout policy that this node represents. This determines how the viewport is managed by the system during window resizes etc. It is a fixed value that never changes for the node implementation.

Specified by:

getViewportType in interface VRMLViewportNodeType

Returns:

One of the VIEWPORT_* constant values

isFixedX

public boolean isFixedX()

Query whether the viewport X component uses fixed (pixel) addressing or is proportional to the screen size.

Specified by:

isFixedX in interface VRMLViewportNodeType

Returns:

True if fixed addressing is to be used

isFixedY

public boolean isFixedY()

Query whether the viewport Y component uses fixed (pixel) addressing or is proportional to the screen size.

Specified by:

isFixedY in interface VRMLViewportNodeType

Returns:

True if fixed addressing is to be used

isFixedWidth

public boolean isFixedWidth()

Query whether the viewport width uses fixed (pixel) addressing or is proportional to the screen size.

Specified by:

isFixedWidth in interface VRMLViewportNodeType

Returns:

True if fixed addressing is to be used

isFixedHeight

public boolean isFixedHeight()

Query whether the viewport height uses fixed (pixel) addressing or is proportional to the screen size.

Specified by:

isFixedHeight in interface VRMLViewportNodeType

Returns:

True if fixed addressing is to be used

getViewX

public float getViewX()

Get the starting X coordinate of the viewport. Whether this is treated as a pixel or percentage depends on the type of viewport node this node is. If it is a pixel value, it will always be an integer value.

Specified by:

getViewX in interface VRMLViewportNodeType

Returns:

The X coordinate to start the viewport at

getViewY

public float getViewY()

Get the starting Y coordinate of the viewport. Whether this is treated as a pixel or percentage depends on the type of viewport node this node is. If it is a pixel value, it will always be an integer value.

Specified by:

getViewY in interface VRMLViewportNodeType

Returns:

The Y coordinate to start the viewport at

getViewWidth

public float getViewWidth()

Get the width of the viewport. Whether this is treated as a pixel or percentage depends on the type of viewport node this node is. If it is a pixel value, it will always be an integer value.

Specified by:

getViewWidth in interface VRMLViewportNodeType

Returns:

The width of the viewport

getViewHeight

public float getViewHeight()

Get the height of the viewport. Whether this is treated as a pixel or percentage depends on the type of viewport node this node is. If it is a pixel value, it will always be an integer value.

Specified by:

getViewHeight in interface VRMLViewportNodeType

Returns:

The height of the viewport

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

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

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

setValue

public void setValue(int index,
 boolean value)
              throws InvalidFieldException,
InvalidFieldAccessException

Set the value of the field at the given index as an integer. This would be used to set SFBool 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 field

Throws:

InvalidFieldException - The index does not match a known field

InvalidFieldAccessException - The node does not match the required accessType.

setValue

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

Set the value of the field at the given index as an integer. 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 field

Throws:

InvalidFieldException - The index does not match a known field

InvalidFieldAccessException - The call is attempting to write to a field that does not permit writing now