org.j3d.aviatrix3d.picking
Class PickInstructions

java.lang.Object
  org.j3d.aviatrix3d.picking.PickInstructions

public class PickInstructions
extends java.lang.Object

Container for returning the details about what should be picked as a a set of children from a node that implements the CustomPickTarget interface.

The data stored in this class is considered to be temporary only - it lasts just enough time to process the children for further pickable objects.

Version:

$Revision: 1.1 $

Author:

Justin Couch

Field Summary

PickTarget[]	children The array of children pickables that are valid children for travering for further culling.
boolean	hasTransform Flag to indicate if the transform needs to be used from this class as part of the traversal of the scene graph.
javax.vecmath.Matrix4f	localTransform The local transformation matrix that should be applied as part of the traversal process.
int	numChildren The number of children to process from the list.

Constructor Summary

PickInstructions()
Initialise a new instance of this instruction.

Method Summary

void	resizeChildren(int size) Convenience method to resize the children array to be at least the required minimum size.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

children

public PickTarget[] children

The array of children pickables that are valid children for travering for further culling. If the array is not large enough, the user is allowed to directly resize the array to something large enough, or make use of the utility method of this class.

numChildren

public int numChildren

The number of children to process from the list.

hasTransform

public boolean hasTransform

Flag to indicate if the transform needs to be used from this class as part of the traversal of the scene graph.

localTransform

public javax.vecmath.Matrix4f localTransform

The local transformation matrix that should be applied as part of the traversal process. If no transformation is needed. then set hasTransform to false and ignore this matrix.

Constructor Detail

PickInstructions

public PickInstructions()

Initialise a new instance of this instruction.

Method Detail

resizeChildren

public void resizeChildren(int size)

Convenience method to resize the children array to be at least the required minimum size. This method will always resize, so only call it if it must be resized. The old values in the old array are discarded.

Parameters:

size - The minimum length that this array should be