Package org.web3d.x3d.sai

Interface X3DPickingNode

All Superinterfaces:

X3DChildNode, X3DNode, X3DSensorNode

All Known Subinterfaces:

LinePickSensor, PointPickSensor, PrimitivePickSensor, VolumePickSensor

All Known Implementing Classes:

SAILinePickSensor, SAILinePickSensor, SAIPointPickSensor, SAIPointPickSensor, SAIPrimitivePickSensor, SAIPrimitivePickSensor, SAIVolumePickSensor, SAIVolumePickSensor

public interface X3DPickingNode
extends X3DSensorNode

Defines the requirements of an X3DPickingNode abstract node type

Version:

$Revision: 1.1 $

Author:

Rex Melton

Method Summary

Modifier and Type	Method	Description
String	getIntersectionType()	Return the intersectionType String value.
int	getNumObjectType()	Return the number of MFString items in the objectType field.
int	getNumPickedGeometry()	Return the number of MFNode items in the pickedGeometry field.
int	getNumPickTarget()	Return the number of MFNode items in the pickTarget field.
void	getObjectType(String[] val)	Return the objectType value in the argument String[]
void	getPickedGeometry(X3DNode[] val)	Return the pickedGeometry value in the argument X3DNode[]
X3DNode	getPickingGeometry()	Return the pickingGeometry X3DNode value.
void	getPickTarget(X3DNode[] val)	Return the pickTarget value in the argument X3DNode[]
String	getSortOrder()	Return the sortOrder String value.
void	setIntersectionType(String val)	Set the intersectionType field.
void	setObjectType(String[] val)	Set the objectType field.
void	setPickingGeometry(X3DNode val)	Set the pickingGeometry field.
void	setPickTarget(X3DNode[] val)	Set the pickTarget field.
void	setSortOrder(String val)	Set the sortOrder field.

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

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

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

getEnabled, getIsActive, setEnabled

Method Details

getPickingGeometry

X3DNode getPickingGeometry()

Return the pickingGeometry X3DNode value.

Returns:

The pickingGeometry X3DNode value.

setPickingGeometry

void setPickingGeometry(X3DNode val)

Set the pickingGeometry field.

Parameters:

val - The X3DNode to set.

getNumPickTarget

int getNumPickTarget()

Return the number of MFNode items in the pickTarget field.

Returns:

the number of MFNode items in the pickTarget field.

getPickTarget

void getPickTarget(X3DNode[] val)

Return the pickTarget value in the argument X3DNode[]

Parameters:

val - The X3DNode[] to initialize.

setPickTarget

void setPickTarget(X3DNode[] val)

Set the pickTarget field.

Parameters:

val - The X3DNode[] to set.

getIntersectionType

String getIntersectionType()

Return the intersectionType String value.

Returns:

The intersectionType String value.

setIntersectionType

void setIntersectionType(String val)

Set the intersectionType field.

Parameters:

val - The String to set.

getNumPickedGeometry

int getNumPickedGeometry()

Return the number of MFNode items in the pickedGeometry field.

Returns:

the number of MFNode items in the pickedGeometry field.

getPickedGeometry

void getPickedGeometry(X3DNode[] val)

Return the pickedGeometry value in the argument X3DNode[]

Parameters:

val - The X3DNode[] to initialize.

getSortOrder

String getSortOrder()

Return the sortOrder String value.

Returns:

The sortOrder String value.

setSortOrder

void setSortOrder(String val)

Set the sortOrder field.

Parameters:

val - The String to set.

getNumObjectType

int getNumObjectType()

Return the number of MFString items in the objectType field.

Returns:

the number of MFString items in the objectType field.

getObjectType

void getObjectType(String[] val)

Return the objectType value in the argument String[]

Parameters:

val - The String[] to initialize.

setObjectType

void setObjectType(String[] val)

Set the objectType field.

Parameters:

val - The String[] to set.