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

Detailed Description

Contains a collection of KFbxLayer objects.

This class is used for managing layers construction, destruction and access. See KFbxLayerElement for more details.

See also:: KFbxLayer

Examples:: Layers/main.cxx.

Definition at line 61 of file kfbxlayercontainer.h.

#include <kfbxlayercontainer.h>

Inheritance diagram for KFbxLayerContainer:

[legend]

List of all members.

Public Member Functions
virtual EAttributeType	GetAttributeType () const
	Returns the type of node attribute.
bool	ConvertDirectToIndexToDirect (int pLayer)
	Converts the reference mode from eDIRECT to eINDEX_TO_DIRECT.
virtual KFbxObject &	Copy (const KFbxObject &pObject)
	Copy an object content into this object.
int	GTC (kUInt i, int j)
void *	GT (int i, kUInt l, int j)
int	AT (void *t, kUInt l, int j)
int	GTI (char const *n, kUInt l, int j)
int	GMC (kUInt i, void *n=NULL)
void *	GM (int i, kUInt l, void *n=NULL)
int	AM (void m, kUInt l, void n=NULL, bool b=false)
int	GMI (char const n, kUInt l, void d=NULL)
int	AddToLayerElementsList (KFbxLayerElement *pLEl)
void	RemoveFromLayerElementsList (KFbxLayerElement *pLEl)
Protected Member Functions
	KFbxLayerContainer (KFbxSdkManager &pManager, char const *pName)
virtual void	Destruct (bool pRecursive, bool pDependents)
void	CopyLayers (KFbxLayerContainer const *pLayerContainer)
virtual void	SetDocument (KFbxDocument *pDocument)
virtual bool	ConnecNotify (KFbxConnectEvent const &pEvent)
Protected Attributes
KArrayTemplate< KFbxLayer * >	mLayerArray
KArrayTemplate < KFbxLayerElement * >	mLayerElementsList
Friends
class	KFbxScene
class	KFbxGeometryConverter
Layer Management
int	CreateLayer ()
	Creates a new layer on top of existing layers.
void	ClearLayers ()
	Deletes all layers.
int	GetLayerCount () const
	Returns the number of layers.
int	GetLayerCount (KFbxLayerElement::ELayerElementType pType, bool pUVCount=false) const
	Returns the number of layers that contain the specified layer element type.
KFbxLayer *	GetLayer (int pIndex)
	Returns the layer at the specified index.
KFbxLayer const *	GetLayer (int pIndex) const
	Returns the layer at the specified index.
KFbxLayer *	GetLayer (int pIndex, KFbxLayerElement::ELayerElementType pType, bool pIsUV=false)
	Returns the n'th layer as specified by pIndex that contains the specified layer element type.
KFbxLayer const *	GetLayer (int pIndex, KFbxLayerElement::ELayerElementType pType, bool pIsUV=false) const
	Returns the n'th layer as specified by pIndex that contains the specified layer element type.
int	GetLayerIndex (int pIndex, KFbxLayerElement::ELayerElementType pType, bool pIsUV=false) const
	Returns the global index of the n'th layer as specified by pIndex that contains the specified layer element type.
int	GetLayerTypedIndex (int pGlobalIndex, KFbxLayerElement::ELayerElementType pType, bool pIsUV=false) const
	Converts the layer's global index to a type-specific index.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual EAttributeType GetAttributeType ( ) const [virtual]

Search for all occurrences

Returns the type of node attribute.

Reimplemented from KFbxNodeAttribute.

Reimplemented in KFbxGeometry, KFbxLine, KFbxMesh, KFbxNurb, KFbxNurbsCurve, KFbxNurbsSurface, KFbxPatch, KFbxShape, KFbxSubdiv, KFbxBoundary, and KFbxTrimNurbsSurface.

int CreateLayer ( )

Search for all occurrences

Creates a new layer on top of existing layers.

Returns:: Index of created layer or -1 if an error occurs.

Examples:: Instances/main.cxx.

void ClearLayers ( )

Search for all occurrences

Deletes all layers.

int GetLayerCount ( ) const

Search for all occurrences

Returns the number of layers.

Returns:: The number of layers.

int GetLayerCount	(	KFbxLayerElement::ELayerElementType	pType,
		bool	pUVCount = `false`
	)		const

Search for all occurrences

Returns the number of layers that contain the specified layer element type.

Parameters:

pType	The specified Layer Element type.
pUVCount	When `true`, requests the UV layer element corresponding to the specified texture type.

Returns:: The number of layers containing the specified layer element type.

KFbxLayer* GetLayer ( int pIndex )

Search for all occurrences

Returns the layer at the specified index.

Parameters:

pIndex Layer index.

Returns:: Pointer to the layer, or NULL if pIndex is out of range.

Examples:: Instances/main.cxx.

KFbxLayer const* GetLayer ( int pIndex ) const

Search for all occurrences

Returns the layer at the specified index.

Parameters:

pIndex Layer index.

Returns:: Pointer to the layer, or NULL if pIndex is out of range.

KFbxLayer* GetLayer	(	int	pIndex,
		KFbxLayerElement::ELayerElementType	pType,
		bool	pIsUV = `false`
	)

Search for all occurrences

Returns the n'th layer as specified by pIndex that contains the specified layer element type.

If the pType is KFbxLayerElement::eUV, this method will return the n'th layer as specified by pIndex that contains the diffuse UV. For example, GetLayer(int pIndex, KFbxLayerElement::eUV) is same as GetLayer(int pIndex, KFbxLayerElement::eDIFFUSE_TEXTURES, true).

Parameters:

pIndex	Layer index.
pType	The specified layer element type.
pIsUV	When `true`, requests the UV layer element that corresponds with the specified texture type.

Returns:: Pointer to the layer, or NULL if pIndex is out of range.

KFbxLayer const* GetLayer	(	int	pIndex,
		KFbxLayerElement::ELayerElementType	pType,
		bool	pIsUV = `false`
	)		const

Search for all occurrences

Returns the n'th layer as specified by pIndex that contains the specified layer element type.

If the pType is KFbxLayerElement::eUV, this method will return the n'th layer as specified by pIndex that contains the diffuse UV. For example, GetLayer(int pIndex, KFbxLayerElement::eUV) is same as GetLayer(int pIndex, KFbxLayerElement::eDIFFUSE_TEXTURES, true).

Parameters:

pIndex	Layer index.
pType	The specified layer element type.
pIsUV	When `true`, requests the UV layer element that corresponds with the specified texture type.

Returns:: Pointer to the layer, or NULL if pIndex is out of range.

int GetLayerIndex	(	int	pIndex,
		KFbxLayerElement::ELayerElementType	pType,
		bool	pIsUV = `false`
	)		const

Search for all occurrences

Returns the global index of the n'th layer as specified by pIndex that contains the specified layer element type.

Parameters:

pIndex	Layer index of the specified type.
pType	The specified layer element type.
pIsUV	When `true`, requests the UV layer element that corresponds with the specified texture type.

Returns:: Global index of the n'th layer as specified by pIndex that contains the specified layer element type, or -1 if the layer is not found.

Remarks:: The returned index is the position of the layer in the global array of layers. You can use the returned index to call GetLayer(int pIndex).

int GetLayerTypedIndex	(	int	pGlobalIndex,
		KFbxLayerElement::ELayerElementType	pType,
		bool	pIsUV = `false`
	)		const

Search for all occurrences

Converts the layer's global index to a type-specific index.

Parameters:

pGlobalIndex	The index of the layer in the global array of layers.
pType	The type upon which the type-specific index will be returned.
pIsUV	When `true`, requests the UV layer element that corresponds with the specified texture type.