Python Reference Guide
 
Loading...
Searching...
No Matches
FBNamespace Class Reference

Objects Containing class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBNamespace:

Public Member Functions

 FBNamespace (str pSingleLevelNamespace, FBNamespace pParentNSObj)
 Constructor.
 
FBComponent GetContent (int pIndex)
 Get the namespace content object count (Not Recursive).
 
int GetContentCount ()
 Get the namespace content objects count (Not Recursive).
 
 GetContentList (FBComponentList pContentList, FBPlugModificationFlag pModificationFlags=kFBPlugAllContent, bool pRecursive=True, int pTypeInfo=FBPlug::TypeInfo, bool pExactTypeMatch=False)
 Get List of the namespace content.
 
- Public Member Functions inherited from FBComponent
 FBComponent ()
 Constructor.
 
str ClassName ()
 Get the class name.
 
 DisableObjectFlags (FBObjectFlag pFlags)
 Disable a specific Object Flags.
 
 EnableObjectFlags (FBObjectFlag pFlags)
 Enable a specific Object Flags.
 
bool FBCreate ()
 Open Reality Creation function.
 
 FBDelete ()
 Open Reality deletion function.
 
 FBDestroy ()
 Open Reality destruction function.
 
FBObjectFlag GetObjectFlags ()
 Get all Object Flags (concatenated).
 
bool GetObjectStatus (FBObjectStatus pStatus)
 Check to see if an object status is enabled.
 
FBFileReference GetOwnerFileReference (p0)
 Get the owner FileReference object.
 
 HardSelect ()
 HardSelect.
 
bool HasObjectFlags (FBObjectFlag pFlags)
 Check whether a specific object flag is enabled.
 
bool Is (int pTypeId)
 Returns true if object is of type TypeId.
 
bool ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessNamespaceHierarchy.
 
bool ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessObjectNamespace.
 
int PropertyAdd (FBProperty pProperty)
 Add a property to the component's property manager.
 
bool PropertyAddReferenceProperty (FBProperty pReferenceProperty)
 Add a reference property to the component's property manager.
 
FBProperty PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
 Create user or dynamic property.
 
 PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
 Get list of properties which have been modified since last loading.
 
 PropertyRemove (FBProperty pProperty)
 Remove a Property from the component's Property manager.
 
 SetObjectFlags (FBObjectFlag pFlags)
 SetObjectFlags.
 
 SetObjectStatus (FBObjectStatus pStatus, bool pValue)
 Enable/Disable a specific Object Status.
 

Public Attributes

FBListNamespace ChildrenNamespaces
 List: Direct Children Namespace Objects.

 
bool ContentLocked
 Read Write Property: Content locking state.

 
- Public Attributes inherited from FBComponent
FBListComponent Components
 List: List of components.

 
str LongName
 Read Write Property: Name and namespace for object.

 
str Name
 Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
 
FBListComponent Parents
 List: Parents.

 
FBManager PropertyList
 Read Only Property: Manages all of the properties for the component.

 
bool Selected
 Read Write Property: Selected property.

 
int TypeInfo
 Contains the Type information of the object.

 
- Public Attributes inherited from FBPlug
str ClassGroupName
 ClassGroupName of the object.

 
int TypeInfo
 TypeInfo.

 

Detailed Description

Objects Containing class.


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

Constructor & Destructor Documentation

◆ FBNamespace()

FBNamespace ( str  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

◆ GetContent()

FBComponent GetContent ( int  pIndex)

Get the namespace content object count (Not Recursive).

Parameters
pIndexcontent object index to query. return content object inside this namespace (not recursive)

◆ GetContentCount()

int GetContentCount ( )

Get the namespace content objects count (Not Recursive).

return content objects count inside this namespace (not recursive)

◆ GetContentList()

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

◆ ChildrenNamespaces

FBListNamespace ChildrenNamespaces

List: Direct Children Namespace Objects.

◆ ContentLocked

bool ContentLocked

Read Write Property: Content locking state.