FBMatrix Class Reference
 
 
 
FBMatrix Class Reference

This reference page is linked to from the following overview topics: Creating and Characterizing a Skeleton, Solving from the Goal to the Skeleton.


#include <mainpage.h>


Class Description

Four x Four (double) Matrix.

FBMatrix 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 16 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:
    mat = FBMatrix()
    len(mat)
    print mat[13]
    mat[12] = 1.0
Warning:
The implementation of this 4x4 matrix uses a simple list of 16 elements, not a list of 4 vectors of 4 elements.*
Slicing is not supported by this object.

Public Member Functions

def  __reduce__ ()
def  __init__ ()
def  Identity ()
def  Set ()
def  __len__ ()
def  __getitem__ ()
def  __setitem__ ()
def  __repr__ ()
def  __add__ ()
def  __sub__ ()
def  __iadd__ ()
def  __isub__ ()
def  __mul__ ()
def  __imul__ ()
def  __neg__ ()
def  GetBufferAddress ()
def  CopyFrom ()
def  NotEqual ()
def  IsEqual ()
def  Transpose ()
def  Inverse ()
def  InverseProduct ()
def  Validate ()

Member Function Documentation

def __reduce__ ( )
def __init__ ( )

Python Docstring:

__init__( (object)arg1) -> None

__init__( (object)arg1, (list)arg2) -> None

__init__( (object)arg1, (FBMatrix)arg2) -> None 

C++ Constructors:
The reference documentation for the following C++ symbols may contain additional relevant information.

 FBMatrix()
 FBMatrix(const double * pValue)
 FBMatrix(const FBMatrix & pMatrix)
def Identity ( )

Python Docstring:

Identity( (FBMatrix)arg1) -> None 

C++ Signature:

void Identity() 

Load identity matrix.

def Set ( )

Python Docstring:

Set( (FBMatrix)arg1, (list)arg2) -> None 

C++ Signature:

void Set(const double * pValue) 

Set matrix from an array.

Parameters:
pValue Array to intialize matrix from.
def __len__ ( )

Python Docstring:

__len__( (FBMatrix)arg1) -> int 
def __getitem__ ( )

Python Docstring:

__getitem__( (FBMatrix)arg1, (object)arg2) -> float 
def __setitem__ ( )

Python Docstring:

__setitem__( (FBMatrix)arg1, (object)arg2, (object)arg3) -> None 
def __repr__ ( )

Python Docstring:

__repr__( (FBMatrix)arg1) -> str 
def __add__ ( )

Python Docstring:

__add__( (FBMatrix)arg1, (FBMatrix)arg2) -> object 
def __sub__ ( )

Python Docstring:

__sub__( (FBMatrix)arg1, (FBMatrix)arg2) -> object 
def __iadd__ ( )

Python Docstring:

__iadd__( (object)arg1, (FBMatrix)arg2) -> object 
def __isub__ ( )

Python Docstring:

__isub__( (object)arg1, (FBMatrix)arg2) -> object 
def __mul__ ( )

Python Docstring:

__mul__( (FBMatrix)arg1, (FBMatrix)arg2) -> object

__mul__( (FBMatrix)arg1, (object)arg2) -> object 
def __imul__ ( )

Python Docstring:

__imul__( (object)arg1, (FBMatrix)arg2) -> object

__imul__( (object)arg1, (object)arg2) -> object 
def __neg__ ( )

Python Docstring:

__neg__( (FBMatrix)arg1) -> object 
def GetBufferAddress ( )

Python Docstring:

GetBufferAddress( (FBMatrix)arg1) -> int 
def CopyFrom ( )

Python Docstring:

CopyFrom( (FBMatrix)arg1, (FBMatrix)arg2) -> FBMatrix 
def NotEqual ( )

Python Docstring:

NotEqual( (FBMatrix)arg1, (FBMatrix)arg2) -> bool 
def IsEqual ( )

Python Docstring:

IsEqual( (FBMatrix)arg1, (FBMatrix)arg2) -> bool 
def Transpose ( )

Python Docstring:

Transpose( (FBMatrix)arg1) -> None 

C++ Signature:

FBMatrix & Transpose() 

Get Transposed matrix.

Returns:
the matrix Transposed.
def Inverse ( )

Python Docstring:

Inverse( (FBMatrix)arg1) -> None 

C++ Signature:

FBMatrix & Inverse() 

Get Inversed matrix.

Returns:
the matrix Inversed.
def InverseProduct ( )

Python Docstring:

InverseProduct( (FBMatrix)arg1, (FBMatrix)arg2) -> None 

C++ Signature:

const FBMatrix InverseProduct(const FBMatrix & pMatrix) 

InverseProduct Matrix.

Parameters:
pMatrix Matrix to Product.
Returns:
result matrix.
def Validate ( )

Python Docstring:

Validate( (FBMatrix)arg1) -> bool 

C++ Signature:

bool Validate() 

Validated matrix.

Returns:
true if matrix Validated.