This reference page is linked to from the following overview topics: FBX SDK 2013, List of Python Fbx classes.

Detailed Description

This class is the base class for geometric object such as meshes, NURBS and patches.

Use the FbxGeometryBase class to manage the control points, normals, binormals and tangents of the geometries. The meaning of "control point" is dependent of the geometry object type. For meshes, the "control point" is the physical 3D coordinate of polygon vertices while, for NURBS, it is the the actual control point on the curves defining the surface. This class also allow you to define normals, binormals and tangents regardless of the type of geometric object. However, in reality, applying such definitions to NURBS and patches does not make much sense since these definitions would only exist at the control points and inbetween them, the interpolation would certainly not follow the curve.

Geometric objects are using a system of layered data to extend their construction definition. For example, a typical layer for a Mesh contains Normals, UVs and Materials but client applications can decide to define another set of Normals and UVs and swap them during the rendering phase to produce some different results. The combinations are limitless and it would be impossible to discuss them all. This example has been presented to show one possible context where layers can be used. More information can be found in the FbxLayerContainer and FbxLayer classes description.

Definition at line 41 of file fbxgeometrybase.h.

#include <fbxgeometrybase.h>

Inheritance diagram for FbxGeometryBase:

[legend]

List of all members.

Public Member Functions
virtual int	MemoryUsage () const
	Calculate the actual amount of memory used by this geometry object.
virtual FbxObject &	Copy (const FbxObject &pObject)
	Copy an object content into this object.
bool	GetNormals (FbxLayerElementArrayTemplate< FbxVector4 > **pLockableArray) const
bool	GetNormalsIndices (FbxLayerElementArrayTemplate< int > **pLockableArray) const
bool	GetTangents (FbxLayerElementArrayTemplate< FbxVector4 > **pLockableArray, const int pLayerIndex=0) const
bool	GetTangentsIndices (FbxLayerElementArrayTemplate< int > **pLockableArray, const int pLayerIndex=0) const
bool	GetBinormals (FbxLayerElementArrayTemplate< FbxVector4 > **pLockableArray, const int pLayerIndex=0) const
bool	GetBinormalsIndices (FbxLayerElementArrayTemplate< int > **pLockableArray, const int pLayerIndex=0) const
Public Attributes
FbxArray< FbxVector4 >	mControlPoints
Protected Member Functions
virtual void	ConstructProperties (bool pForceSet)
	Optional property constructor override, automatically called by default constructor.
virtual void	ContentClear ()
	Clears this object's content from memory.
Control Points, Normals, Binormals and Tangent Management.
virtual void	InitControlPoints (int pCount)
	Allocates memory space for the array of control points.
void	InitNormals (int pCount=0)
	Allocates memory space for the array of normals.
void	InitNormals (FbxGeometryBase *pSrc)
	Allocates memory space for the array of normals cloned from the pSrc.
void	InitTangents (int pCount=0, const int pLayerIndex=0, const char *pName="")
	Allocates memory space for the array of tangents on specified layer.
void	InitTangents (FbxGeometryBase *pSrc, const int pLayerIndex=0)
	Allocates memory space for the array of tangents cloned from the pSrc on the specified layer.
void	InitBinormals (int pCount=0, const int pLayerIndex=0, const char *pName="")
	Allocates memory space for the array of binormals.
void	InitBinormals (FbxGeometryBase *pSrc, const int pLayerIndex=0)
	Allocates memory space for the array of binormals cloned from the pSrc.
virtual void	SetControlPointAt (const FbxVector4 &pCtrlPoint, const FbxVector4 &pNormal, int pIndex, bool pI2DSearch=false)
	Sets the control point and the normal values at the specified index.
virtual void	SetControlPointAt (const FbxVector4 &pCtrlPoint, int pIndex)
	Sets the control point at a specified index.
virtual FbxVector4	GetControlPointAt (int pIndex) const
	Gets the control point at the specified index.
virtual void	SetControlPointNormalAt (const FbxVector4 &pNormal, int pIndex, bool pI2DSearch=false)
	Sets the control point normal value at the specified index.
virtual int	GetControlPointsCount () const
	Returns the number of control points.
virtual FbxVector4 *	GetControlPoints () const
	Returns a pointer to the array of control points.
virtual void	SetControlPointCount (int pCount)
	Allocates memory space for the array of control points.
Public and fast access Properties
FbxPropertyT< FbxBool >	PrimaryVisibility
	Control the geometry render state. Geometry can still cast shadows even if this is turned off.
FbxPropertyT< FbxBool >	CastShadow
	If true, the geometry will produce shadows.
FbxPropertyT< FbxBool >	ReceiveShadow
	If true, the geometry will receive shadows.
FbxPropertyT< FbxDouble3 >	BBoxMin
	The minimum value of the control points bounding box.
FbxPropertyT< FbxDouble3 >	BBoxMax
	The maximum value of the control points bounding box.
void	ComputeBBox ()
	Computes the control points Bounding box.
Geometry Element Management.
A FbxGeometryElement describes how the geometry element (normals, UVs and etc.) is mapped to a geometry surface and how the mapping information is arranged in memory.FbxGeometryElement is exactly the same as FbxLayerElement but does not expose the geometry's layer information. Use the geometry element classes to decompose the geometry without dealing with layers.
FbxGeometryElementNormal *	CreateElementNormal ()
	Creates a normal geometry element for this geometry.
bool	RemoveElementNormal (FbxGeometryElementNormal *pElementNormal)
	Remove the normal geometry element from this geometry.
FbxGeometryElementNormal *	GetElementNormal (int pIndex=0)
	Returns this geometry's normal element.
const FbxGeometryElementNormal *	GetElementNormal (int pIndex=0) const
	Returns this geometry's normal element.
int	GetElementNormalCount () const
	Get the number of this geometry's normal geometry element.
FbxGeometryElementBinormal *	CreateElementBinormal ()
	Creates a binormal geometry element for this geometry.
bool	RemoveElementBinormal (FbxGeometryElementBinormal *pElementBinormal)
	Remove the binormal geometry element from this geometry.
FbxGeometryElementBinormal *	GetElementBinormal (int pIndex=0)
	Returns this geometry's binormal element.
const FbxGeometryElementBinormal *	GetElementBinormal (int pIndex=0) const
	Returns this geometry's binormal element.
int	GetElementBinormalCount () const
	Get the number of this geometry's binormal geometry element.
FbxGeometryElementTangent *	CreateElementTangent ()
	Creates a tangent geometry element for this geometry.
bool	RemoveElementTangent (FbxGeometryElementTangent *pElementTangent)
	Remove the tangent geometry element from this geometry.
FbxGeometryElementTangent *	GetElementTangent (int pIndex=0)
	Returns this geometry's tangent element.
const FbxGeometryElementTangent *	GetElementTangent (int pIndex=0) const
	Returns this geometry's tangent element.
int	GetElementTangentCount () const
	Get the number of this geometry's tangent geometry element.
FbxGeometryElementMaterial *	CreateElementMaterial ()
	Creates a material geometry element for this geometry.
bool	RemoveElementMaterial (FbxGeometryElementMaterial *pElementMaterial)
	Remove the material geometry element from this geometry.
FbxGeometryElementMaterial *	GetElementMaterial (int pIndex=0)
	Returns this geometry's material element.
const FbxGeometryElementMaterial *	GetElementMaterial (int pIndex=0) const
	Returns this geometry's material element.
int	GetElementMaterialCount () const
	Get the number of this geometry's material geometry element.
FbxGeometryElementPolygonGroup *	CreateElementPolygonGroup ()
	Creates a polygon group geometry element for this geometry.
bool	RemoveElementPolygonGroup (FbxGeometryElementPolygonGroup *pElementPolygonGroup)
	Remove the polygon group geometry element from this geometry.
FbxGeometryElementPolygonGroup *	GetElementPolygonGroup (int pIndex=0)
	Returns this geometry's polygon group element.
const FbxGeometryElementPolygonGroup *	GetElementPolygonGroup (int pIndex=0) const
	Returns this geometry's polygon group element.
int	GetElementPolygonGroupCount () const
	Get the number of this geometry's polygon group geometry element.
FbxGeometryElementVertexColor *	CreateElementVertexColor ()
	Creates a vertex color geometry element for this geometry.
bool	RemoveElementVertexColor (FbxGeometryElementVertexColor *pElementVertexColor)
	Remove the vertex color geometry element from this geometry.
FbxGeometryElementVertexColor *	GetElementVertexColor (int pIndex=0)
	Returns this geometry's vertex color element.
const FbxGeometryElementVertexColor *	GetElementVertexColor (int pIndex=0) const
	Returns this geometry's vertex color element.
int	GetElementVertexColorCount () const
	Get the number of this geometry's vertex color geometry element.
FbxGeometryElementSmoothing *	CreateElementSmoothing ()
	Creates a smoothing geometry element for this geometry.
bool	RemoveElementSmoothing (FbxGeometryElementSmoothing *pElementSmoothing)
	Remove the smoothing geometry element from this geometry.
FbxGeometryElementSmoothing *	GetElementSmoothing (int pIndex=0)
	Returns this geometry's smoothing element.
const FbxGeometryElementSmoothing *	GetElementSmoothing (int pIndex=0) const
	Returns this geometry's smoothing element.
int	GetElementSmoothingCount () const
	Get the number of this geometry's smoothing geometry element.
FbxGeometryElementCrease *	CreateElementVertexCrease ()
	Creates a vertex crease geometry element for this geometry.
bool	RemoveElementVertexCrease (FbxGeometryElementCrease *pElementCrease)
	Remove the vertex crease geometry element from this geometry.
FbxGeometryElementCrease *	GetElementVertexCrease (int pIndex=0)
	Returns this geometry's vertex crease element.
const FbxGeometryElementCrease *	GetElementVertexCrease (int pIndex=0) const
	Returns this geometry's vertex crease element.
int	GetElementVertexCreaseCount () const
	Get the number of this geometry's vertex crease geometry element.
FbxGeometryElementCrease *	CreateElementEdgeCrease ()
	Creates an edge crease geometry element for this geometry.
bool	RemoveElementEdgeCrease (FbxGeometryElementCrease *pElementCrease)
	Remove the edge crease geometry element from this geometry.
FbxGeometryElementCrease *	GetElementEdgeCrease (int pIndex=0)
	Returns this geometry's edge crease element.
const FbxGeometryElementCrease *	GetElementEdgeCrease (int pIndex=0) const
	Returns this geometry's edge crease element.
int	GetElementEdgeCreaseCount () const
	Get the number of this geometry's edge crease geometry element.
FbxGeometryElementHole *	CreateElementHole ()
	Creates a hole geometry element for this geometry.
bool	RemoveElementHole (FbxGeometryElementHole *pElementHole)
	Remove the hole geometry element from this geometry.
FbxGeometryElementHole *	GetElementHole (int pIndex=0)
	Returns this geometry's hole element.
const FbxGeometryElementHole *	GetElementHole (int pIndex=0) const
	Returns this geometry's hole element.
int	GetElementHoleCount () const
	Get the number of this geometry's hole geometry element.
FbxGeometryElementUserData *	CreateElementUserData ()
	Creates a user data geometry element for this geometry.
bool	RemoveElementUserData (FbxGeometryElementUserData *pElementUserData)
	Remove the user data geometry element from this geometry.
FbxGeometryElementUserData *	GetElementUserData (int pIndex=0)
	Returns this geometry's user data element.
const FbxGeometryElementUserData *	GetElementUserData (int pIndex=0) const
	Returns this geometry's user data element.
int	GetElementUserDataCount () const
	Get the number of this geometry's user data geometry element.
FbxGeometryElementVisibility *	CreateElementVisibility ()
	Creates a visibility geometry element for this geometry.
bool	RemoveElementVisibility (FbxGeometryElementVisibility *pElementVisibility)
	Remove the visibility geometry element from this geometry.
FbxGeometryElementVisibility *	GetElementVisibility (int pIndex=0)
	Returns this geometry's visibility element.
const FbxGeometryElementVisibility *	GetElementVisibility (int pIndex=0) const
	Returns this geometry's visibility element.
int	GetElementVisibilityCount () const
	Get the number of this geometry's visibility geometry element.
FbxGeometryElementUV *	CreateElementUV (const char *pUVSetName)
	Creates a UV geometry element for this geometry.
bool	RemoveElementUV (FbxGeometryElementUV *pElementUV)
	Remove the UV geometry element from this geometry.
FbxGeometryElementUV *	GetElementUV (int pIndex=0)
	Returns this geometry's UV element.
const FbxGeometryElementUV *	GetElementUV (int pIndex=0) const
	Returns this geometry's UV element.
int	GetElementUVCount () const
	Get the number of this geometry's UV geometry element.
FbxGeometryElementUV *	GetElementUV (const char *pUVSetName)
	Returns this geometry's UV element.
const FbxGeometryElementUV *	GetElementUV (const char *pUVSetName) const
	Returns this geometry's UV element.
void	GetUVSetNames (FbxStringList &pUVSetNameList) const
	Returns this geometry's all UV set names.
Off-loading Serialization section
The methods in this section are typically called by a peripheral (FbxPeripheral).There should be no real interest in calling them directly. The functions will write/read the memory dump of the data contained in this class. Each data block written/read will start with an (int) value representing the number of items in the array. If this value (v) is not zero, it will be followed by the array content. A block of data that is (v * sizeof(array item size)) bytes big. The methods will also call the parent class ones to dump the Layers content.
virtual bool	ContentWriteTo (FbxStream &pStream) const
	Writes the content of the geometry object to the specified stream.
virtual bool	ContentReadFrom (const FbxStream &pStream)
	Reads the content of the geometry object from the specified stream.

Member Function Documentation

virtual void InitControlPoints ( int pCount ) [virtual]

void InitTangents	(	int	pCount = `0`,
		const int	pLayerIndex = `0`,
		const char *	pName = `""`
	)

pCount	The desired size of the tangent array. If pCount is specified, the array will be the same size as pCount. If pCount is not specified, the array will be the same length as the array of control points.
pLayerIndex	The specified layer index to allocate memory space for the array of tangents.
pName	The specified name for the allocated tangents array.

void InitTangents	(	FbxGeometryBase *	pSrc,
		const int	pLayerIndex = `0`
	)

pSrc	The source geometry from which the tangents information is cloned.
pLayerIndex	The specified layer index to allocate memory space for cloned array of tangents from the pSrc.

void InitBinormals	(	int	pCount = `0`,
		const int	pLayerIndex = `0`,
		const char *	pName = `""`
	)

pCount	The desired size of the binormal array. If pCount is specified, the array will have the same size as pCount. If pCount is not specified, the array will be the same length as the array of control points.
pLayerIndex	The specified layer index to allocate memory space for the array of binormals.
pName	The specified name for the allocated binormals array.

pSrc	The source geometry from which the binormals information is cloned.
pLayerIndex	The specified layer index to allocate memory space for cloned array of binormals from the pSrc.

virtual void SetControlPointAt	(	const FbxVector4 &	pCtrlPoint,
		const FbxVector4 &	pNormal,
		int	pIndex,
		bool	pI2DSearch = `false`
	)		`[virtual]`

pCtrlPoint	The value of the control point.
pNormal	The value of the normal.
pIndex	The specified index of the control point/normal.
pI2DSearch	When `true` AND the normals array reference mode is eIndexToDirect, search pNormal in the existing array to avoid inserting if it already exist. NOTE: This feature uses a linear search algorithm, therefore it can be time consuming if the DIRECT array of normals contains a huge number of elements.

virtual void SetControlPointNormalAt	(	const FbxVector4 &	pNormal,
		int	pIndex,
		bool	pI2DSearch = `false`
	)		`[virtual]`

bool GetTangents	(	FbxLayerElementArrayTemplate< FbxVector4 > **	pLockableArray,
		const int	pLayerIndex = `0`
	)		const

bool GetTangentsIndices	(	FbxLayerElementArrayTemplate< int > **	pLockableArray,
		const int	pLayerIndex = `0`
	)		const

bool GetBinormals	(	FbxLayerElementArrayTemplate< FbxVector4 > **	pLockableArray,
		const int	pLayerIndex = `0`
	)		const

bool GetBinormalsIndices	(	FbxLayerElementArrayTemplate< int > **	pLockableArray,
		const int	pLayerIndex = `0`
	)		const

FbxGeometryBase Class Reference

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Control Points, Normals, Binormals and Tangent Management.

Public and fast access Properties

Geometry Element Management.

Off-loading Serialization section

Member Function Documentation

Member Data Documentation