JavaFX 24 · javafx.scene.input.PickResult · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private double	distance
private int	face
public static final int	FACE_UNDEFINED An undefined face.
private Node	node
private Point3D	normal
private Point3D	point
private Point2D	texCoord

Constructor Summary

Access	Constructor and Description
public	PickResult(Node The intersected node node, Point3D The intersected point in local coordinate of the picked Node point, double The intersected distance between camera position and the picked Node distance, int The intersected face of the picked Node face, Point2D The intersected texture coordinates of the picked Node texCoord) Creates a new instance of PickResult.
public	PickResult(Node The intersected node node, Point3D The intersected point in local coordinate of the picked Node point, double The intersected distance between camera position and the picked Node distance, int The intersected face of the picked Node face, Point3D The intersected normal of the picked Node normal, Point2D The intersected texture coordinates of the picked Node texCoord) Creates a new instance of PickResult.
public	PickResult(Node The intersected node node, Point3D The intersected point in local coordinate of the picked Node point, double The intersected distance between camera position and the picked Node distance) Creates a new instance of PickResult for a non-3d-shape target.
public	PickResult(EventTarget The picked target (null in case of a Scene) target, double The scene X coordinate sceneX, double The scene Y coordinate sceneY) Creates a pick result for a 2D case where no additional information is needed.

Method Summary

Modifier and Type	Method and Description
public final double	Returns: the distance from camera to the intersection getIntersectedDistance() Returns the intersected distance between camera position and the intersected point.
public final int	Returns: the picked face getIntersectedFace() Returns the intersected face of the picked Node, FACE_UNDEFINED if the node doesn't have user-specified faces or was picked on bounds.
public final Node	Returns: the picked node or null if no node was picked getIntersectedNode() Returns the intersected node.
public final Point3D	Returns: a new Point3D presenting the intersected normal getIntersectedNormal() Return the intersected normal of the picked 3d shape.
public final Point3D	Returns: new Point3D presenting the intersected point getIntersectedPoint() Returns the intersected point in local coordinate of the picked Node.
public final Point2D	Returns: a new Point2D presenting the intersected TexCoord getIntersectedTexCoord() Return the intersected texture coordinates of the picked 3d shape.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

distance	back to summary
private double distance

face	back to summary
private int face

FACE_UNDEFINED	back to summary
public static final int FACE_UNDEFINED An undefined face. This value is used for the intersected face if the picked node has no user-specified faces.

node	back to summary
private Node node

normal	back to summary
private Point3D normal

point	back to summary
private Point3D point

texCoord	back to summary
private Point2D texCoord

Constructor Detail

PickResult	back to summary
public PickResult(Node node, Point3D point, double distance, int face, Point2D texCoord) Creates a new instance of PickResult. Parameters node:Node The intersected node point:Point3D The intersected point in local coordinate of the picked Node distance:double The intersected distance between camera position and the picked Node face:int The intersected face of the picked Node texCoord:Point2D The intersected texture coordinates of the picked Node

PickResult

back to summary

public PickResult(Node node, Point3D point, double distance, int face, Point2D texCoord)

Creates a new instance of PickResult.

Parameters

node:Node: The intersected node
point:Point3D: The intersected point in local coordinate of the picked Node
distance:double: The intersected distance between camera position and the picked Node
face:int: The intersected face of the picked Node
texCoord:Point2D: The intersected texture coordinates of the picked Node

PickResult	back to summary
public PickResult(Node node, Point3D point, double distance, int face, Point3D normal, Point2D texCoord) Creates a new instance of PickResult. Parameters node:Node The intersected node point:Point3D The intersected point in local coordinate of the picked Node distance:double The intersected distance between camera position and the picked Node face:int The intersected face of the picked Node normal:Point3D The intersected normal of the picked Node texCoord:Point2D The intersected texture coordinates of the picked Node Since JavaFX 8u40

PickResult

back to summary

public PickResult(Node node, Point3D point, double distance, int face, Point3D normal, Point2D texCoord)

Creates a new instance of PickResult.

Parameters

node:Node: The intersected node
point:Point3D: The intersected point in local coordinate of the picked Node
distance:double: The intersected distance between camera position and the picked Node
face:int: The intersected face of the picked Node
normal:Point3D: The intersected normal of the picked Node
texCoord:Point2D: The intersected texture coordinates of the picked Node

Since

JavaFX 8u40

PickResult	back to summary
public PickResult(Node node, Point3D point, double distance) Creates a new instance of PickResult for a non-3d-shape target. Sets face to FACE_UNDEFINED and texCoord to null. Parameters node:Node The intersected node point:Point3D The intersected point in local coordinate of the picked Node distance:double The intersected distance between camera position and the picked Node

PickResult

back to summary

public PickResult(Node node, Point3D point, double distance)

Creates a new instance of PickResult for a non-3d-shape target. Sets face to FACE_UNDEFINED and texCoord to null.

Parameters

node:Node: The intersected node
point:Point3D: The intersected point in local coordinate of the picked Node
distance:double: The intersected distance between camera position and the picked Node

PickResult	back to summary
public PickResult(EventTarget target, double sceneX, double sceneY) Creates a pick result for a 2D case where no additional information is needed. Converts the given scene coordinates to the target's local coordinate space and stores the value as the intersected point. Sets intersected node to the given target, distance to 1.0, face to FACE_UNDEFINED and texCoord to null. Parameters target:EventTarget The picked target (null in case of a Scene) sceneX:double The scene X coordinate sceneY:double The scene Y coordinate

PickResult

back to summary

public PickResult(EventTarget target, double sceneX, double sceneY)

Creates a pick result for a 2D case where no additional information is needed. Converts the given scene coordinates to the target's local coordinate space and stores the value as the intersected point. Sets intersected node to the given target, distance to 1.0, face to FACE_UNDEFINED and texCoord to null.

Parameters

target:EventTarget: The picked target (null in case of a Scene)
sceneX:double: The scene X coordinate
sceneY:double: The scene Y coordinate

Method Detail

getIntersectedDistance	back to summary
public final double getIntersectedDistance() Returns the intersected distance between camera position and the intersected point. Returns:double the distance from camera to the intersection

getIntersectedDistance

back to summary

public final double getIntersectedDistance()

Returns the intersected distance between camera position and the intersected point.

Returns:double: the distance from camera to the intersection

getIntersectedFace	back to summary
public final int getIntersectedFace() Returns the intersected face of the picked Node, FACE_UNDEFINED if the node doesn't have user-specified faces or was picked on bounds. Returns:int the picked face

getIntersectedFace

back to summary

public final int getIntersectedFace()

Returns the intersected face of the picked Node, FACE_UNDEFINED if the node doesn't have user-specified faces or was picked on bounds.

Returns:int: the picked face

getIntersectedNode	back to summary
public final Node getIntersectedNode() Returns the intersected node. Returns null if there was no intersection with any node and the scene was picked. Returns:Node the picked node or null if no node was picked

getIntersectedNode

back to summary

public final Node getIntersectedNode()

Returns the intersected node. Returns null if there was no intersection with any node and the scene was picked.

Returns:Node: the picked node or null if no node was picked

getIntersectedNormal	back to summary
public final Point3D getIntersectedNormal() Return the intersected normal of the picked 3d shape. If the picked target is not Shape3D or has pickOnBounds==true, it returns null. Returns:Point3D a new Point3D presenting the intersected normal Since JavaFX 8u40

getIntersectedNormal

back to summary

public final Point3D getIntersectedNormal()

Return the intersected normal of the picked 3d shape. If the picked target is not Shape3D or has pickOnBounds==true, it returns null.

Returns:Point3D: a new Point3D presenting the intersected normal
Since: JavaFX 8u40

getIntersectedPoint	back to summary
public final Point3D getIntersectedPoint() Returns the intersected point in local coordinate of the picked Node. If no node was picked, it returns the intersected point with the projection plane. Returns:Point3D new Point3D presenting the intersected point

getIntersectedPoint

back to summary

public final Point3D getIntersectedPoint()

Returns the intersected point in local coordinate of the picked Node. If no node was picked, it returns the intersected point with the projection plane.

Returns:Point3D: new Point3D presenting the intersected point

getIntersectedTexCoord	back to summary
public final Point2D getIntersectedTexCoord() Return the intersected texture coordinates of the picked 3d shape. If the picked target is not Shape3D or has pickOnBounds==true, it returns null. Returns:Point2D a new Point2D presenting the intersected TexCoord

getIntersectedTexCoord

back to summary

public final Point2D getIntersectedTexCoord()

Return the intersected texture coordinates of the picked 3d shape. If the picked target is not Shape3D or has pickOnBounds==true, it returns null.

Returns:Point2D: a new Point2D presenting the intersected TexCoord

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class PickResult

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail