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

Module Manager class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBModuleManager:

Public Member Functions

FBStringList GetLoadedModuleNames ()
 Returns the loaded module names found in the *.mod files parsed.
 
str GetModuleModFilePath (str pModuleName)
 Returns the *.mod file path containing the definition of the provided loaded module name.
 
str GetModulePath (str pModuleName)
 Returns the module path associated with the provided loaded module name.
 
FBStringList GetModuleSearchPaths ()
 Returns the module search paths where *.mod files can be parsed.
 
str GetModuleVersion (str pModuleName)
 Returns the module version associated with the provided loaded module name.
 
- 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.
 

Additional Inherited Members

- 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

Module Manager class.


This class is introduced to enable users to access information related to the loaded modules.

Member Function Documentation

◆ GetLoadedModuleNames()

FBStringList GetLoadedModuleNames ( )

Returns the loaded module names found in the *.mod files parsed.

Returns
The loaded module names.

◆ GetModuleModFilePath()

str GetModuleModFilePath ( str  pModuleName)

Returns the *.mod file path containing the definition of the provided loaded module name.

Parameters
pModuleNameThe loaded module name to query.
Returns
The *.mod file path.

◆ GetModulePath()

str GetModulePath ( str  pModuleName)

Returns the module path associated with the provided loaded module name.

Parameters
pModuleNameThe loaded module name to query.
Returns
The module path.

◆ GetModuleSearchPaths()

FBStringList GetModuleSearchPaths ( )

Returns the module search paths where *.mod files can be parsed.

By default, there are three module search paths:

Returns
The module search paths.

◆ GetModuleVersion()

str GetModuleVersion ( str  pModuleName)

Returns the module version associated with the provided loaded module name.

Parameters
pModuleNameThe loaded module name to query.
Returns
The module version.