|
Python Reference Guide
|
|
|
Python Reference Guide
|
|
Class representing a file stored in a version control database. More...
#include <pyfbsdk_generated.h>
Public Member Functions | |
| FBAssetFile (str pName) | |
| Constructor. More... | |
| bool | FBCreate () |
| Open Reality Creation function. More... | |
| str | GetCheckedOutBy () |
| Returns the name of the user who currently has this file checked out. More... | |
| bool | IsCheckedOut () |
| Returns a boolean value indicating if this file is checked out by any user. More... | |
| bool | IsCheckedOutByMe () |
| Returns a boolean value indicating if this file is checked out by the current user. More... | |
 Public Member Functions inherited from FBAssetItem | |
| FBAssetItem (str pName) | |
| Constructor. More... | |
| bool | CheckIn (str pComment="", bool pKeepCheckedOut=False, bool pSilent=False) |
| Checks in this item and all its children (if this is a folder item). More... | |
| bool | CheckOut (str pComment="", bool pDontGetLocal=False, bool pSilent=False) |
| Checks out this item and it's childs (if this is a folder item) and makes them writeable on the local disk. More... | |
| bool | GetLatest (bool pReplaceCheckedOut=False, bool pSilent=False) |
| Obtain the latest version of the item from the server. More... | |
| str | GetLocalPath () |
| Get the path to this item on the local hard disk. More... | |
| str | GetName () |
| Get the name of this item (file name or folder name). More... | |
| FBAssetFolder | GetParent () |
| Get the parent folder of this item. More... | |
| str | GetServerPath () |
| Get the path to this item on the database. More... | |
| ShowHistory () | |
| Display a dialog with this item history. More... | |
| ShowProperties () | |
| Display a dialog showing the properties of this item. More... | |
| bool | UndoCheckOut (bool pReplaceLocalFile=True, bool pSilent=False) |
| Cancel the last check out operation. More... | |
| Public Member Functions inherited from FBComponent | |
| FBComponent () | |
| Constructor. More... | |
| str | ClassName () |
| Get the class name. More... | |
| DisableObjectFlags (FBObjectFlag pFlags) | |
| Disable a specific Object Flags. More... | |
| EnableObjectFlags (FBObjectFlag pFlags) | |
| Enable a specific Object Flags. More... | |
| bool | FBCreate () |
| Open Reality Creation function. More... | |
| FBDelete () | |
| Open Reality deletion function. More... | |
| FBDestroy () | |
| Open Reality destruction function. More... | |
| FBObjectFlag | GetObjectFlags () |
| Get all Object Flags (concatenated). More... | |
| bool | GetObjectStatus (FBObjectStatus pStatus) |
| Check to see if an object status is enabled. More... | |
| FBFileReference | GetOwnerFileReference (p0) |
| Get the owner FileReference object. More... | |
| HardSelect () | |
| HardSelect. More... | |
| bool | HasObjectFlags (FBObjectFlag pFlags) |
| Check whether a specific object flag is enabled. More... | |
| bool | Is (int pTypeId) |
| Returns true if object is of type TypeId. More... | |
| bool | ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True) |
| ProcessNamespaceHierarchy. More... | |
| bool | ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True) |
| ProcessObjectNamespace. More... | |
| int | PropertyAdd (FBProperty pProperty) |
| Add a property to the component's property manager. More... | |
| bool | PropertyAddReferenceProperty (FBProperty pReferenceProperty) |
| Add a reference property to the component's property manager. More... | |
| FBProperty | PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None) |
| Create user or dynamic property. More... | |
| PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags) | |
| Get list of properties which have been modified since last loading. More... | |
| PropertyRemove (FBProperty pProperty) | |
| Remove a Property from the component's Property manager. More... | |
| SetObjectFlags (FBObjectFlag pFlags) | |
| SetObjectFlags. More... | |
| SetObjectStatus (FBObjectStatus pStatus, bool pValue) | |
| Enable/Disable a specific Object Status. More... | |
Additional Inherited Members | |
| Public Attributes inherited from FBAssetItem | |
| str | LastError |
| Last error string. More... | |
| Public Attributes inherited from FBComponent | |
| FBListComponent | Components |
| List: List of components. More... | |
| str | LongName |
| Read Write Property: Name and namespace for object. More... | |
| str | Name |
| Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py. More... | |
| FBListComponent | Parents |
| List: Parents. More... | |
| FBManager | PropertyList |
| Read Only Property: Manages all of the properties for the component. More... | |
| bool | Selected |
| Read Write Property: Selected property. More... | |
| int | TypeInfo |
| Contains the Type information of the object. More... | |
| Public Attributes inherited from FBPlug | |
| str | ClassGroupName |
| ClassGroupName of the object. More... | |
| int | TypeInfo |
| TypeInfo. More... | |
Class representing a file stored in a version control database.
| FBAssetFile | ( | str | pName | ) |
Constructor.
| pName | Name of Command. |
| bool FBCreate | ( | ) |
Open Reality Creation function.
| str GetCheckedOutBy | ( | ) |
Returns the name of the user who currently has this file checked out.
| bool IsCheckedOut | ( | ) |
Returns a boolean value indicating if this file is checked out by any user.
| bool IsCheckedOutByMe | ( | ) |
Returns a boolean value indicating if this file is checked out by the current user.
1.9.4