Xj3D 2.0 VRML/X3D Code API

org.web3d.x3d.sai
Interface X3DBackgroundNode

All Superinterfaces:
X3DBindableNode, X3DChildNode, X3DNode
All Known Subinterfaces:
Background, TextureBackground

public interface X3DBackgroundNode
extends X3DBindableNode

Defines the requirements of an X3DBackgroundNode abstract node type

Version:
$Revision: 1.5 $
Author:
Rex Melton

Method Summary
 void getGroundAngle(float[] val)
          Return the groundAngle value in the argument float[]
 void getGroundColor(float[] val)
          Return the groundColor value in the argument float[]
 int getNumGroundAngle()
          Return the number of MFFloat items in the groundAngle field.
 int getNumGroundColor()
          Return the number of MFColor items in the groundColor field.
 int getNumSkyAngle()
          Return the number of MFFloat items in the skyAngle field.
 int getNumSkyColor()
          Return the number of MFColor items in the skyColor field.
 void getSkyAngle(float[] val)
          Return the skyAngle value in the argument float[]
 void getSkyColor(float[] val)
          Return the skyColor value in the argument float[]
 float getTransparency()
          Return the transparency float value.
 void setGroundAngle(float[] val)
          Set the groundAngle field.
 void setGroundColor(float[] val)
          Set the groundColor field.
 void setSkyAngle(float[] val)
          Set the skyAngle field.
 void setSkyColor(float[] val)
          Set the skyColor field.
 void setTransparency(float val)
          Set the transparency field.
 
Methods inherited from interface org.web3d.x3d.sai.X3DBindableNode
getBindTime, getIsBound, setBind
 
Methods inherited from interface org.web3d.x3d.sai.X3DNode
dispose, getField, getFieldDefinitions, getMetadata, getNodeName, getNodeType, isRealized, realize, setMetadata
 

Method Detail

getNumGroundAngle

int getNumGroundAngle()
Return the number of MFFloat items in the groundAngle field.

Returns:
the number of MFFloat items in the groundAngle field.

getGroundAngle

void getGroundAngle(float[] val)
Return the groundAngle value in the argument float[]

Parameters:
val - The float[] to initialize.

setGroundAngle

void setGroundAngle(float[] val)
Set the groundAngle field.

Parameters:
val - The float[] to set.

getNumGroundColor

int getNumGroundColor()
Return the number of MFColor items in the groundColor field.

Returns:
the number of MFColor items in the groundColor field.

getGroundColor

void getGroundColor(float[] val)
Return the groundColor value in the argument float[]

Parameters:
val - The float[] to initialize.

setGroundColor

void setGroundColor(float[] val)
Set the groundColor field.

Parameters:
val - The float[] to set.

getNumSkyAngle

int getNumSkyAngle()
Return the number of MFFloat items in the skyAngle field.

Returns:
the number of MFFloat items in the skyAngle field.

getSkyAngle

void getSkyAngle(float[] val)
Return the skyAngle value in the argument float[]

Parameters:
val - The float[] to initialize.

setSkyAngle

void setSkyAngle(float[] val)
Set the skyAngle field.

Parameters:
val - The float[] to set.

getNumSkyColor

int getNumSkyColor()
Return the number of MFColor items in the skyColor field.

Returns:
the number of MFColor items in the skyColor field.

getSkyColor

void getSkyColor(float[] val)
Return the skyColor value in the argument float[]

Parameters:
val - The float[] to initialize.

setSkyColor

void setSkyColor(float[] val)
Set the skyColor field.

Parameters:
val - The float[] to set.

getTransparency

float getTransparency()
Return the transparency float value.

Returns:
The transparency float value.

setTransparency

void setTransparency(float val)
Set the transparency field.

Parameters:
val - The float to set.

Xj3D 2.0 VRML/X3D Code API

Copyright © 2001 - 2006 Web3D Consortium