FBPickInfosList Class Reference

FBPickInfosList class. More...

#include <pyfbsdk.h>

Public Member Functions
	FBPickInfosList ()
	Constructor.
int	__len__ ()
	Returns the number of elements.
tuple< FBModel, FBVector3d >	__getitem__ (int pIndex)
	Returns the ith component Corresponds to python: print l[1].

Detailed Description

FBPickInfosList class.

This class implements a special sort of list that can only contains a pick info which is a tuple<FBModel, FBVector3d>. A pick info give the position (FBVector3d) and the model (FBModel) that was pick on screen.

To users FBPickInfosList behave like a typle, since it is not possible to add new objects in the list. Only methods or function that uses FBPickInfosList as argument can insert new objects. Users can query the content of the list with the bracket operator.

# Supported list protocol methods:
l = FBPickInfosList()
len(l)
 
# tuple unpacking of pick infos.
model, vector = l[0]

Constructor & Destructor Documentation

FBPickInfosList()

FBPickInfosList

(

)

Constructor.

Member Function Documentation

__getitem__()

tuple< FBModel, FBVector3d > __getitem__

(

int

pIndex

)

Returns the ith component Corresponds to python: print l[1].

Parameters

pIndex

Index of the components to get

Returns

PickInfos element value. A Pick info is a tuple<FBModel, FBVector3d>

__len__()

int __len__

(

)

Returns the number of elements.

Corresponds to python: len(object)