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

Detailed Description

A NURBS surface is a type of parametric geometry.

A NURBS surface is defined by the degree, 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 KFbxNurbsCurve documentation. The same rules apply for the NURBS curves and NURBS surfaces, but NURBS surfaces have two dimensions (U and V).

Examples:: ExportScene02/main.cxx, and ImportScene/DisplayNurb.cxx.

Definition at line 60 of file kfbxnurb.h.

#include <kfbxnurb.h>

Inheritance diagram for KFbxNurb:

[legend]

List of all members.

Public Types
enum	EError { eNurbTypeUnknown, eWrongNumberOfControlPoint, eWeightTooSmall, eUMultiplicityVectorError, eVMultiplicityVectorError, eUKnotVectorError, eVKnotVectorError, eErrorCount }
	Error identifiers. More...
Public Member Functions
virtual EAttributeType	GetAttributeType () const
	Returns the EAttributeType::eNURB node attribute type.
void	Reset ()
	Resets the NURBS surface its default values.
virtual KFbxObject &	Copy (const KFbxObject &pObject)
	Copy an object content into this object.
Protected Member Functions
	KFbxNurb (KFbxSdkManager &pManager, char const *pName)
virtual void	Destruct (bool pRecursive, bool pDependents)
Protected Attributes
kUInt	mUOrder
kUInt	mVOrder
int	mUCount
int	mVCount
int	mUStep
int	mVStep
ENurbType	mUType
ENurbType	mVType
double *	mUKnotVector
double *	mVKnotVector
int *	mUMultiplicityVector
int *	mVMultiplicityVector
ESurfaceMode	mSurfaceMode
bool	mApplyFlipUV
bool	mApplyFlipLinks
Friends
class	KFbxGeometryConverter
NURBS surface Properties
enum	ENurbType { ePERIODIC, eCLOSED, eOPEN }
	NURBS types. More...
void	SetSurfaceMode (KFbxGeometry::ESurfaceMode pMode)
	Sets the surface mode.
ESurfaceMode	GetSurfaceMode () const
	Returns the surface mode.
void	InitControlPoints (int pUCount, ENurbType pUType, int pVCount, ENurbType 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.
ENurbType	GetNurbUType () const
	Returns the U-dimension NURBS type.
ENurbType	GetNurbVType () 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 (kUInt pUOrder, kUInt 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 ENurbType

Search for all occurrences

NURBS types.

ePERIODIC
eCLOSED
eOPEN

Enumerator:

ePERIODIC	Search for all occurrences
eCLOSED	Search for all occurrences
eOPEN	Search for all occurrences

Definition at line 90 of file kfbxnurb.h.

    {
        ePERIODIC,
        eCLOSED,
        eOPEN
    } ENurbType;

enum EError

Search for all occurrences

Error identifiers.

Enumerator:

eNurbTypeUnknown	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

Reimplemented from KFbxGeometry.

Definition at line 279 of file kfbxnurb.h.

    {
        eNurbTypeUnknown,
        eWrongNumberOfControlPoint,
        eWeightTooSmall,
        eUMultiplicityVectorError,
        eVMultiplicityVectorError,
        eUKnotVectorError,
        eVKnotVectorError,
        eErrorCount
    } EError;

Constructor & Destructor Documentation

KFbxNurb	(	KFbxSdkManager &	pManager,
		char const *	pName
	)		`[protected]`

Member Function Documentation

virtual EAttributeType GetAttributeType ( ) const [virtual]

Search for all occurrences

Returns the EAttributeType::eNURB node attribute type.

Reimplemented from KFbxGeometry.

void Reset ( )

Search for all occurrences

Resets the NURBS surface its default values.

void SetSurfaceMode ( KFbxGeometry::ESurfaceMode pMode )

Search for all occurrences

Sets the surface mode.

Parameters:

pMode Surface mode identifier (see class KfbxGeometry)

ESurfaceMode GetSurfaceMode ( ) const [inline]

Search for all occurrences

Returns the surface mode.

Returns:: The surface mode identifier that is currently set.

Examples:: ImportScene/DisplayNurb.cxx.

Definition at line 83 of file kfbxnurb.h.

{return mSurfaceMode;}

void InitControlPoints	(	int	pUCount,
		ENurbType	pUType,
		int	pVCount,
		ENurbType	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 KFbxNurb::SetOrder().

Examples:: ExportScene02/main.cxx.

int GetUCount ( ) const [inline]

Search for all occurrences

Returns the number of U-dimension control points.

Returns:: Number of U-dimension control points.

Examples:: ImportScene/DisplayNurb.cxx.

Definition at line 110 of file kfbxnurb.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.

Examples:: ImportScene/DisplayNurb.cxx.

Definition at line 115 of file kfbxnurb.h.

{return mVCount;}

ENurbType GetNurbUType ( ) const [inline]

Search for all occurrences

Returns the U-dimension NURBS type.

Returns:: NURBS type identifier.

Examples:: ImportScene/DisplayNurb.cxx.

Definition at line 120 of file kfbxnurb.h.

{return mUType;}

ENurbType GetNurbVType ( ) const [inline]

Search for all occurrences

Returns the V-dimension NURBS type.

Returns:: NURBS type identifier.

Examples:: ImportScene/DisplayNurb.cxx.

Definition at line 125 of file kfbxnurb.h.

{return mVType;}

int GetUKnotCount ( ) const

Search for all occurrences

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

See KFbxNurbsCurve for more information.

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

Examples:: ExportScene02/main.cxx, and ImportScene/DisplayNurb.cxx.

double* GetUKnotVector ( ) const

Search for all occurrences

Returns the U-dimension knot vector.

Returns:: Pointer to the U-dimension knot vector.

Examples:: ExportScene02/main.cxx, and ImportScene/DisplayNurb.cxx.

int GetVKnotCount ( ) const

Search for all occurrences

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

See KFbxNurbsCurve for more information.

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

Examples:: ExportScene02/main.cxx, and ImportScene/DisplayNurb.cxx.

double* GetVKnotVector ( ) const

Search for all occurrences

Returns the V-dimension knot vector.

Returns:: Pointer to the V-dimension knot vector.

Examples:: ExportScene02/main.cxx, and ImportScene/DisplayNurb.cxx.

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.

Examples:: ImportScene/DisplayNurb.cxx.

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.

Examples:: ImportScene/DisplayNurb.cxx.

void SetOrder	(	kUInt	pUOrder,
		kUInt	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.

Examples:: ExportScene02/main.cxx.

int GetUOrder ( ) const [inline]

Search for all occurrences

Returns the NURBS order in U dimension.

Returns:: NURBS order in U dimension.

Examples:: ImportScene/DisplayNurb.cxx.

Definition at line 170 of file kfbxnurb.h.

{return mUOrder;}

int GetVOrder ( ) const [inline]

Search for all occurrences

Returns the NURBS order in V dimension.

Returns:: NURBS order in V dimension.

Examples:: ImportScene/DisplayNurb.cxx.

Definition at line 175 of file kfbxnurb.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.

Examples:: ExportScene02/main.cxx.

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.

Examples:: ImportScene/DisplayNurb.cxx.

Definition at line 187 of file kfbxnurb.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.

Examples:: ImportScene/DisplayNurb.cxx.

Definition at line 192 of file kfbxnurb.h.

{return mVStep;}

int GetUSpanCount ( ) const

Search for all occurrences

Calculates the number of surface spans in the U dimension.

See KFbxNurbsCurve::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 KFbxNurbsCurve::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 238 of file kfbxnurb.h.

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

virtual KFbxObject& Copy ( const KFbxObject & 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 KFbxGeometry.

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

Search for all occurrences

Reimplemented from KFbxGeometry.

Friends And Related Function Documentation

friend class KFbxGeometryConverter [friend]

Search for all occurrences

Reimplemented from KFbxGeometryBase.

Definition at line 292 of file kfbxnurb.h.

Member Data Documentation

kUInt mUOrder [protected]

Search for all occurrences

Definition at line 260 of file kfbxnurb.h.

kUInt mVOrder [protected]

Search for all occurrences

Definition at line 260 of file kfbxnurb.h.

int mUCount [protected]

Search for all occurrences

Definition at line 261 of file kfbxnurb.h.

int mVCount [protected]

Search for all occurrences

Definition at line 261 of file kfbxnurb.h.

int mUStep [protected]

Search for all occurrences

Definition at line 262 of file kfbxnurb.h.

int mVStep [protected]

Search for all occurrences

Definition at line 262 of file kfbxnurb.h.

ENurbType mUType [protected]

Search for all occurrences

Definition at line 263 of file kfbxnurb.h.

ENurbType mVType [protected]

Search for all occurrences

Definition at line 263 of file kfbxnurb.h.

double* mUKnotVector [protected]

Search for all occurrences

Definition at line 265 of file kfbxnurb.h.

double* mVKnotVector [protected]

Search for all occurrences

Definition at line 266 of file kfbxnurb.h.

int* mUMultiplicityVector [protected]

Search for all occurrences

Definition at line 268 of file kfbxnurb.h.

int* mVMultiplicityVector [protected]

Search for all occurrences

Definition at line 269 of file kfbxnurb.h.

ESurfaceMode mSurfaceMode [protected]

Search for all occurrences

Definition at line 271 of file kfbxnurb.h.

bool mApplyFlipUV [protected]

Search for all occurrences

Definition at line 274 of file kfbxnurb.h.

bool mApplyFlipLinks [protected]

Search for all occurrences

Definition at line 275 of file kfbxnurb.h.

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

fbxfilesdk/kfbxplugins/kfbxnurb.h

KFbxNurb Class Reference

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

NURBS surface Properties

NURBS Export Flags

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation