KFbxPath
#include<kfbxpath.h>

List of all members.

Detailed Description

ClassKFbxPath.

Object describing the single path from the first parent, the root node, to a node. Methods to access parent nodes, compare paths together are provided.

With some 3D system (maya), node can be named with the same name, as long as they do not share the same path. In such a system, a path is a unique identifier for a node. Paths are useful to match nodes during a merge back process.

Definition at line70of filekfbxpath.h.


Public Member Functions

 KFbxPath()
 Base constructor.
 KFbxPath(KFbxPath&pPath)
 Copy constructor.
 KFbxPath(KFbxNode*pNode)
 Constructor.
 ~KFbxPath()
 Destructor.
KFbxNodeGetNode()
 Get the node on which the path leads.
KFbxNodeGetRootNode()
 Get the path's root node.
int GetParentCount() const
 GetParentCount.
char const * GetParentNodeName(int pIndex) const
 Retrieve parent node name.
KFbxNodeGetParentNode(int pIndex) const
 Get a parent node.
bool operator==(KFbxPath&pPath)
 Equivalence operator.
KFbxPathoperator=(KFbxPath&pPath)
 Assignment operator.
KFbxNodeoperator[](int pIndex)
 Array access operator.
void Set(KFbxNode*pNode)
 Construct path of aKFbxNodeobject.
void Set(KFbxPath&pPath)
 Copy a path.

Constructor&Destructor Documentation

KFbxPath( ) 

Base constructor.

KFbxPath(KFbxPathpPath ) 

Copy constructor.

Parameters:
pPath Path.

KFbxPath(KFbxNodepNode ) 

Constructor.

Parameters:
pNode Node.

~KFbxPath( ) 

Destructor.

Member Function Documentation

KFbxNode* GetNode( ) 

Get the node on which the path leads.

Returns:
the node on which the path leads

KFbxNode* GetRootNode( ) 

Get the path's root node.

Returns:
KFbxNodeobject.

int GetParentCount( ) const

GetParentCount.

Returns:
count of parent nodes.

char const* GetParentNodeName(int pIndex ) const

Retrieve parent node name.

Parameters:
pIndex Parent index. 0 is the root node, the last parent is the immediate node parent.
Returns:
name string.

KFbxNode* GetParentNode(int pIndex ) const

Get a parent node.

Parameters:
pIndex Parent index. 0 is the root node, the last parent is the immediate node parent.
Returns:
node found.

bool operator==(KFbxPathpPath ) 

Equivalence operator.

Parameters:
pPath Path.
Returns:
trueif pPath is equivalent to this path.

KFbxPath&operator=(KFbxPathpPath ) 

Assignment operator.

Parameters:
pPath Path
Returns:
thispath (which will now be equivalent to pPath).

KFbxNode* operator[](int pIndex ) 

Array access operator.

Parameters:
pIndex Index.
Returns:
node found.

void Set(KFbxNodepNode ) 

Construct path of aKFbxNodeobject.

Parameters:
pNode KFbxNodeObject used to build the path.

void Set(KFbxPathpPath ) 

Copy a path.

Parameters:
pPath Path to be copied