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

Access to global construction history functionality. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBConstructionHistory:

Public Member Functions

 FBConstructionHistory ()
 Constructor.
 
 GetDeltaOperations (FBConstructionOperationArray pOperations, int sinceCommandId=-1)
 GetDeltaOperations Get the list of delta operations in the construction history.
 
 GetScriptOutput (str script, str errors)
 GetScriptOutput Returns the output from the scripting engine.
 
FBConstructionHistoryState GetState ()
 GetState returns the current state of the construction history manager.
 
 NetDelete (FBComponent component, kInt64 key)
 NetDelete Network delete with support for Network Undo.
 
 NetUndo (kInt64 key)
 NetUndo Perform network undo operation.
 
int RunOperation (FBConstructionOperation operation, str out_errors)
 RunOperation Runs an operation.
 
- 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 OnChange
 Event: History changed.

 
- 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

Access to global construction history functionality.


Constructor & Destructor Documentation

◆ FBConstructionHistory()

Constructor.

Member Function Documentation

◆ GetDeltaOperations()

GetDeltaOperations ( FBConstructionOperationArray  pOperations,
int  sinceCommandId = -1 
)

GetDeltaOperations Get the list of delta operations in the construction history.

Parameters
pOperationsArray of operations, will be filled by the function.

◆ GetScriptOutput()

GetScriptOutput ( str  script,
str  errors 
)

GetScriptOutput Returns the output from the scripting engine.

Parameters
scriptthe script text
errorsthe error outputted from the scripting engine

◆ GetState()

GetState returns the current state of the construction history manager.

Returns
returns a FBConstructionHistoryState indicating the state

◆ NetDelete()

NetDelete ( FBComponent  component,
kInt64  key 
)

NetDelete Network delete with support for Network Undo.

Parameters
keyA key that uniquely identifies the operation

◆ NetUndo()

NetUndo ( kInt64  key)

NetUndo Perform network undo operation.

Parameters
keyThe operation to undo

◆ RunOperation()

int RunOperation ( FBConstructionOperation  operation,
str  out_errors 
)

RunOperation Runs an operation.

Parameters
operationThe operation to run
out_errorsA string containing the text of errors generated by running the operations (if any)

Member Data Documentation

◆ OnChange

FBEvent OnChange

Event: History changed.