- Main Page
- Classes
- Files
- Directories

- Class List
- Class Hierarchy
- Class Members

Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends

# FbxNurbs Class Reference

This reference page is linked to from the following overview topics: Supported Scene Elements, FBX Node Attributes, List of Python Fbx classes.

Search for all occurrences

## Detailed Description

A NURBS surface is a type of parametric geometry.

A NURBS surface is defined by the order, form, knot vector and control points in the U and V coordinates.

For more information on the meaning of form, knot vectors and control points, see the FbxNurbsCurve documentation. The same rules apply for the NURBS curves and NURBS surfaces, but NURBS surfaces have two dimensions (U and V).

Definition at line 31 of file fbxnurbs.h.

`#include <fbxnurbs.h>`

Inheritance diagram for FbxNurbs:
[legend]

List of all members.

## Public Types
enum | EErrorCode { eNurbsTypeUnknown, eWrongNumberOfControlPoint, eWeightTooSmall, eUMultiplicityVectorError, eVMultiplicityVectorError, eUKnotVectorError, eVKnotVectorError, eErrorCount }
## Public Member Functions
virtual FbxNodeAttribute::EType | GetAttributeType () const
| Returns the FbxNodeAttribute::EType::eNurbs node attribute type.
void | Reset ()
| Resets the NURBS surface its default values.
virtual FbxObject & | Copy (const FbxObject &pObject)
| Copy an object content into this object.
## Protected Member Functions
virtual void | Construct (const FbxNurbs *pFrom)
virtual void | Destruct (bool pRecursive)
| Optional destructor override, automatically called by default destructor.
## Protected Attributes
FbxUInt | mUOrder
FbxUInt | mVOrder
int | mUCount
int | mVCount
int | mUStep
int | mVStep
EType | mUType
EType | mVType
double * | mUKnotVector
double * | mVKnotVector
int * | mUMultiplicityVector
int * | mVMultiplicityVector
ESurfaceMode | mSurfaceMode
bool | mApplyFlipUV
bool | mApplyFlipLinks
## Friends
class | FbxGeometryConverter
## NURBS surface Properties
enum | EType { ePeriodic, eClosed, eOpen }
| Node attribute types. More...
void | SetSurfaceMode (FbxGeometry::ESurfaceMode pMode)
| Sets the surface mode.
ESurfaceMode | GetSurfaceMode () const
| Returns the surface mode.
void | InitControlPoints (int pUCount, EType pUType, int pVCount, EType pVType)
| Allocates memory space for an array of control points as well as knot and multiplicity vectors.
int | GetUCount () const
| Returns the number of U-dimension control points.
int | GetVCount () const
| Returns the number of V-dimension control points.
EType | GetNurbsUType () const
| Returns the U-dimension NURBS type.
EType | GetNurbsVType () const
| Returns the V-dimension NURBS type.
int | GetUKnotCount () const
| Returns the number of elements in the U-dimension knot vector.
double * | GetUKnotVector () const
| Returns the U-dimension knot vector.
int | GetVKnotCount () const
| Returns the number of elements in the V-dimension knot vector.
double * | GetVKnotVector () const
| Returns the V-dimension knot vector.
int * | GetUMultiplicityVector () const
| Returns multiplicity of U-dimension control points.
int * | GetVMultiplicityVector () const
| Returns multiplicity of V-dimension control points.
void | SetOrder (FbxUInt pUOrder, FbxUInt pVOrder)
| Sets the order of the NURBS surface.
int | GetUOrder () const
| Returns the NURBS order in U dimension.
int | GetVOrder () const
| Returns the NURBS order in V dimension.
void | SetStep (int pUStep, int pVStep)
| Sets the NURBS step.
int | GetUStep () const
| Returns the number of divisions between adjacent control points in U dimension.
int | GetVStep () const
| Returns the number of divisions between adjacent control points in V dimension.
int | GetUSpanCount () const
| Calculates the number of surface spans in the U dimension.
int | GetVSpanCount () const
| Calculates the number of surface spans in the V dimension.
## NURBS Export Flags
void | SetApplyFlipUV (bool pFlag)
| Sets the flag that induces UV flipping at export.
bool | GetApplyFlipUV () const
| Returns the flag that induces UV flipping at export.
void | SetApplyFlipLinks (bool pFlag)
| Sets the flag that induces link flipping at export.
bool | GetApplyFlipLinks () const
| Returns the flag that induces link flipping at export.
bool | GetApplyFlip () const
| Returns flip flags state.

## Member Enumeration Documentation

enum EType

Search for all occurrences

Node attribute types.

- eUnknown
- eNull
- eMarker
- eSkeleton
- eMesh
- eNurbs
- ePatch
- eCamera
- eCameraStereo,
- eCameraSwitcher
- eLight
- eOpticalReference
- eOpticalMarker
- eNurbsCurve
- eTrimNurbsSurface
- eBoundary
- eNurbsSurface
- eShape
- eLODGroup
- eSubDiv
- eCachedEffect
- eLine

Enumerator:

  ePeriodic | Search for all occurrences
  eClosed | Search for all occurrences
  eOpen | Search for all occurrences

Reimplemented from FbxNodeAttribute.

Definition at line 62 of file fbxnurbs.h.

        {
            ePeriodic,
            eClosed,
            eOpen
        };

enum EErrorCode

Search for all occurrences

Enumerator:

  eNurbsTypeUnknown | Search for all occurrences
  eWrongNumberOfControlPoint | Search for all occurrences
  eWeightTooSmall | Search for all occurrences
  eUMultiplicityVectorError | Search for all occurrences
  eVMultiplicityVectorError | Search for all occurrences
  eUKnotVectorError | Search for all occurrences
  eVKnotVectorError | Search for all occurrences
  eErrorCount | Search for all occurrences

Definition at line 219 of file fbxnurbs.h.

        {
            eNurbsTypeUnknown,
            eWrongNumberOfControlPoint,
            eWeightTooSmall,
            eUMultiplicityVectorError,
            eVMultiplicityVectorError,
            eUKnotVectorError,
            eVKnotVectorError,
            eErrorCount
        };

## Member Function Documentation

virtual FbxNodeAttribute::EType GetAttributeType | ( |  | ) | const`[virtual]`

Search for all occurrences

Returns the FbxNodeAttribute::EType::eNurbs node attribute type.

Reimplemented from FbxGeometry.

void Reset | ( |  | ) |

Search for all occurrences

Resets the NURBS surface its default values.

void SetSurfaceMode | ( | FbxGeometry::ESurfaceMode | pMode | ) |

Search for all occurrences

Sets the surface mode.

Parameters:

  pMode | Surface mode identifier (see class FbxGeometry)

ESurfaceMode GetSurfaceMode | ( |  | ) | const`[inline]`

Search for all occurrences

Returns the surface mode.

Returns:
  The surface mode identifier that is currently set.

Definition at line 55 of file fbxnurbs.h.

    {return mSurfaceMode;}

void InitControlPoints | ( | int | pUCount,
|  | EType | pUType,
|  | int | pVCount,
|  | EType | pVType
| ) |  |

Search for all occurrences

Allocates memory space for an array of control points as well as knot and multiplicity vectors.

Parameters:

  pUCount | Number of U-dimension control points.
  pUType | U-dimension NURBS type.
  pVCount | Number of V-dimension control points.
  pVType | V-dimension NURBS type.

Remarks:
  Always call this function after FbxNurbs::SetOrder().

int GetUCount | ( |  | ) | const`[inline]`

Search for all occurrences

Returns the number of U-dimension control points.

Returns:
  Number of U-dimension control points.

Definition at line 82 of file fbxnurbs.h.

    {return mUCount;}

int GetVCount | ( |  | ) | const`[inline]`

Search for all occurrences

Returns the number of V-dimension control points.

Returns:
  Number of V-dimension control points.

Definition at line 87 of file fbxnurbs.h.

    {return mVCount;}

EType GetNurbsUType | ( |  | ) | const`[inline]`

Search for all occurrences

Returns the U-dimension NURBS type.

Returns:
  NURBS type identifier.

Definition at line 92 of file fbxnurbs.h.

    {return mUType;}

EType GetNurbsVType | ( |  | ) | const`[inline]`

Search for all occurrences

Returns the V-dimension NURBS type.

Returns:
  NURBS type identifier.

Definition at line 97 of file fbxnurbs.h.

    {return mVType;}

int GetUKnotCount | ( |  | ) | const

Search for all occurrences

Returns the number of elements in the U-dimension knot vector.

See FbxNurbsCurve for more information.

Returns:
  The number of elements in the U-dimension knot vector.

double* GetUKnotVector | ( |  | ) | const

Search for all occurrences

Returns the U-dimension knot vector.

Returns:
  Pointer to the U-dimension knot vector.

int GetVKnotCount | ( |  | ) | const

Search for all occurrences

Returns the number of elements in the V-dimension knot vector.

See FbxNurbsCurve for more information.

Returns:
  The number of elements in the V-dimension knot vector.

double* GetVKnotVector | ( |  | ) | const

Search for all occurrences

Returns the V-dimension knot vector.

Returns:
  Pointer to the V-dimension knot vector.

int* GetUMultiplicityVector | ( |  | ) | const

Search for all occurrences

Returns multiplicity of U-dimension control points.

Returns:
  Pointer to the array of multiplicity values.

Remarks:
  The length of this vector is equal to the U count. Its elements are set to 1 by default.

int* GetVMultiplicityVector | ( |  | ) | const

Search for all occurrences

Returns multiplicity of V-dimension control points.

Returns:
  Pointer to the array of multiplicity values.

Remarks:
  The length of this vector is equal to the V count. Its elements are set to 1 by default.

void SetOrder | ( | FbxUInt | pUOrder,
|  | FbxUInt | pVOrder
| ) |  |

Search for all occurrences

Sets the order of the NURBS surface.

Parameters:

  pUOrder | NURBS order in U dimension.
  pVOrder | NURBS order in V dimension.

int GetUOrder | ( |  | ) | const`[inline]`

Search for all occurrences

Returns the NURBS order in U dimension.

Returns:
  NURBS order in U dimension.

Definition at line 142 of file fbxnurbs.h.

    {return mUOrder;}

int GetVOrder | ( |  | ) | const`[inline]`

Search for all occurrences

Returns the NURBS order in V dimension.

Returns:
  NURBS order in V dimension.

Definition at line 147 of file fbxnurbs.h.

    {return mVOrder;}

void SetStep | ( | int | pUStep,
|  | int | pVStep
| ) |  |

Search for all occurrences

Sets the NURBS step.

The step value is the number of divisions between adjacent control points.

Parameters:

  pUStep | Steps in U dimension.
  pVStep | Steps in V dimension.

int GetUStep | ( |  | ) | const`[inline]`

Search for all occurrences

Returns the number of divisions between adjacent control points in U dimension.

Returns:
  Steps in U dimension.

Definition at line 159 of file fbxnurbs.h.

    {return mUStep;}

int GetVStep | ( |  | ) | const`[inline]`

Search for all occurrences

Returns the number of divisions between adjacent control points in V dimension.

Returns:
  Steps in V dimension.

Definition at line 164 of file fbxnurbs.h.

    {return mVStep;}

int GetUSpanCount | ( |  | ) | const

Search for all occurrences

Calculates the number of surface spans in the U dimension.

See FbxNurbsCurve::GetSpanCount() for more information.

Returns:
  The number of spans in the U dimension if the surface has been initialized. If the spans have not been initialized, returns -1.

int GetVSpanCount | ( |  | ) | const

Search for all occurrences

Calculates the number of surface spans in the V dimension.

See FbxNurbsCurve::GetSpanCount() for more information.

Returns:
  The number of spans in the V dimension if the surface has been initialized. If the spans have not been initialized, returns -1.

void SetApplyFlipUV | ( | bool | pFlag | ) |

Search for all occurrences

Sets the flag that induces UV flipping at export.

Parameters:

  pFlag | If `true`, UV flipping occurs.

bool GetApplyFlipUV | ( |  | ) | const

Search for all occurrences

Returns the flag that induces UV flipping at export.

Returns:
  The current state of the UV flip flag.

void SetApplyFlipLinks | ( | bool | pFlag | ) |

Search for all occurrences

Sets the flag that induces link flipping at export.

Parameters:

  pFlag | If `true`, the links control points indices are flipped.

bool GetApplyFlipLinks | ( |  | ) | const

Search for all occurrences

Returns the flag that induces link flipping at export.

Returns:
  The current state of the link flip flag.

bool GetApplyFlip | ( |  | ) | const`[inline]`

Search for all occurrences

Returns flip flags state.

Returns:
  `True` if we need to flip either the UV or the links.

Definition at line 210 of file fbxnurbs.h.

    { return GetApplyFlipUV() || GetApplyFlipLinks(); }

virtual FbxObject& Copy | ( | const FbxObject & | pObject | ) | `[virtual]`

Search for all occurrences

Copy an object content into this object.

Parameters:

  pObject | The source object to copy data from.

Returns:
  Returns the destination object being modified by the source.

Remarks:
  This function replace the assignment operator (operator=). It will copy all property values and the name. Connections are NOT copied.

Reimplemented from FbxGeometry.

virtual void Construct | ( | const FbxNurbs * | pFrom | ) | `[protected, virtual]`

Search for all occurrences

virtual void Destruct | ( | bool | pRecursive | ) | `[protected, virtual]`

Search for all occurrences

Optional destructor override, automatically called by default destructor.

Parameters:

  pRecursive | If true, children objects should be destroyed as well.

Remarks:
  In case it is decided to override this function, do not forget to call ParentClass::Destruct(pResursive) at the end.

Reimplemented from FbxGeometry.

## Friends And Related Function Documentation

friend class FbxGeometryConverter`[friend]`

Search for all occurrences

Definition at line 254 of file fbxnurbs.h.

## Member Data Documentation

FbxUInt mUOrder`[protected]`

Search for all occurrences

Definition at line 237 of file fbxnurbs.h.

FbxUInt mVOrder`[protected]`

Search for all occurrences

Definition at line 237 of file fbxnurbs.h.

int mUCount`[protected]`

Search for all occurrences

Definition at line 238 of file fbxnurbs.h.

int mVCount`[protected]`

Search for all occurrences

Definition at line 238 of file fbxnurbs.h.

int mUStep`[protected]`

Search for all occurrences

Definition at line 239 of file fbxnurbs.h.

int mVStep`[protected]`

Search for all occurrences

Definition at line 239 of file fbxnurbs.h.

EType mUType`[protected]`

Search for all occurrences

Definition at line 240 of file fbxnurbs.h.

EType mVType`[protected]`

Search for all occurrences

Definition at line 240 of file fbxnurbs.h.

double* mUKnotVector`[protected]`

Search for all occurrences

Definition at line 242 of file fbxnurbs.h.

double* mVKnotVector`[protected]`

Search for all occurrences

Definition at line 243 of file fbxnurbs.h.

int* mUMultiplicityVector`[protected]`

Search for all occurrences

Definition at line 245 of file fbxnurbs.h.

int* mVMultiplicityVector`[protected]`

Search for all occurrences

Definition at line 246 of file fbxnurbs.h.

ESurfaceMode mSurfaceMode`[protected]`

Search for all occurrences

Definition at line 248 of file fbxnurbs.h.

bool mApplyFlipUV`[protected]`

Search for all occurrences

Definition at line 251 of file fbxnurbs.h.

bool mApplyFlipLinks`[protected]`

Search for all occurrences

Definition at line 252 of file fbxnurbs.h.

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

- fbxsdk/scene/geometry/fbxnurbs.h

FbxNurbs FbxNurbs FbxNurbs FbxNurbs FbxNurbs FbxNurbs FbxNurbs FbxNurbs FbxNurbs FbxNurbs
FbxNurbs FbxNurbs FbxNurbs FbxNurbs FbxNurbs FbxNurbs FbxNurbs FbxNurbs FbxNurbs FbxNurbs