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

File Change Monitoring Interface to the file change monitoring. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBFileMonitoringManager:

Public Member Functions

 AddFileToMonitor (str pFilePath, FBFileMonitoringType pFileMonitoringType)
 Add file to monitor.
 
 CleanFileMonitoring (bool pIncludePythonEditorScripts=True)
 Clean files and directories currently been monitored.
 
 PauseFileMonitoring (bool pPause=True)
 Pause file from monitoring, except for Python Editor script files loaded.
 
 RemoveFileFromMonitor (str pFilePath)
 Remove file from monitoring.
 
- 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

FBEvent OnFileChangeAnimationClip
 Event: Animation clip file change event.

 
FBEvent OnFileChangeFileReference
 Event: File Reference file change event.

 
FBEvent OnFileChangeMainScene
 Event: Main scene file change event.

 
FBEvent OnFileChangePythonEditorScript
 Event: Python Editor Script file change event.

 
- 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

File Change Monitoring Interface to the file change monitoring.


Member Function Documentation

◆ AddFileToMonitor()

AddFileToMonitor ( str  pFilePath,
FBFileMonitoringType  pFileMonitoringType 
)

Add file to monitor.

Parameters
pFilePathThe file path to monitor.
pFileMonitoringTypeThe monitor type of this file.

◆ CleanFileMonitoring()

CleanFileMonitoring ( bool  pIncludePythonEditorScripts = True)

Clean files and directories currently been monitored.

Parameters
pIncludePythonEditorScriptsTrue to also clean the monitoring of Python Editor script files loaded, false otherwise.

◆ PauseFileMonitoring()

PauseFileMonitoring ( bool  pPause = True)

Pause file from monitoring, except for Python Editor script files loaded.

Parameters
pPauseTrue to pause the file monitoring, false to resume.

◆ RemoveFileFromMonitor()

RemoveFileFromMonitor ( str  pFilePath)

Remove file from monitoring.

Parameters
pFilePathThe file path to be removed.

Member Data Documentation

◆ OnFileChangeAnimationClip

FBEvent OnFileChangeAnimationClip

Event: Animation clip file change event.

◆ OnFileChangeFileReference

FBEvent OnFileChangeFileReference

Event: File Reference file change event.

◆ OnFileChangeMainScene

FBEvent OnFileChangeMainScene

Event: Main scene file change event.

◆ OnFileChangePythonEditorScript

FBEvent OnFileChangePythonEditorScript

Event: Python Editor Script file change event.