FBX C++ API Reference
FbxDistance Class Reference

#include <fbxpropertytypes.h>

Class Description

FBX SDK distance class.

Examples:
ImportScene/DisplayLodGroup.cxx.

Definition at line 439 of file fbxpropertytypes.h.

Public Member Functions

FbxDistanceoperator= (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() [1/3]

Default constructor.

◆ FbxDistance() [2/3]

FbxDistance ( float  pValue,
FbxSystemUnit  pUnit 
)

Constructor with default values.

Parameters
pValueValue of distance using the measurement unit.
pUnitUnit of measurement.

◆ FbxDistance() [3/3]

FbxDistance ( float  pValue,
const char *  pUnit 
)

Constructor.

Parameters
pValueValue of distance using the measurement unit.
pUnitUnit of measurement.
Remarks
This constructor will convert string to FbxSystemUnit.

◆ ~FbxDistance()

Destructor.

Member Function Documentation

◆ operator=()

FbxDistance& operator= ( const FbxDistance pValue)

Assign operator.

Parameters
pValueThe distance to be assigned to this distance.
Returns
This distance.

◆ operator==()

bool operator== ( const FbxDistance pRHS) const

Equivalence operator.

Parameters
pRHSThe distance to be compared with this distance.
Returns
True, if the two distances are equal, false otherwise.

◆ operator!=()

bool operator!= ( const FbxDistance pRHS) const

Non-equivalence operator.

Parameters
pRHSThe distance to be compared with this distance.
Returns
True, if the two distances are unequal, false otherwise.

◆ unitName()

const FbxString unitName ( ) const

◆ unit()

const FbxSystemUnit unit ( ) const

Retrieve the measurement unit.

Returns
The measure unit of the distance.

◆ value()

const float value ( ) const

Retrieve the distance value.

Returns
The value of the distance in the defined measurement unit.
Examples:
ImportScene/DisplayLodGroup.cxx.

◆ internalValue()

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.

◆ valueAs()

const float valueAs ( const FbxSystemUnit pUnit) const

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

Parameters
pUnitThe 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: