FbxNurbsSurface 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 directions.

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

Definition at line 33 of file fbxnurbssurface.h.

#include <fbxnurbssurface.h>

Inheritance diagram for FbxNurbsSurface:

List of all members.

Public Types
enum	EErrorCode {   eNurbsTypeUnknown, eWrongNumberOfControlPoint, eWeightTooSmall, eUKnotVectorError,   eVKnotVectorError, eErrorCount }
Public Member Functions
virtual FbxNodeAttribute::EType	GetAttributeType () const
	Returns the FbxNodeAttribute::EType::eNurbsSurface node attribute type.
void	Reset ()
	Resets the NURBS surface its default values.
bool	IsRational () const
	Checks if the surface has all rational control points.
virtual FbxObject &	Copy (const FbxObject &pObject)
	Copy an object content into this object.
void	SetFlipNormals (bool pFlipNormals)
bool	GetFlipNormals () const
bool	IsValidKnots () const
Protected Member Functions
virtual void	Construct (const FbxNurbsSurface *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
ESurfaceMode	mSurfaceMode
bool	mApplyFlipUV
bool	mApplyFlipLinks
bool	mFlipNormals
Friends
class	FbxGeometryConverter
NURBS surface Properties
enum	EType { ePeriodic, eClosed, eOpen }
	NURBS 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.
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 surface 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.
void	AddCurveOnSurface (FbxNode *pCurve)
	Adds a curve to the NURBS surface.
FbxNode *	GetCurveOnSurface (int pIndex)
	Retrieves a curve from this surface.
FbxNode const *	GetCurveOnSurface (int pIndex) const
	Retrieves a curve from this surface.
int	GetCurveOnSurfaceCount () const
	Returns the number of curves on this surface.
bool	RemoveCurveOnSurface (FbxNode *pCurve)
	Removes a curve from this surface.

---

Member Enumeration Documentation

enum EType

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

Reimplemented from FbxNodeAttribute.

Definition at line 64 of file fbxnurbssurface.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
eUKnotVectorError	Search for all occurrences
eVKnotVectorError	Search for all occurrences
eErrorCount	Search for all occurrences

Definition at line 241 of file fbxnurbssurface.h.

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

---

Member Function Documentation

virtual FbxNodeAttribute::EType GetAttributeType

(

)

const [virtual]

Search for all occurrences

Returns the FbxNodeAttribute::EType::eNurbsSurface 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 57 of file fbxnurbssurface.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 FbxNurbsSurface::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 84 of file fbxnurbssurface.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 89 of file fbxnurbssurface.h.

{return mVCount;}

EType GetNurbsUType

(

)

const [inline]

Search for all occurrences

Returns the U-dimension NURBS type.

Returns:

NURBS type identifier.

Definition at line 94 of file fbxnurbssurface.h.

{return mUType;}

EType GetNurbsVType

(

)

const [inline]

Search for all occurrences

Returns the V-dimension NURBS type.

Returns:

NURBS type identifier.

Definition at line 99 of file fbxnurbssurface.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.

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 130 of file fbxnurbssurface.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 135 of file fbxnurbssurface.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 147 of file fbxnurbssurface.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 152 of file fbxnurbssurface.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 198 of file fbxnurbssurface.h.

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

void AddCurveOnSurface

(

FbxNode *

pCurve

)

Search for all occurrences

Adds a curve to the NURBS surface.

Adds a 2D, parametric space curve to this surface

Parameters:

pCurve

The curve to be added to the surface.

FbxNode* GetCurveOnSurface

(

int

pIndex

)

Search for all occurrences

Retrieves a curve from this surface.

Parameters:

pIndex

Index of the curve to retrieve (Valid range is 0 to GetCurveOnSurfaceCount() - 1).

Returns:

The curve at the specified index, or returns NULL if pIndex is out of range.

FbxNode const* GetCurveOnSurface

(

int

pIndex

)

const

Search for all occurrences

Retrieves a curve from this surface.

Parameters:

pIndex

Index of the curve to retrieve (Valid range is 0 to GetCurveOnSurfaceCount() - 1).

Returns:

The curve at the specified index, or returns NULL if pIndex is out of range.

int GetCurveOnSurfaceCount

(

)

const

Search for all occurrences

Returns the number of curves on this surface.

Returns:

The number of curves on this surface.

bool RemoveCurveOnSurface

(

FbxNode *

pCurve

)

Search for all occurrences

Removes a curve from this surface.

Parameters:

pCurve

The curve to be removed.

Returns:

True if the curve is removed successfully, if unsuccessful, returns false.

bool IsRational

(

)

const

Search for all occurrences

Checks if the surface has all rational control points.

Returns:

True if rational, false otherwise

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.

void SetFlipNormals

(

bool

pFlipNormals

)

Search for all occurrences

bool GetFlipNormals

(

)

const

Search for all occurrences

bool IsValidKnots

(

)

const

Search for all occurrences

virtual void Construct

(

const FbxNurbsSurface *

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 275 of file fbxnurbssurface.h.

---

Member Data Documentation

FbxUInt mUOrder [protected]

Search for all occurrences

Definition at line 261 of file fbxnurbssurface.h.

FbxUInt mVOrder [protected]

Search for all occurrences

Definition at line 261 of file fbxnurbssurface.h.

int mUCount [protected]

Search for all occurrences

Definition at line 262 of file fbxnurbssurface.h.

int mVCount [protected]

Search for all occurrences

Definition at line 262 of file fbxnurbssurface.h.

int mUStep [protected]

Search for all occurrences

Definition at line 263 of file fbxnurbssurface.h.

int mVStep [protected]

Search for all occurrences

Definition at line 263 of file fbxnurbssurface.h.

EType mUType [protected]

Search for all occurrences

Definition at line 264 of file fbxnurbssurface.h.

EType mVType [protected]

Search for all occurrences

Definition at line 264 of file fbxnurbssurface.h.

double* mUKnotVector [protected]

Search for all occurrences

Definition at line 266 of file fbxnurbssurface.h.

double* mVKnotVector [protected]

Search for all occurrences

Definition at line 267 of file fbxnurbssurface.h.

ESurfaceMode mSurfaceMode [protected]

Search for all occurrences

Definition at line 269 of file fbxnurbssurface.h.

bool mApplyFlipUV [protected]

Search for all occurrences

Definition at line 271 of file fbxnurbssurface.h.

bool mApplyFlipLinks [protected]

Search for all occurrences

Definition at line 272 of file fbxnurbssurface.h.

bool mFlipNormals [protected]

Search for all occurrences

Definition at line 273 of file fbxnurbssurface.h.

---

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

• fbxsdk/scene/geometry/fbxnurbssurface.h