FbxDistance Class Reference

#include <fbxpropertytypes.h>

Class Description

FBX SDK distance class.

Examples:

Definition at line 439 of file fbxpropertytypes.h.

Public Member Functions
FbxDistance &	operator= (const FbxDistance &pValue)
	Assign operator. More...
const FbxString	unitName () const
const float	internalValue () const
	Get the value of distance when converting this measurement unit to inch. More...
const float	valueAs (const FbxSystemUnit &pUnit) const
	Get the value of distance when converting this measurement unit to the specified measurement unit. More...

Constructors and Destructor
	FbxDistance ()
	Default constructor. More...
	FbxDistance (float pValue, FbxSystemUnit pUnit)
	Constructor with default values. More...
	FbxDistance (float pValue, const char *pUnit)
	Constructor. More...
	~FbxDistance ()
	Destructor. More...

boolean operation
bool	operator== (const FbxDistance &pRHS) const
	Equivalence operator. More...
bool	operator!= (const FbxDistance &pRHS) const
	Non-equivalence operator. More...

Access
const FbxSystemUnit	unit () const
	Retrieve the measurement unit. More...
const float	value () const
	Retrieve the distance value. More...

Constructor & Destructor Documentation

FbxDistance

(

)

Default constructor.

FbxDistance	(	float	pValue,
		FbxSystemUnit	pUnit
	)

Constructor with default values.

Parameters

pValue	Value of distance using the measurement unit.
pUnit	Unit of measurement.

FbxDistance	(	float	pValue,
		const char *	pUnit
	)

Constructor.

Parameters

pValue	Value of distance using the measurement unit.
pUnit	Unit of measurement.

Remarks

This constructor will convert string to FbxSystemUnit.

~FbxDistance

(

)

Destructor.

Member Function Documentation

FbxDistance& operator=

(

const FbxDistance &

pValue

)

Assign operator.

Parameters

pValue

The distance to be assigned to this distance.

Returns

This distance.

bool operator==

(

const FbxDistance &

pRHS

)

const

Equivalence operator.

Parameters

pRHS	The distance to be compared with this distance.

Returns

True, if the two distances are equal, false otherwise.

bool operator!=

(

const FbxDistance &

pRHS

)

const

Non-equivalence operator.

Parameters

pRHS	The distance to be compared with this distance.

Returns

True, if the two distances are unequal, false otherwise.

const FbxString unitName

(

)

const

const FbxSystemUnit unit

(

)

const

Retrieve the measurement unit.

Returns

The measure unit of the distance.

const float value

(

)

const

Retrieve the distance value.

Returns

The value of the distance in the defined measurement unit.

Examples:

const float internalValue

(

)

const

Get the value of distance when converting this measurement unit to inch.

Returns

The value of distance when converting this measurement unit to inch.

const float valueAs

(

const FbxSystemUnit &

pUnit

)

const

Get the value of distance when converting this measurement unit to the specified measurement unit.

Parameters

pUnit

The measurement unit to be converted to.

Returns

The value of distance when using the specified measurement unit.

---

The documentation for this class was generated from the following file:

• fbxsdk/core/fbxpropertytypes.h