FbxPatch Class Reference
This reference page is linked to from the following overview topics: Geometry, List of Python Fbx classes, FBX Node Attributes.
#include <fbxpatch.h>
A patch is a type of node attribute with parametric surface.
A patch object is useful for creating gently curved surfaces, and provides very detailed control for manipulating complex geometry.
Definition at line 26 of file fbxpatch.h.
Public Member Functions |
|
| virtual FbxNodeAttribute::EType | GetAttributeType () const |
| Returns the FbxNodeAttribute::EType::ePatch
node attribute type. |
|
| void | Reset () |
| Resets the patch to its default values.
|
|
Patch Properties |
|
| enum | EType
{ eBezier, eBezierQuadric, eCardinal, eBSpline, eLinear } |
| Patch types. More... |
|
| void | SetSurfaceMode (FbxGeometry::ESurfaceMode pMode) |
| Sets the surface mode. |
|
| FbxGeometry::ESurfaceMode | GetSurfaceMode () const |
| Returns the surface mode. |
|
| void | InitControlPoints (int pUCount, EType pUType, int pVCount, EType pVType) |
| Allocates memory space for the control
points array. |
|
| int | GetUCount () const |
| Returns the number of control points in the
U-dimension. |
|
| int | GetVCount () const |
| Returns the number of control points in the
V-dimension. |
|
| EType | GetPatchUType () const |
| Returns the U-dimension patch type. |
|
| EType | GetPatchVType () const |
| Returns the V-dimension patch type. |
|
| void | SetStep (int pUStep, int pVStep) |
| Sets the patch step. |
|
| int | GetUStep () const |
| Returns the number of divisions between
adjacent control points in the U-dimension. |
|
| int | GetVStep () const |
| Returns the number of divisions between
adjacent control points in the V-dimension. |
|
| void | SetClosed (bool pU, bool pV) |
| Sets closed flags. |
|
| bool | GetUClosed () const |
| Returns state of the U closed flag. |
|
| bool | GetVClosed () const |
| Returns state of the V closed flag. |
|
| void | SetUCapped (bool pUBottom, bool pUTop) |
| Sets U-capped flags. |
|
| bool | GetUCappedBottom () const |
| Returns state of the bottom U-capped flag.
|
|
| bool | GetUCappedTop () const |
| Returns state of the top U-capped flag.
|
|
| void | SetVCapped (bool pVBottom, bool pVTop) |
| Sets V-capped flags. |
|
| bool | GetVCappedBottom () const |
| Returns state of the bottom V-capped flag.
|
|
| bool | GetVCappedTop () const |
| Returns state of the top V-capped flag.
|
|
Off-loading Serialization section |
|
| virtual bool | ContentWriteTo (FbxStream &pStream) const |
| Writes the content of the patch to the given
stream. |
|
| virtual bool | ContentReadFrom (const FbxStream &pStream) |
| Reads the content of the patch from the
given stream. |
|
| enum EType |
Patch types.
Reimplemented from FbxNodeAttribute.
Definition at line 59 of file fbxpatch.h.
{
eBezier,
eBezierQuadric,
eCardinal,
eBSpline,
eLinear
};
| virtual FbxNodeAttribute::EType GetAttributeType | ( | ) | const [virtual] |
Returns the FbxNodeAttribute::EType::ePatch node attribute type.
Reimplemented from FbxGeometry.
| void Reset | ( | ) |
Resets the patch to its default values.
| void SetSurfaceMode | ( | FbxGeometry::ESurfaceMode | pMode | ) |
Sets the surface mode.
| pMode | Surface mode identifier (see Class FbxGeometry). |
| FbxGeometry::ESurfaceMode GetSurfaceMode | ( | ) | const [inline] |
Returns the surface mode.
Definition at line 50 of file fbxpatch.h.
{return mSurfaceMode;}
Allocates memory space for the control points array.
| pUCount | Number of U-dimension control points. |
| pUType | U-dimension patch type. |
| pVCount | Number of V-dimension control points. |
| pVType | V-dimension patch type. |
| int GetUCount | ( | ) | const [inline] |
Returns the number of control points in the U-dimension.
Definition at line 79 of file fbxpatch.h.
{return mUCount;}
| int GetVCount | ( | ) | const [inline] |
Returns the number of control points in the V-dimension.
Definition at line 84 of file fbxpatch.h.
{return mVCount;}
| EType GetPatchUType | ( | ) | const [inline] |
Returns the U-dimension patch type.
Definition at line 89 of file fbxpatch.h.
{return mUType;}
| EType GetPatchVType | ( | ) | const [inline] |
Returns the V-dimension patch type.
Definition at line 94 of file fbxpatch.h.
{return mVType;}
| void SetStep | ( | int | pUStep, |
| int | pVStep | ||
| ) |
Sets the patch step.
The step is the number of divisions between adjacent control points.
| pUStep | Steps in U-dimension. |
| pVStep | Steps in V-dimension. |
| int GetUStep | ( | ) | const [inline] |
Returns the number of divisions between adjacent control points in the U-dimension.
Definition at line 106 of file fbxpatch.h.
{return mUStep;}
| int GetVStep | ( | ) | const [inline] |
Returns the number of divisions between adjacent control points in the V-dimension.
Definition at line 111 of file fbxpatch.h.
{return mVStep;}
| void SetClosed | ( | bool | pU, |
| bool | pV | ||
| ) |
Sets closed flags.
| pU | Set to true if the patch is closed in U
dimension. |
| pV | Set to true if the patch is closed in V
dimension. |
| bool GetUClosed | ( | ) | const [inline] |
Returns state of the U closed flag.
True if the patch is closed in U dimension.Definition at line 122 of file fbxpatch.h.
{return mUClosed;}
| bool GetVClosed | ( | ) | const [inline] |
Returns state of the V closed flag.
True if the patch is closed in V dimension.Definition at line 127 of file fbxpatch.h.
{return mVClosed;}
| void SetUCapped | ( | bool | pUBottom, |
| bool | pUTop | ||
| ) |
Sets U-capped flags.
| pUBottom | Set to true if the patch is capped at the bottom
in the U-dimension. |
| pUTop | Set to true if the patch is capped on
the top in the U-dimension. |
| bool GetUCappedBottom | ( | ) | const [inline] |
Returns state of the bottom U-capped flag.
True if the patch is capped at the bottom in the
U-dimension.Definition at line 140 of file fbxpatch.h.
{return mUCappedBottom;}
| bool GetUCappedTop | ( | ) | const [inline] |
Returns state of the top U-capped flag.
True if the patch is capped on the top in the
U-dimension.Definition at line 145 of file fbxpatch.h.
{return mUCappedTop;}
| void SetVCapped | ( | bool | pVBottom, |
| bool | pVTop | ||
| ) |
Sets V-capped flags.
| pVBottom | Sets to true if the patch is capped at the bottom
in the V-dimension. |
| pVTop | Sets to true if the patch is capped on the top in
the V-dimension. |
| bool GetVCappedBottom | ( | ) | const [inline] |
Returns state of the bottom V-capped flag.
True if the patch is capped at the bottom.Definition at line 158 of file fbxpatch.h.
{return mVCappedBottom;}
| bool GetVCappedTop | ( | ) | const [inline] |
Returns state of the top V-capped flag.
True if the patch is capped on the top.Definition at line 163 of file fbxpatch.h.
{return mVCappedTop;}
| virtual bool ContentWriteTo | ( | FbxStream & | pStream | ) | const [virtual] |
Writes the content of the patch to the given stream.
| pStream | The destination stream. |
True if the content is successfully processed by
the receiving stream. If it is not successful, returns
false.Reimplemented from FbxGeometryBase.
| virtual bool ContentReadFrom | ( | const FbxStream & | pStream | ) | [virtual] |
Reads the content of the patch from the given stream.
| pStream | The source stream. |
True if the patch completes with the data received
from the stream successfully. If it is not successful, returns
false.Reimplemented from FbxGeometryBase.