Python Reference Guide
FBVector3d Class Reference

Vector3d class. More...

Public Member Functions

 FBVector3d ()
 Constructor. More...
 
 FBVector3d (FBVector3d pVector3d)
 Constructor. More...
 
 FBVector3d (float pX, float pY, float pZ)
 Constructor. More...
 
 FBVector3d (tuple< float, float, float >)
 Constructor. More...
 
int __len__ ()
 Returns the number of elements. More...
 
float __getitem__ (int pIndex)
 Returns the ith component Corresponds to python: print v[1]. More...
 
 __setitem__ (int pIndex, float pComponentValue)
 Sets the ith components Corresponds to python: v[1] = 0.5. More...
 
FBVector3d operator+ (FBVector3d pVector)
 Add 2 vectors. More...
 
FBVector3d operator- (FBVector3d pVector)
 Substract 2 vectors. More...
 

Detailed Description

Vector3d class.

This class creates a list like object, which can be modified using the list protocol method. But unlike lists, its length is fixed: it always contain 3 floating point values. Thus it does not support the any list methods that would affect its length. The values within can be changed, usually via the bracket operator.

# Supported list protocol methods:
color = FBColor()
len(color)
print color[0]
color[0] = 1.0
Warning
Slicing is not supported by this object.

Constructor & Destructor Documentation

◆ FBVector3d() [1/4]

Constructor.

Default constructor, all 3 values within are set to 0.0.

◆ FBVector3d() [2/4]

FBVector3d ( FBVector3d  pVector3d)

Constructor.

Copy constructor. Copy values from another instance.

◆ FBVector3d() [3/4]

FBVector3d ( float  pX,
float  pY,
float  pZ 
)

Constructor.

Explicitely construct a vector by specifying its values.

◆ FBVector3d() [4/4]

Constructor.

A vector can be built from any python object with supports the tuple interface and is of a lenght of 3.

Member Function Documentation

◆ __getitem__()

float __getitem__ ( int  pIndex)

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

Parameters
pIndexIndex of the components to get (0 to 2)
Returns
Color component value.

◆ __len__()

int __len__ ( )

Returns the number of elements.

Corresponds to python: len(object)

◆ __setitem__()

__setitem__ ( int  pIndex,
float  pComponentValue 
)

Sets the ith components Corresponds to python: v[1] = 0.5.

Parameters
pIndexIndex of the components to set (0 to 2)
pComponentValueValue of component to set

◆ operator+()

FBVector3d operator+ ( FBVector3d  pVector)

Add 2 vectors.

Parameters
pVectorVector to add to source.
Returns
The addition of both vectors.

◆ operator-()

FBVector3d operator- ( FBVector3d  pVector)

Substract 2 vectors.

Parameters
pVectorVector to add to source.
Returns
The substraction of both vectors.
FBColor
Color vector.
Definition: pyfbsdk_generated.h:4433