KFbxPatch Class Reference

#include <kfbxpatch.h>

Inheritance diagram for KFbxPatch:

[legend]

List of all members.

---

Detailed Description

A patch is a type of parametric geometry node attribute.

Definition at line 54 of file kfbxpatch.h.

Patch Properties
enum	EPatchType
	Patch types. More...
void	SetSurfaceMode (KFbxGeometry::ESurfaceMode pMode)
	Set surface mode.
KFbxGeometry::ESurfaceMode	GetSurfaceMode () const
	Get surface mode.
void	InitControlPoints (int pUCount, EPatchType pUType, int pVCount, EPatchType pVType)
	Allocate memory space for the array of control points.
int	GetUCount () const
	Get number of control points in U direction.
int	GetVCount () const
	Get number of control points in V direction.
EPatchType	GetPatchUType () const
	Get patch type in U direction.
EPatchType	GetPatchVType () const
	Get patch type in V direction.
void	SetStep (int pUStep, int pVStep)
	Set step.
int	GetUStep () const
	Get the number of divisions between adjacent control points in U direction.
int	GetVStep () const
	Get the number of divisions between adjacent control points in V direction.
void	SetClosed (bool pU, bool pV)
	Set closed flags.
bool	GetUClosed () const
	Get state of the U closed flag.
bool	GetVClosed () const
	Get state of the V closed flag.
void	SetUCapped (bool pUBottom, bool pUTop)
	Set U capped flags.
bool	GetUCappedBottom () const
	Get U capped bottom flag state.
bool	GetUCappedTop () const
	Get U capped top flag state.
void	SetVCapped (bool pVBottom, bool pVTop)
	Set V capped flags.
bool	GetVCappedBottom () const
	Get V capped bottom flag state.
bool	GetVCappedTop () const
	Get V capped top flag state.
Off-loading Serialization section
virtual bool	ContentWriteTo (KFbxStream &pStream) const
	Writes the content of the object to the given stream.
virtual bool	ContentReadFrom (const KFbxStream &pStream)
	Reads the content of the object from the given stream.
Public Member Functions
virtual EAttributeType	GetAttributeType () const
	Return the type of node attribute which is EAttributeType::ePATCH.
void	Reset ()
	Reset the patch to default values.

---

Member Enumeration Documentation

enum EPatchType

Patch types.

• eBEZIER
• eBEZIER_QUADRIC
• eCARDINAL
• eBSPLINE
• eLINEAR

Definition at line 86 of file kfbxpatch.h.

---

Member Function Documentation

virtual EAttributeType GetAttributeType

(

)

const [virtual]

Return the type of node attribute which is EAttributeType::ePATCH.

Reimplemented from KFbxGeometry.

void Reset

(

)

Reset the patch to default values.

void SetSurfaceMode

(

KFbxGeometry::ESurfaceMode

pMode

)

Set surface mode.

Parameters:

pMode

Surface mode identifier (see Class KFbxGeometry)

KFbxGeometry::ESurfaceMode GetSurfaceMode

(

)

const [inline]

Get surface mode.

Returns:

Currently set surface mode identifier.

Definition at line 77 of file kfbxpatch.h.

void InitControlPoints	(	int	pUCount,
		EPatchType	pUType,
		int	pVCount,
		EPatchType	pVType
	)

Allocate memory space for the array of control points.

Parameters:

	pUCount	Number of control points in U direction.
	pUType	Patch type in U direction.
	pVCount	Number of control points in V direction.
	pVType	Patch type in V direction.

int GetUCount

(

)

const [inline]

Get number of control points in U direction.

Returns:

Number of control points in U.

Definition at line 106 of file kfbxpatch.h.

int GetVCount

(

)

const [inline]

Get number of control points in V direction.

Returns:

Number of control points in V.

Definition at line 111 of file kfbxpatch.h.

EPatchType GetPatchUType

(

)

const [inline]

Get patch type in U direction.

Returns:

Patch type identifier.

Definition at line 116 of file kfbxpatch.h.

EPatchType GetPatchVType

(

)

const [inline]

Get patch type in V direction.

Returns:

Patch type identifier.

Definition at line 121 of file kfbxpatch.h.

void SetStep	(	int	pUStep,
		int	pVStep
	)

Set step.

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

Parameters:

	pUStep	Steps in U direction.
	pVStep	Steps in V direction.

int GetUStep

(

)

const [inline]

Get the number of divisions between adjacent control points in U direction.

Returns:

Step value in U direction.

Definition at line 133 of file kfbxpatch.h.

int GetVStep

(

)

const [inline]

Get the number of divisions between adjacent control points in V direction.

Returns:

Step value in V direction.

Definition at line 138 of file kfbxpatch.h.

void SetClosed	(	bool	pU,
		bool	pV
	)

Set closed flags.

Parameters:

	pU	Set to true if the patch is closed in U direction.
	pV	Set to true if the patch is closed in V direction.

bool GetUClosed

(

)

const [inline]

Get state of the U closed flag.

Returns:

true if the patch is closed in U direction.

Definition at line 149 of file kfbxpatch.h.

bool GetVClosed

(

)

const [inline]

Get state of the V closed flag.

Returns:

true if the patch is closed in V direction.

Definition at line 154 of file kfbxpatch.h.

void SetUCapped	(	bool	pUBottom,
		bool	pUTop
	)

Set U capped flags.

Parameters:

	pUBottom	Set to true if the patch is capped at the bottom in the U direction.
	pUTop	Set to true if the patch is capped at the top in the U direction.

Remarks:

Capping options are saved but not loaded by Motionbuilder because they are computed from the patch topography.

bool GetUCappedBottom

(

)

const [inline]

Get U capped bottom flag state.

Returns:

true if the patch is capped at the bottom.

Definition at line 167 of file kfbxpatch.h.

bool GetUCappedTop

(

)

const [inline]

Get U capped top flag state.

Returns:

true if the patch is capped at the top.

Definition at line 172 of file kfbxpatch.h.

void SetVCapped	(	bool	pVBottom,
		bool	pVTop
	)

Set V capped flags.

Parameters:

	pVBottom	Set to true if the patch is capped at the bottom in the V direction.
	pVTop	Set to true if the patch is capped at the top in the V direction.

Remarks:

Capping options are saved but not loaded by Motionbuilder because they are computed from the patch topography.

bool GetVCappedBottom

(

)

const [inline]

Get V capped bottom flag state.

Returns:

true if the patch is capped at the bottom.

Definition at line 185 of file kfbxpatch.h.

bool GetVCappedTop

(

)

const [inline]

Get V capped top flag state.

Returns:

true if the patch is capped at the top.

Definition at line 190 of file kfbxpatch.h.

virtual bool ContentWriteTo

(

KFbxStream &

pStream

)

const [virtual]

Writes the content of the object to the given stream.

Parameters:

pStream

The destination stream.

Returns:

True if the content is successfully processed by the receiving stream, false otherwise.

Reimplemented from KFbxGeometryBase.

virtual bool ContentReadFrom

(

const KFbxStream &

pStream

)

[virtual]

Reads the content of the object from the given stream.

Parameters:

pStream

The source stream.

Returns:

True if the object fills itself with the received data from the stream successfully, false otherwise.

Reimplemented from KFbxGeometryBase.