fbxDistance
#include<kfbxtypes.h>

List of all members.

Detailed Description

FBX SDK distance class.

Definition at line246of filekfbxtypes.h.


Constructors and Destructor

 fbxDistance()
 Default constructor.
 fbxDistance(float pValue,KFbxSystemUnitpUnit)
 Constructor with default values.
 fbxDistance(float pValue, const char *pUnit)
 Constructor.
 ~fbxDistance()
 Destructor.

Assignment operation

fbxDistanceoperator=(fbxDistanceconst&pValue)
 Assign operator.

boolean operation

bool operator==(fbxDistanceconst&pRHS) const
 Equivalence operator.
bool operator!=(fbxDistanceconst&pRHS) const
 Non-equivalence operator.

Access

KFbxSystemUnitconst unit() const
 Retrieve the measurement unit.
float const value() const
 Retrieve the value of distance using the measurement unit.

Public Member Functions

float const internalValue() const
 Get the value of distance when converting this measurement unit to inch.
float const valueAs(KFbxSystemUnitconst&pUnit) const
 Get the value of distance when converting this measurement unit to the specified measurement unit.

Constructor&Destructor Documentation

fbxDistance( ) [inline]

Default constructor.

Definition at line254of filekfbxtypes.h.

fbxDistance(float pValue,
KFbxSystemUnit pUnit 
)[inline]

Constructor with default values.

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

Definition at line260of filekfbxtypes.h.

fbxDistance(float pValue,
const char * pUnit 
)

Constructor.

Parameters:
pValue Value of distance using the measurement unit.
pUnit Unit of measurement.
Remarks:
This constructor will conver string toKFbxSystemUnit.

~fbxDistance( ) [inline]

Destructor.

Definition at line273of filekfbxtypes.h.

Member Function Documentation

fbxDistance&operator=(fbxDistanceconst& pValue ) [inline]

Assign operator.

Parameters:
pValue The distance to be assigned to this distance.
Returns:
This distance.

Definition at line287of filekfbxtypes.h.

ReferencesmUnit, andmValue.

bool operator==(fbxDistanceconst& pRHS ) const[inline]

Equivalence operator.

Parameters:
pRHS The distance to be compared with this distance.
Returns:
True, if the two distances are equal,falseotherwise.

Definition at line303of filekfbxtypes.h.

ReferencesmUnit, andmValue.

bool operator!=(fbxDistanceconst& pRHS ) const[inline]

Non-equivalence operator.

Parameters:
pRHS The distance to be compared with this distance.
Returns:
True, if the two distances are unequal,falseotherwise.

Definition at line309of filekfbxtypes.h.

KFbxSystemUnitconst unit( ) const[inline]

Retrieve the measurement unit.

Returns:
The measure unit of the distance.

Definition at line323of filekfbxtypes.h.

float const value( ) const[inline]

Retrieve the value of distance using the measurement unit.

Returns:
The value of distance using the measurement unit.

Definition at line328of filekfbxtypes.h.

float const internalValue( ) const[inline]

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

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

Definition at line334of filekfbxtypes.h.

float const valueAs(KFbxSystemUnitconst& pUnit ) const[inline]

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.

Definition at line344of filekfbxtypes.h.