Package org.web3d.x3d.sai.networking

Interface Anchor

All Superinterfaces:

X3DBoundedObject, X3DChildNode, X3DGroupingNode, X3DNode

All Known Implementing Classes:

SAIAnchor, SAIAnchor

public interface Anchor
extends X3DGroupingNode

Defines the requirements of an X3D Anchor node

Version:

$Revision: 1.1 $

Author:

Rex Melton

Method Summary

Modifier and Type	Method	Description
double	getAutoRefresh()	Get the autoRefresh value for this link.
double	getAutoRefreshTimeLimit()	Get the autoRefreshTimeLimit value to associate with the link.
String	getDescription()	Return the description String value.
int	getNumParameter()	Return the number of MFString items in the parameter field.
int	getNumUrl()	Return the number of MFString items in the url field.
void	getParameter(String[] val)	Return the parameter value in the argument String[]
void	getUrl(String[] val)	Return the url value in the argument String[]
void	setAutoRefresh(double newValue)	Set the autoRefresh value for this link
void	setAutoRefreshTimeLimit(double newValue)	Set the autoRefreshimeLimit value for this link.
void	setDescription(String val)	Set the description field.
void	setParameter(String[] val)	Set the parameter field.
void	setUrl(String[] val)	Set the url field.

Methods inherited from interface org.web3d.x3d.sai.X3DBoundedObject

getBboxCenter, getBboxSize, setBboxCenter, setBboxSize

Methods inherited from interface org.web3d.x3d.sai.X3DGroupingNode

addChildren, getChildren, getNumChildren, removeChildren, setChildren

Methods inherited from interface org.web3d.x3d.sai.X3DNode

dispose, getField, getFieldDefinitions, getMetadata, getNodeName, getNodeType, isRealized, realize, setMetadata

Method Details

getDescription

String getDescription()

Return the description String value.

Returns:

The description String value.

setDescription

void setDescription(String val)

Set the description field.

Parameters:

val - The String to set.

getNumParameter

int getNumParameter()

Return the number of MFString items in the parameter field.

Returns:

the number of MFString items in the parameter field.

getParameter

void getParameter(String[] val)

Return the parameter value in the argument String[]

Parameters:

val - The String[] to initialize.

setParameter

void setParameter(String[] val)

Set the parameter field.

Parameters:

val - The String[] to set.

getNumUrl

int getNumUrl()

Return the number of MFString items in the url field.

Returns:

the number of MFString items in the url field.

getUrl

void getUrl(String[] val)

Return the url value in the argument String[]

Parameters:

val - The String[] to initialize.

setUrl

void setUrl(String[] val)

Set the url field.

Parameters:

val - The String[] to set.

getAutoRefresh

double getAutoRefresh()

Get the autoRefresh value for this link.

Returns:

setAutoRefresh

void setAutoRefresh(double newValue)

Set the autoRefresh value for this link

Parameters:

newValue -

getAutoRefreshTimeLimit

double getAutoRefreshTimeLimit()

Get the autoRefreshTimeLimit value to associate with the link.

Returns:

The current autoRefreshTimeLimit value

setAutoRefreshTimeLimit

void setAutoRefreshTimeLimit(double newValue)

Set the autoRefreshimeLimit value for this link.

Parameters:

newValue - The new autoRefresh value to set