gumbo.graphic.probe
Interface PickSensor

All Known Implementing Classes:

AbstractPickSensor

public interface PickSensor

An interface for a picking facade acting as a source of interactive (mouse-based) picking results (like a sensor). As such, this interface controls only the position of the picker shape relative to an assumed display space. Although general control of the direction and orientation of a picker is not supported by this interface, the input position can be used to control a translation node above the picker shape in a view space tree, with the view transform in a world space tree being controlled through other means.

Typically, the pick space and position inputs are provided by a mouse sensor.

Version:

$Revision: 1.3 $

Author:

Jon Barrilleaux (jonb@jmbaai.com) of JMB and Associates Inc.

Method Summary

BooleanField.EventIn	getPickActiveIn() While false, picking geometry inputs are assumed invalid, with pick requests generating a null pick result.
BooleanField.EventIn	getPickDiscreteIn() If true, a pick occurs only when a pick request is received (getPickRequestIn()); otherwise, a pick request is generated each time the pick geometry (position, orientation) changes.
BooleanField.EventIn	getPickEnableIn() Enables/disables this sensor.
Point3Field.EventIn	getPickPositionIn() The position of the picker shape's origin relative to the pick space input.
NotifyNode.EventIn	getPickRequestIn() A pick is performed using the current pick geometry.
PickResultField.EventOut	getPickResultOut() Sends an event each time a pick is requested.
SpaceNodeField.EventIn	getPickSpaceIn() The reference space for the pick position input.

Method Detail

getPickEnableIn

public BooleanField.EventIn getPickEnableIn()

Enables/disables this sensor. While disabled, inputs are ignored and there are no outputs. May cause re-initialization of internal state (such as discovery of pickables). The default is true.

getPickActiveIn

public BooleanField.EventIn getPickActiveIn()

While false, picking geometry inputs are assumed invalid, with pick requests generating a null pick result. The default is false.

getPickDiscreteIn

public BooleanField.EventIn getPickDiscreteIn()

If true, a pick occurs only when a pick request is received (getPickRequestIn()); otherwise, a pick request is generated each time the pick geometry (position, orientation) changes. The default is false (continuous picking).

getPickRequestIn

public NotifyNode.EventIn getPickRequestIn()

A pick is performed using the current pick geometry.

getPickSpaceIn

public SpaceNodeField.EventIn getPickSpaceIn()

The reference space for the pick position input. Never null while active.

getPickPositionIn

public Point3Field.EventIn getPickPositionIn()

The position of the picker shape's origin relative to the pick space input. Never null while active.

getPickResultOut

public PickResultField.EventOut getPickResultOut()

Sends an event each time a pick is requested. If the pick is valid, contains none or more hits; otherwise, sends null, which occurs if the pick operation is benignly invalid (picking is inactive) or should be ignored (consumed by the native graphic system). If discrete in is false (continuous picking), outputs a null result before active in goes false.