Public Member Functions | Public Attributes | Protected Member Functions

FBNamespace Class Reference

This reference page is linked to from the following overview topics: MotionBuilder 2013.


Search for all occurrences

Detailed Description

Objects Containing class.

This class is an interface to manipulate object's containing in the scene.

Definition at line 79 of file fbnamespace.h.

#include <fbnamespace.h>

Inheritance diagram for FBNamespace:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBNamespace (const char *pSingleLevelNamespace, FBNamespace *pParentNSObj)
 Constructor.
int GetContentCount () const
 Get the namespace content objects count (Not Recursive).
FBComponentGetContent (int pIndex) const
 Get the namespace content object count (Not Recursive).
void GetContentList (FBComponentList &pContentList, FBPlugModificationFlag pModificationFlags=kFBPlugAllContent, bool pRecursive=true, int pTypeInfo=FBPlug::TypeInfo, bool pExactTypeMatch=false)
 Get List of the namespace content.

Public Attributes

FBPropertyListNamespace ChildrenNamespaces
 List: Direct Children Namespace Objects.

Protected Member Functions

 FBNamespace (const char *pMultiLevelNamespace, HIObject pObject)
 Constructor.

Constructor & Destructor Documentation

FBNamespace ( const char *  pMultiLevelNamespace,
HIObject  pObject 
) [protected]

Constructor.

For Internal use only.

Parameters:
pMultiLevelNamespaceFBNamespace name. This name will be used as namespace itself. it should follow such pattern "NS1[:NS2[:NS3]]]", where content inside [] is optional.
pObjectFor internal use only.
FBNamespace ( const char *  pSingleLevelNamespace,
FBNamespace pParentNSObj 
)

Constructor.

Create a new direct children namespace object

Parameters:
pSingleLevelNamespaceFBNamespace name. This name will be used as namespace itself. this name string shouldn't contain namespace string separator ":".
pParentNSObjthe parent namespace object. if NULl means to create top level namespace.

Member Function Documentation

int GetContentCount ( ) const

Get the namespace content objects count (Not Recursive).

return content objects count inside this namespace (not recursive)

FBComponent* GetContent ( int  pIndex) const

Get the namespace content object count (Not Recursive).

Parameters:
pIndexcontent object index to query. return content object inside this namespace (not recursive)
void GetContentList ( FBComponentList pContentList,
FBPlugModificationFlag  pModificationFlags = kFBPlugAllContent,
bool  pRecursive = true,
int  pTypeInfo = FBPlug::TypeInfo,
bool  pExactTypeMatch = false 
)

Get List of the namespace content.

Parameters:
pContentListthe list of content to return.
pModificationFlagsbitwise combination of kFBConnectionSrcObjectModified, kFBConnectionDstObjectModified, kFBConnectionSrcPropertyModified, kFBConnectionDstPropertyModified flags. kFBAllContent means all the content.
pRecursiveTrue only work on the direct children level namespace, otherwise will work on the whole children namespace hierarchy recursively.
pTypeInfothe typeInfo of the type of interested object, 0 for all the objects.
pExactTypeMatchif True, the derived typeInfo won't be considered (For example, FBCamera won't be considered when passing FBModel::TypeInfo).

Member Data Documentation

List: Direct Children Namespace Objects.

Definition at line 124 of file fbnamespace.h.


The documentation for this class was generated from the following file:

FBNamespace FBNamespace FBNamespace FBNamespace FBNamespace FBNamespace FBNamespace FBNamespace FBNamespace FBNamespace
FBNamespace FBNamespace FBNamespace FBNamespace FBNamespace FBNamespace FBNamespace FBNamespace FBNamespace FBNamespace