
Aviatrix3D 2.1.0 

PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 
java.lang.Object org.j3d.aviatrix3d.picking.PickRequest
public class PickRequest
Used to represent a picking request to the system.
To pick within the scene graph, the user fills out the fields of this class and then calls the appropriate pick method on the node or group that is the picking root. A pick consists of the geometry type, information about that geometry (origin, extents, radius etc) and then whether to only pick a single object, multiple objects and whether to sort them.
Field Summary  

float 
additionalData
When the geometry type is a cone, This is the spread angle in radians. 
float[] 
destination
The ending location or the direction vector, depending on the geometry type requested. 
static int 
FIND_ALL
Find anything that is pickable, regardless of the mask set on the geometry. 
static int 
FIND_COLLIDABLES
Find anything that is defined as being collidable. 
static int 
FIND_GENERAL
Find any general pickable node type. 
static int 
FIND_PROXIMITY
Define the picking as being an object that is near something. 
static int 
FIND_VISIBLES
Define the picking as being an object that is visible. 
java.lang.Object 
foundPaths
The picked data is placed here. 
boolean 
generateVWorldMatrix
If this flag is set to true, generate the local to virtual world matrix for the picked result. 
float[] 
origin
The starting location of the picking request 
static int 
PICK_BOX
Pick using a box. 
static int 
PICK_CONE
Pick using an infinite cone. 
static int 
PICK_CONE_SEGMENT
Pick using a length of cone. 
static int 
PICK_CYLINDER
Pick using an infinite cylinder. 
static int 
PICK_CYLINDER_SEGMENT
Pick using a length of cylinder. 
static int 
PICK_FRUSTUM
Pick the geometry that is in the given view frustum. 
static int 
PICK_LINE_SEGMENT
Pick using a segment of a line. 
static int 
PICK_POINT
Pick using a point location. 
static int 
PICK_RAY
Pick using a ray location. 
static int 
PICK_SPHERE
Pick using a sphere. 
int 
pickCount
The number of valid picks that were found in this request. 
int 
pickGeometryType
What type of geometry intersection testing should be performed? 
int 
pickSortType
How the return data be sorted. 
int 
pickType
What sort of thing should we be picking for. 
static int 
SORT_ALL
Pick all objects that intersect, but don't sort them 
static int 
SORT_ANY
Pick anything that matches  most likely the first one it comes across 
static int 
SORT_CLOSEST
Pick only the closest object. 
static int 
SORT_ORDERED
Pick all objects and sort by closest order. 
boolean 
useGeometry
When the picking geometry is line or segment based, should the pick action be against the bounds or the actual geometry? 
Constructor Summary  

PickRequest()
Create a new instance of this class with all values set to their defaults. 
Method Summary 

Methods inherited from class java.lang.Object 

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

public static final int FIND_ALL
public static final int FIND_GENERAL
public static final int FIND_COLLIDABLES
public static final int FIND_VISIBLES
public static final int FIND_PROXIMITY
public static final int PICK_POINT
origin
is used as input and it describes the point's
location in world space.
public static final int PICK_RAY
origin
as
the start point and destination
is the direction vector.
public static final int PICK_LINE_SEGMENT
origin
as the start point and destination
is the end point.
public static final int PICK_CYLINDER
origin
and destination
represent the centers of the two
end points of the cylinder. additionalData
represents the
radius of the cylinder.
public static final int PICK_CYLINDER_SEGMENT
origin
and destination
represent the centers of the two
end points of the cylinder. additionalData
represents the
radius of the cylinder.
public static final int PICK_CONE
origin
represents the location of the point of the cone and
destination
is the vector representing the axis. The cone is
infinite in length, with additionalData
representing the
spread angle of the cone
public static final int PICK_CONE_SEGMENT
origin
represents the location of the point of the cone and
destination
is the vector representing the axis. The cone is
infinite in length, with additionalData
representing the
spread angle of the cone
public static final int PICK_BOX
origin
represents the minimum extents of the box while
destination
represents the maximum extents.
public static final int PICK_SPHERE
origin
is used as the center of the sphere and it describes
the location world space. additionalData
is used to specify the
radius of the sphere.
public static final int PICK_FRUSTUM
A positive pick is any bounding volume or geometry that is explicitly not completely out of the frustum. So long as part of the geometry falls within the frustum, it is considered a successful find.
public static final int SORT_ALL
public static final int SORT_ANY
public static final int SORT_ORDERED
public static final int SORT_CLOSEST
public int pickType
public int pickGeometryType
public boolean useGeometry
public int pickSortType
public float[] origin
public float[] destination
public float additionalData
public java.lang.Object foundPaths
public int pickCount
public boolean generateVWorldMatrix
Constructor Detail 

public PickRequest()

Aviatrix3D 2.1.0 

PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 