org.j3d.aviatrix3d.picking
Interface GroupPickTarget

All Superinterfaces:

PickTarget

All Known Implementing Classes:

Axis, Group, Group2D, MaskedSwitch, PixelTransform, SharedGroup, SharedGroup2D, SwitchGroup, TransformGroup

public interface GroupPickTarget
extends PickTarget

A picking target that contains a collection of zero or more children pickable targets.

This interface is used by programmers that require fairly complex implementation logic at the point of picking (eg a billboarded object that should be pickable from any direction, even though it is represented as a plane facing the current viewpoint location).

Implementor Guidelines

There is no requirement that the picking and rendering subgraphs look the same. There may be less pickable children than renderable children, so don't automatically assume that there is.

Version:

$Revision: 1.1 $

Author:

Justin Couch

Field Summary

Fields inherited from interface org.j3d.aviatrix3d.picking.PickTarget

CUSTOM_PICK_TYPE, GROUP_PICK_TYPE, LEAF_PICK_TYPE, SINGLE_PICK_TYPE

Method Summary

PickTarget	getPickableChild(int idx) Return the pickable target instance at the given index.
PickTarget[]	getPickableChildren() Return an array containing all of this group's pickable children.
int	numPickableChildren() Returns the number of valid pickable child targets to process.

Methods inherited from interface org.j3d.aviatrix3d.picking.PickTarget

checkPickMask, getPickableBounds, getPickTargetType

Method Detail

numPickableChildren

int numPickableChildren()

Returns the number of valid pickable child targets to process. If there are no valid children return -1.

Returns:

A number greater than or equal to zero or -1

getPickableChildren

PickTarget[] getPickableChildren()

Return an array containing all of this group's pickable children. This structure is the nodes internal representation. Check the numPickableChildren() call for how many valid objects are part of this array.If there are none, this may return either a null or a valid array, depending on the implementation.

The list may contain null values.

Returns:

An array of pick targets

getPickableChild

PickTarget getPickableChild(int idx)

Return the pickable target instance at the given index. If there is nothing at the given index, null will be returned.

Parameters:

idx - The index of the child to get

Returns:

The target object at the given index.