Picker

class pythreejs.Picker(controlling=None)[source]

Picker

Autogenerated by generate-wrappers.js This class is a custom class for pythreejs, with no direct corresponding class in three.js.

Inherits Controls.

Three.js docs: https://threejs.org/docs/#api/controls/Picker

event

The DOM MouseEvent type to trigger the pick

Unicode("click", allow_none=False).tag(sync=True)
all

Wether to send info on all object intersections beneath the picked point, or only the first one. See picked.

Bool(False, allow_none=False).tag(sync=True)
distance

The distance from the camera of the picked point (null if no object picked)

CFloat(None, allow_none=True).tag(sync=True)
point

The coordinates of the picked point (all zero if no object picked)

Vector3(default_value=[0, 0, 0]).tag(sync=True)
face

The vertex indices of the picked face (all zero if no face picked)

Vector3(default_value=[0, 0, 0]).tag(sync=True)
faceNormal

The normal vector of the picked face (all zero if no face picked)

Vector3(default_value=[0, 0, 0]).tag(sync=True)
faceVertices

The three vertices that make up the picked face, as vectors (empty if no face picked)

List(trait=List()).tag(sync=True)
faceIndex

The index of the face picked (null if no face picked)

CInt(None, allow_none=True).tag(sync=True)
modifiers

The keyboard modifiers held at the pick event in the following order: [SHIFT, CTRL, ALT, META]

List().tag(sync=True)
object

The picked object (null if no object picked)

Instance(Object3D, allow_none=True).tag(sync=True, **widget_serialization)
picked

The other fields on the picker will always be for the first object intersection. If all is set true, this field will be an array containing the same information for all intersections.

List().tag(sync=True)
uv

The UV coordinate picked (all zero if invalid pick)

Vector2(default_value=[0, 0]).tag(sync=True)
indices

The vertex indices of the picked face (empty if no face picked)

List().tag(sync=True)
all = Bool(False)

a boolean

distance = CFloat(None)

a float

event = Unicode('click')

a unicode string

face = Vector3((0, 0, 0))

a tuple of any type

faceIndex = CInt(None)

an int

faceNormal = Vector3((0, 0, 0))

a tuple of any type

faceVertices = List()

a list with values that are: a list

indices = List()

a list of any type

modifiers = List()

a list of any type

object = Instance()

an Object3D or None

picked = List()

a list of any type

point = Vector3((0, 0, 0))

a tuple of any type

uv = Vector2((0, 0))

a tuple of any type