FBUV class. More...

#include <pyfbsdk.h>

Public Member Functions
	FBUV ()
	Default constructor.

	FBUV (FBUV pUV)
	Copy constructor.

	FBUV (float pU, float pV)
	Constructor from components.

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

	FBUV (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.

FBUV	__add__ (FBUV pUV)
	Addition operator with another UV.

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

FBUV	__sub__ (FBUV pUV)
	Subtraction operator with another UV.

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

FBUV	__mul__ (FBUV pUV)
	Multiplication operator with another UV (component-wise).

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

FBUV	__div__ (FBUV pUV)
	Division operator with another UV (component-wise).

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

FBUV	__iadd__ (FBUV pUV)
	In-place addition with another UV.

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

FBUV	__isub__ (FBUV pUV)
	In-place subtraction with another UV.

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

FBUV	__imul__ (FBUV pUV)
	In-place multiplication with another UV (component-wise).

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

FBUV	__idiv__ (FBUV pUV)
	In-place division with another UV (component-wise).

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

FBUV	__neg__ ()
	Unary negation operator.

FBUV	CopyFrom (FBUV pUV)
	Copy values from another UV.

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

bool	NotEqual (FBUV pUV)
	Compare for inequality.

bool	IsEqual (FBUV pUV)
	Compare for equality.

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

list	GetList ()
	Get the UV as a list.

Detailed Description

FBUV class.

Represents a UV texture coordinate as 2 float values. Value 0 is the U coordinate and value 1 is the V coordinate. Values are typically in the range of 0.0 to 1.0.

Warning: Slicing is not supported by this object.

Constructor & Destructor Documentation

◆ FBUV() [1/5]

FBUV ( )

Default constructor.

Initializes to (0, 0).

Referenced by __add__(), __add__(), __div__(), __div__(), __iadd__(), __iadd__(), __idiv__(), __idiv__(), __imul__(), __imul__(), __isub__(), __isub__(), __mul__(), __mul__(), __neg__(), __sub__(), __sub__(), CopyFrom(), CopyFrom(), FBUV(), IsEqual(), and NotEqual().

◆ FBUV() [2/5]

FBUV ( FBUV pUV )

Copy constructor.

Parameters

pUV	UV to copy.

References FBUV().

◆ FBUV() [3/5]

FBUV	(	float	pU,
		float	pV )

Constructor from components.

Parameters

pU	U coordinate.
pV	V coordinate.

◆ FBUV() [4/5]

FBUV ( object pObject )

Constructor from a Python object with indexing support.

Parameters

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

◆ FBUV() [5/5]

FBUV ( list pList )

Constructor from list.

Parameters

pList List of 2 float values.

Member Function Documentation

◆ add() [1/2]

FBUV __add__ ( FBUV pUV )

Addition operator with another UV.

Corresponds to python: uv1 + uv2

Parameters

pUV	UV to add.

Returns: A new FBUV with the result.

References FBUV().

◆ add() [2/2]

FBUV __add__ ( float pScalar )

Addition operator with a scalar.

Corresponds to python: uv + 2.0

Parameters

pScalar Scalar value to add to each component.

Returns: A new FBUV with the result.

References FBUV().

◆ div() [1/2]

FBUV __div__ ( FBUV pUV )

Division operator with another UV (component-wise).

Corresponds to python: uv1 / uv2

Parameters

pUV	UV to divide by.

Returns: A new FBUV with the result.

References FBUV().

◆ div() [2/2]

FBUV __div__ ( float pScalar )

Division operator with a scalar.

Corresponds to python: uv / 2.0

Parameters

pScalar Scalar value to divide each component by.

Returns: A new FBUV with the result.

References FBUV().

◆ getitem()

float __getitem__ ( int pIndex )

Returns the ith component.

Corresponds to python: print uv[1]

Parameters

pIndex Index of the component to get (0 or 1).

Returns: UV component value.

◆ iadd() [1/2]

FBUV __iadd__ ( FBUV pUV )

In-place addition with another UV.

Corresponds to python: uv1 += uv2

Parameters

pUV	UV to add.

Returns: Self.

References FBUV().

◆ iadd() [2/2]

FBUV __iadd__ ( float pScalar )

In-place addition with a scalar.

Corresponds to python: uv += 2.0

Parameters

pScalar Scalar value to add to each component.

Returns: Self.

References FBUV().

◆ idiv() [1/2]

FBUV __idiv__ ( FBUV pUV )

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

Corresponds to python: uv1 /= uv2

Parameters

pUV	UV to divide by.

Returns: Self.

References FBUV().

◆ idiv() [2/2]

FBUV __idiv__ ( float pScalar )

In-place division with a scalar.

Corresponds to python: uv /= 2.0

Parameters

pScalar Scalar value to divide each component by.

Returns: Self.

References FBUV().

◆ imul() [1/2]

FBUV __imul__ ( FBUV pUV )

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

Corresponds to python: uv1 *= uv2

Parameters

pUV	UV to multiply.

Returns: Self.

References FBUV().

◆ imul() [2/2]

FBUV __imul__ ( float pScalar )

In-place multiplication with a scalar.

Corresponds to python: uv *= 2.0

Parameters

pScalar Scalar value to multiply each component.

Returns: Self.

References FBUV().

◆ isub() [1/2]

FBUV __isub__ ( FBUV pUV )

In-place subtraction with another UV.

Corresponds to python: uv1 -= uv2

Parameters

pUV	UV to subtract.

Returns: Self.

References FBUV().

◆ isub() [2/2]

FBUV __isub__ ( float pScalar )

In-place subtraction with a scalar.

Corresponds to python: uv -= 2.0

Parameters

pScalar Scalar value to subtract from each component.

Returns: Self.

References FBUV().

◆ len()

int __len__ ( )

Returns the number of elements.

Corresponds to python: len(object)

Returns: Number of elements (2).

◆ mul() [1/2]

FBUV __mul__ ( FBUV pUV )

Multiplication operator with another UV (component-wise).

Corresponds to python: uv1 * uv2

Parameters

pUV	UV to multiply.

Returns: A new FBUV with the result.

References FBUV().

◆ mul() [2/2]

FBUV __mul__ ( float pScalar )

Multiplication operator with a scalar.

Corresponds to python: uv * 2.0

Parameters

pScalar Scalar value to multiply each component.

Returns: A new FBUV with the result.

References FBUV().

◆ neg()

FBUV __neg__ ( )

Unary negation operator.

Corresponds to python: -uv

Returns: A new FBUV with negated components.

References FBUV().

◆ repr()

str __repr__ ( )

Representation for debugging.

Corresponds to python: repr(uv)

Returns: String representation for debugging.

◆ setitem()

void __setitem__	(	int	pIndex,
		float	pValue )

Sets the ith component.

Corresponds to python: uv[1] = 0.5

Parameters

pIndex	Index of the component to set (0 or 1).
pValue	Value of the UV component.

◆ str()

str __str__ ( )

String representation.

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

Returns: String representation of the UV.

◆ sub() [1/2]

FBUV __sub__ ( FBUV pUV )

Subtraction operator with another UV.

Corresponds to python: uv1 - uv2

Parameters

pUV	UV to subtract.

Returns: A new FBUV with the result.

References FBUV().

◆ sub() [2/2]

FBUV __sub__ ( float pScalar )

Subtraction operator with a scalar.

Corresponds to python: uv - 2.0

Parameters

pScalar Scalar value to subtract from each component.

Returns: A new FBUV with the result.

References FBUV().

◆ CopyFrom() [1/2]

FBUV CopyFrom ( FBUV pUV )

Copy values from another UV.

Parameters

pUV	UV to copy from.

Returns: A new FBUV with copied values.

References FBUV().

◆ CopyFrom() [2/2]

FBUV CopyFrom ( list pList )

Copy values from a list.

Parameters

pList List of 2 float values.

Returns: A new FBUV with copied values.

References FBUV().

◆ GetBufferAddress()

int GetBufferAddress ( )

Get the buffer address for the UV data.

Returns: Buffer address as an integer.

◆ GetList()

list GetList ( )

Get the UV as a list.

Returns: List of 2 float values.

◆ IsEqual()

bool IsEqual ( FBUV pUV )

Compare for equality.

Parameters

pUV	UV to compare with.

Returns: True if UVs are equal.

References FBUV().

◆ NotEqual()

bool NotEqual ( FBUV pUV )

Compare for inequality.

Parameters

pUV	UV to compare with.

Returns: True if UVs are not equal.

References FBUV().

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FBUV() [1/5]

◆ FBUV() [2/5]

◆ FBUV() [3/5]

◆ FBUV() [4/5]

◆ FBUV() [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]

◆ GetBufferAddress()

◆ GetList()

◆ IsEqual()

◆ NotEqual()

◆ 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]