FBVertex class. More...

#include <pyfbsdk.h>

Public Member Functions
	FBVertex ()
	Default constructor.

	FBVertex (FBVertex pVertex)
	Copy constructor.

	FBVertex (float pX, float pY, float pZ, float pW)
	Constructor from components.

	FBVertex (object pObject)
	Constructor from a Python object with indexing support.

	FBVertex (list pList)
	Constructor from list.

int	__len__ ()
	Returns the number of elements.

float	__getitem__ (int pIndex)
	Returns the ith component.

void	__setitem__ (int pIndex, float pValue)
	Sets the ith component.

str	__repr__ ()
	Representation for debugging.

str	__str__ ()
	String representation.

FBVertex	__add__ (FBVertex pVertex)
	Addition operator with another vertex.

FBVertex	__add__ (float pScalar)
	Addition operator with a scalar.

FBVertex	__sub__ (FBVertex pVertex)
	Subtraction operator with another vertex.

FBVertex	__sub__ (float pScalar)
	Subtraction operator with a scalar.

FBVertex	__mul__ (FBVertex pVertex)
	Multiplication operator with another vertex (component-wise).

FBVertex	__mul__ (float pScalar)
	Multiplication operator with a scalar.

FBVertex	__div__ (FBVertex pVertex)
	Division operator with another vertex (component-wise).

FBVertex	__div__ (float pScalar)
	Division operator with a scalar.

FBVertex	__iadd__ (FBVertex pVertex)
	In-place addition with another vertex.

FBVertex	__iadd__ (float pScalar)
	In-place addition with a scalar.

FBVertex	__isub__ (FBVertex pVertex)
	In-place subtraction with another vertex.

FBVertex	__isub__ (float pScalar)
	In-place subtraction with a scalar.

FBVertex	__imul__ (FBVertex pVertex)
	In-place multiplication with another vertex (component-wise).

FBVertex	__imul__ (float pScalar)
	In-place multiplication with a scalar.

FBVertex	__idiv__ (FBVertex pVertex)
	In-place division with another vertex (component-wise).

FBVertex	__idiv__ (float pScalar)
	In-place division with a scalar.

FBVertex	__neg__ ()
	Unary negation operator.

FBVertex	CopyFrom (FBVertex pVertex)
	Copy values from another vertex.

FBVertex	CopyFrom (list pList)
	Copy values from a list.

bool	NotEqual (FBVertex pVertex)
	Compare for inequality.

bool	IsEqual (FBVertex pVertex)
	Compare for equality.

float	Length ()
	Get the length (magnitude) of the vertex vector.

float	SquareLength ()
	Get the squared length of the vertex vector.

float	Distance (FBVertex pVertex)
	Calculate the distance to another vertex.

FBVertex	Normalize ()
	Normalize the vector (make it unit length).

float	DotProduct (FBVertex pVertex)
	Calculate the dot product with another vertex.

FBVertex	CrossProduct (FBVertex pVertex)
	Calculate the cross product with another vertex.

int	GetBufferAddress ()
	Get the buffer address for the vertex data.

list	GetList ()
	Get the vertex as a list.

Detailed Description

FBVertex class.

A vertex represents a point in 3D space, stored as 4 float values (x, y, z, w). Similar in use to FBVector4d

# Supported list protocol methods:
v = FBVertex()
len(v)
print v[0]
v[0] = 1.0

Warning: Slicing is not supported by this object.

Constructor & Destructor Documentation

◆ FBVertex() [1/5]

FBVertex ( )

Default constructor.

Initializes to (0, 0, 0, 0).

Referenced by __add__(), __add__(), __div__(), __div__(), __iadd__(), __iadd__(), __idiv__(), __idiv__(), __imul__(), __imul__(), __isub__(), __isub__(), __mul__(), __mul__(), __neg__(), __sub__(), __sub__(), CopyFrom(), CopyFrom(), CrossProduct(), Distance(), DotProduct(), FBVertex(), IsEqual(), Normalize(), and NotEqual().

◆ FBVertex() [2/5]

FBVertex ( FBVertex pVertex )

Copy constructor.

Parameters

pVertex Vertex to copy.

References FBVertex().

◆ FBVertex() [3/5]

FBVertex	(	float	pX,
		float	pY,
		float	pZ,
		float	pW )

Constructor from components.

Parameters

pX	X component.
pY	Y component.
pZ	Z component.
pW	W component.

◆ FBVertex() [4/5]

FBVertex ( object pObject )

Constructor from a Python object with indexing support.

Parameters

pObject Object with len and indexing support containing 4 float values.

◆ FBVertex() [5/5]

FBVertex ( list pList )

Constructor from list.

Parameters

pList List of 4 float values.

Member Function Documentation

◆ add() [1/2]

FBVertex __add__ ( FBVertex pVertex )

Addition operator with another vertex.

Corresponds to python: v1 + v2

Parameters

pVertex Vertex to add.

Returns: A new FBVertex with the result.

References FBVertex().

◆ add() [2/2]

FBVertex __add__ ( float pScalar )

Addition operator with a scalar.

Corresponds to python: v + 2.0

Parameters

pScalar Scalar value to add to each component.

Returns: A new FBVertex with the result.

References FBVertex().

◆ div() [1/2]

FBVertex __div__ ( FBVertex pVertex )

Division operator with another vertex (component-wise).

Corresponds to python: v1 / v2

Parameters

pVertex Vertex to divide by.

Returns: A new FBVertex with the result.

References FBVertex().

◆ div() [2/2]

FBVertex __div__ ( float pScalar )

Division operator with a scalar.

Corresponds to python: v / 2.0

Parameters

pScalar Scalar value to divide each component by.

Returns: A new FBVertex with the result.

References FBVertex().

◆ getitem()

float __getitem__ ( int pIndex )

Returns the ith component.

Corresponds to python: print v[1]

Parameters

pIndex Index of the component to get (0 to 3).

Returns: Vertex component value.

◆ iadd() [1/2]

FBVertex __iadd__ ( FBVertex pVertex )

In-place addition with another vertex.

Corresponds to python: v1 += v2

Parameters

pVertex Vertex to add.

Returns: Self.

References FBVertex().

◆ iadd() [2/2]

FBVertex __iadd__ ( float pScalar )

In-place addition with a scalar.

Corresponds to python: v += 2.0

Parameters

pScalar Scalar value to add to each component.

Returns: Self.

References FBVertex().

◆ idiv() [1/2]

FBVertex __idiv__ ( FBVertex pVertex )

In-place division with another vertex (component-wise).

Corresponds to python: v1 /= v2

Parameters

pVertex Vertex to divide by.

Returns: Self.

References FBVertex().

◆ idiv() [2/2]

FBVertex __idiv__ ( float pScalar )

In-place division with a scalar.

Corresponds to python: v /= 2.0

Parameters

pScalar Scalar value to divide each component by.

Returns: Self.

References FBVertex().

◆ imul() [1/2]

FBVertex __imul__ ( FBVertex pVertex )

In-place multiplication with another vertex (component-wise).

Corresponds to python: v1 *= v2

Parameters

pVertex Vertex to multiply.

Returns: Self.

References FBVertex().

◆ imul() [2/2]

FBVertex __imul__ ( float pScalar )

In-place multiplication with a scalar.

Corresponds to python: v *= 2.0

Parameters

pScalar Scalar value to multiply each component.

Returns: Self.

References FBVertex().

◆ isub() [1/2]

FBVertex __isub__ ( FBVertex pVertex )

In-place subtraction with another vertex.

Corresponds to python: v1 -= v2

Parameters

pVertex Vertex to subtract.

Returns: Self.

References FBVertex().

◆ isub() [2/2]

FBVertex __isub__ ( float pScalar )

In-place subtraction with a scalar.

Corresponds to python: v -= 2.0

Parameters

pScalar Scalar value to subtract from each component.

Returns: Self.

References FBVertex().

◆ len()

int __len__ ( )

Returns the number of elements.

Corresponds to python: len(object)

Returns: Number of elements (4).

◆ mul() [1/2]

FBVertex __mul__ ( FBVertex pVertex )

Multiplication operator with another vertex (component-wise).

Corresponds to python: v1 * v2

Parameters

pVertex Vertex to multiply.

Returns: A new FBVertex with the result.

References FBVertex().

◆ mul() [2/2]

FBVertex __mul__ ( float pScalar )

Multiplication operator with a scalar.

Corresponds to python: v * 2.0

Parameters

pScalar Scalar value to multiply each component.

Returns: A new FBVertex with the result.

References FBVertex().

◆ neg()

FBVertex __neg__ ( )

Unary negation operator.

Corresponds to python: -v

Returns: A new FBVertex with negated components.

References FBVertex().

◆ repr()

str __repr__ ( )

Representation for debugging.

Corresponds to python: repr(v)

Returns: String representation for debugging.

◆ setitem()

void __setitem__	(	int	pIndex,
		float	pValue )

Sets the ith component.

Corresponds to python: v[1] = 0.5

Parameters

pIndex	Index of the component to set (0 to 3).
pValue	Value of the vertex component.

◆ str()

str __str__ ( )

String representation.

Corresponds to python: str(v) or print(v)

Returns: String representation of the vertex.

◆ sub() [1/2]

FBVertex __sub__ ( FBVertex pVertex )

Subtraction operator with another vertex.

Corresponds to python: v1 - v2

Parameters

pVertex Vertex to subtract.

Returns: A new FBVertex with the result.

References FBVertex().

◆ sub() [2/2]

FBVertex __sub__ ( float pScalar )

Subtraction operator with a scalar.

Corresponds to python: v - 2.0

Parameters

pScalar Scalar value to subtract from each component.

Returns: A new FBVertex with the result.

References FBVertex().

◆ CopyFrom() [1/2]

FBVertex CopyFrom ( FBVertex pVertex )

Copy values from another vertex.

Parameters

pVertex Vertex to copy from.

Returns: A new FBVertex with copied values.

References FBVertex().

◆ CopyFrom() [2/2]

FBVertex CopyFrom ( list pList )

Copy values from a list.

Parameters

pList List of 4 float values.

Returns: A new FBVertex with copied values.

References FBVertex().

◆ CrossProduct()

FBVertex CrossProduct ( FBVertex pVertex )

Calculate the cross product with another vertex.

Parameters

pVertex Vertex to calculate cross product with.

Returns: A new FBVertex representing the cross product.

References FBVertex().

◆ Distance()

float Distance ( FBVertex pVertex )

Calculate the distance to another vertex.

Parameters

pVertex Vertex to calculate distance to.

Returns: The distance between the two vertices.

References FBVertex().

◆ DotProduct()

float DotProduct ( FBVertex pVertex )

Calculate the dot product with another vertex.

Parameters

pVertex Vertex to calculate dot product with.

Returns: The dot product value.

References FBVertex().

◆ GetBufferAddress()

int GetBufferAddress ( )

Get the buffer address for the vertex data.

Returns: Buffer address as an integer.

◆ GetList()

list GetList ( )

Get the vertex as a list.

Returns: List of 4 float values.

◆ IsEqual()

bool IsEqual ( FBVertex pVertex )

Compare for equality.

Parameters

pVertex Vertex to compare with.

Returns: True if vertices are equal.

References FBVertex().

◆ Length()

float Length ( )

Get the length (magnitude) of the vertex vector.

Returns: The length of the vertex vector.

◆ Normalize()

FBVertex Normalize ( )

Normalize the vector (make it unit length).

Returns: A new normalized FBVertex.

References FBVertex().

◆ NotEqual()

bool NotEqual ( FBVertex pVertex )

Compare for inequality.

Parameters

pVertex Vertex to compare with.

Returns: True if vertices are not equal.

References FBVertex().

◆ SquareLength()

float SquareLength ( )

Get the squared length of the vertex vector.

More efficient than Length() when only comparing magnitudes.

Returns: The squared length of the vertex vector.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FBVertex() [1/5]

◆ FBVertex() [2/5]

◆ FBVertex() [3/5]

◆ FBVertex() [4/5]

◆ FBVertex() [5/5]

Member Function Documentation

◆ __add__() [1/2]

◆ __add__() [2/2]

◆ __div__() [1/2]

◆ __div__() [2/2]

◆ __getitem__()

◆ __iadd__() [1/2]

◆ __iadd__() [2/2]

◆ __idiv__() [1/2]

◆ __idiv__() [2/2]

◆ __imul__() [1/2]

◆ __imul__() [2/2]

◆ __isub__() [1/2]

◆ __isub__() [2/2]

◆ __len__()

◆ __mul__() [1/2]

◆ __mul__() [2/2]

◆ __neg__()

◆ __repr__()

◆ __setitem__()

◆ __str__()

◆ __sub__() [1/2]

◆ __sub__() [2/2]

◆ CopyFrom() [1/2]

◆ CopyFrom() [2/2]

◆ CrossProduct()

◆ Distance()

◆ DotProduct()

◆ GetBufferAddress()

◆ GetList()

◆ IsEqual()

◆ Length()

◆ Normalize()

◆ NotEqual()

◆ SquareLength()

◆ add() [1/2]

◆ add() [2/2]

◆ div() [1/2]

◆ div() [2/2]

◆ getitem()

◆ iadd() [1/2]

◆ iadd() [2/2]

◆ idiv() [1/2]

◆ idiv() [2/2]

◆ imul() [1/2]

◆ imul() [2/2]

◆ isub() [1/2]

◆ isub() [2/2]

◆ len()

◆ mul() [1/2]

◆ mul() [2/2]

◆ neg()

◆ repr()

◆ setitem()

◆ str()

◆ sub() [1/2]

◆ sub() [2/2]