FBAssetFile Class Reference
FBAssetFile Class Reference
#include <mobu-python-api.h>
Class Description
Class representing a file stored in a version control database.
Inheritance diagram for FBAssetFile:
Public Member Functions | |
| __reduce__ () | |
| FBDestroy (FBAssetFile arg1) | |
| bool | FBCreate (FBAssetFile arg1) |
| Open Reality Creation function. More... | |
| str | GetCheckedOutBy (FBAssetFile arg1) |
| Returns the name of the user who currently has this file checked out. More... | |
| bool | IsCheckedOut (FBAssetFile arg1) |
| Returns a boolean value indicating if this file is checked out by any user. More... | |
| bool | IsCheckedOutByMe (FBAssetFile arg1) |
| Returns a boolean value indicating if this file is checked out by the current user. More... | |
| __init__ (...) | |
| Constructor. More... | |
| Public Member Functions inherited from FBAssetItem | |
| __reduce__ () | |
| bool | CheckIn (FBAssetItem arg1, str arg2, object arg3, object arg4) |
| Checks in this item and all its children (if this is a folder item). More... | |
| bool | CheckOut (FBAssetItem arg1, str arg2, object arg3, object arg4) |
| 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 (FBAssetItem arg1, object arg2, object arg3) |
| Obtain the latest version of the item from the server. More... | |
| str | GetLocalPath (FBAssetItem arg1) |
| Get the path to this item on the local hard disk. More... | |
| str | GetName (FBAssetItem arg1) |
| Get the name of this item (file name or folder name). More... | |
| object | GetParent (FBAssetItem arg1) |
| Get the parent folder of this item. More... | |
| str | GetServerPath (FBAssetItem arg1) |
| Get the path to this item on the database. More... | |
| ShowHistory (FBAssetItem arg1) | |
| Display a dialog with this item history. More... | |
| ShowProperties (FBAssetItem arg1) | |
| Display a dialog showing the properties of this item. More... | |
| bool | UndoCheckOut (FBAssetItem arg1, object arg2, object arg3) |
| Cancel the last check out operation. More... | |
| __init__ (...) | |
| Constructor. More... | |
| Public Member Functions inherited from FBComponent | |
| __reduce__ () | |
| FBPropertyList | PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2) |
| Get list of properties which have been modified since last loading. More... | |
| str | ClassName (FBComponent arg1) |
| Get the class name. More... | |
| DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2) | |
| Disable a specific Object Flags. More... | |
| EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2) | |
| Enable a specific Object Flags. More... | |
| bool | FBCreate (FBComponent arg1) |
| Open Reality Creation function. More... | |
| FBDelete (FBComponent arg1) | |
| Open Reality deletion function. More... | |
| FBDestroy (FBComponent arg1) | |
| Open Reality destruction function. More... | |
| FBObjectFlag | GetObjectFlags (FBComponent arg1) |
| Get all Object Flags (concatenated). More... | |
| bool | GetObjectStatus (FBComponent arg1, FBObjectStatus arg2) |
| Check to see if an object status is enabled. More... | |
| bool | HasObjectFlags (FBComponent arg1, FBObjectFlag arg2) |
| Check whether a specific object flag is enabled. More... | |
| bool | Is (FBComponent arg1, object arg2) |
| Returns true if object is of type TypeId. More... | |
| bool | ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5) |
| ProcessNamespaceHierarchy. More... | |
| bool | ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5) |
| ProcessObjectNamespace. More... | |
| int | PropertyAdd (FBComponent arg1, FBProperty arg2) |
| Add a property to the component's property manager. More... | |
| bool | PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2) |
| Add a reference property to the component's property manager. More... | |
| object | PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7) |
| Create user or dynamic property. More... | |
| PropertyRemove (FBComponent arg1, FBProperty arg2) | |
| Remove a Property from the component's Property manager. More... | |
| SetObjectFlags (FBComponent arg1, FBObjectFlag arg2) | |
| SetObjectFlags. More... | |
| SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3) | |
| Enable/Disable a specific Object Status. More... | |
| HardSelect (FBComponent arg1) | |
| HardSelect. More... | |
| object | GetOwnerFileReference (FBComponent arg1) |
| Get the owner FileReference object. More... | |
| __init__ (...) | |
| Constructor. More... | |
| Public Member Functions inherited from FBPlug | |
| __reduce__ () | |
| bool | BeginChange (FBPlug arg1) |
| Begins a change on multiple plugs. More... | |
| str | ClassName (FBPlug arg1) |
| internal System vars. More... | |
| bool | ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3) |
| Add a destination connection. More... | |
| bool | ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4) |
| Add a destination connection. More... | |
| bool | ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3) |
| Add a source connection. More... | |
| bool | ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4) |
| Add a source connection. More... | |
| DisconnectAllDst (FBPlug arg1) | |
| Remove all destination connections. More... | |
| DisconnectAllSrc (FBPlug arg1) | |
| Remove all source connections. More... | |
| bool | DisconnectDst (FBPlug arg1, FBPlug arg2) |
| Remove a destination connection. More... | |
| bool | DisconnectDstAt (FBPlug arg1, object arg2) |
| Remove a destination connection at a specified index. More... | |
| bool | DisconnectSrc (FBPlug arg1, FBPlug arg2) |
| Remove a source connection. More... | |
| bool | DisconnectSrcAt (FBPlug arg1, object arg2) |
| Remove a source connection at a specified index. More... | |
| EndChange (FBPlug arg1) | |
| Ends a change on multiple plugs. More... | |
| object | GetDst (FBPlug arg1, object arg2) |
| Get a destination connection's plug at specified index. More... | |
| int | GetDstCount (FBPlug arg1) |
| Get destination connection count. More... | |
| FBConnectionType | GetDstType (FBPlug arg1, object arg2) |
| Get a destination connection's type at specified index. More... | |
| object | GetOwned (FBPlug arg1, object arg2) |
| Get the owned plug at specified index. More... | |
| int | GetOwnedCount (FBPlug arg1) |
| Get the owned plug count. More... | |
| object | GetOwner (FBPlug arg1) |
| Get the owner of this plug. More... | |
| object | GetSrc (FBPlug arg1, object arg2) |
| Get a source connection's plug at specified index. More... | |
| int | GetSrcCount (FBPlug arg1) |
| Get source connection count. More... | |
| FBConnectionType | GetSrcType (FBPlug arg1, object arg2) |
| Get a source connection's type at specified index. More... | |
| bool | Is (FBPlug arg1, object arg2) |
| Is( int pTypeId ) More... | |
| bool | IsSDKComponent (FBPlug arg1) |
| Return whether or not item is an SDK component. More... | |
| MoveSrcAt (...) | |
| bool | ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3) |
| Replace a destination connection at a specified index. More... | |
| bool | ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3) |
| Replace a source connection at a specified index. More... | |
| bool | SwapSrc (FBPlug arg1, object arg2, object arg3) |
| Swap source connection at index A with source connection at index B. More... | |
| SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3) | |
| Set the plug's self modification flag. More... | |
| bool | GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2) |
| Tell if the plug's self has changed. More... | |
| SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3) | |
| Set the plug's owned property/object's modification flag. More... | |
| bool | GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2) |
| Tell if the plug's content has changed. More... | |
| int | GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4) |
| Get plug's modified src/dst property/object connection added/removed List. More... | |
| bool | RevertModification (FBPlug arg1, FBPlugModificationFlag arg2) |
| Revert the plug's modification to original status. More... | |
| __init__ (...) | |
| method | staticmethod (function) |
| Public Member Functions inherited from FBPythonWrapper | |
| __reduce__ () | |
| __init__ (...) | |
Additional Inherited Members | |
| Public Attributes inherited from FBAssetItem | |
| ORSDK2018::FBString | LastError |
| Last error string. More... | |
| Public Attributes inherited from FBComponent | |
| object | OwnerNamespace |
| ORSDK2018::FBPropertyListComponent | Components |
| List: List of components. More... | |
| ORSDK2018::FBPropertyString | Name |
| Read Write Property: Unique name of object. More... | |
| ORSDK2018::FBPropertyString | LongName |
| Read Write Property: Name and namespace for object. More... | |
| object | FullName |
| ORSDK2018::FBPropertyListComponent | Parents |
| List: Parents. More... | |
| ORSDK2018::FBPropertyManager | PropertyList |
| Read Only Property: Manages all of the properties for the component. More... | |
| FBPropertyBool | Selected |
| Read Write Property: Selected property. More... | |
| Public Attributes inherited from FBPythonWrapper | |
| object | OnUnbind |
Member Function Documentation
| __init__ | ( | ... | ) |
Constructor.
Python Docstring:
Raises an exception This class cannot be instantiated from Python
C++ Signature:
FBAssetFile(const char * pName, HIObject pObject = ((void *) 0))
- Parameters
-
pName Name of Command. pObject Internal parent object to own FBComponent (default is NULL).
| __reduce__ | ( | ) |
| bool FBCreate | ( | FBAssetFile | arg1 | ) |
Open Reality Creation function.
Python Docstring:
FBCreate( (FBAssetFile)arg1) -> bool
C++ Signature:
bool FBCreate()
- Returns
- Outcome of creation (true/false).
| FBDestroy | ( | FBAssetFile | arg1 | ) |
Python Docstring:
FBDestroy( (FBAssetFile)arg1) -> None
| str GetCheckedOutBy | ( | FBAssetFile | arg1 | ) |
Returns the name of the user who currently has this file checked out.
Python Docstring:
GetCheckedOutBy( (FBAssetFile)arg1) -> str
C++ Signature:
ORSDK2018::FBString GetCheckedOutBy()
- Returns
- The user name if the file is checked out, or an empty string if it is not.
| bool IsCheckedOut | ( | FBAssetFile | arg1 | ) |
Returns a boolean value indicating if this file is checked out by any user.
Python Docstring:
IsCheckedOut( (FBAssetFile)arg1) -> bool
C++ Signature:
bool IsCheckedOut()
- Returns
- A boolean value indicating if this node is checked out.
| bool IsCheckedOutByMe | ( | FBAssetFile | arg1 | ) |
Returns a boolean value indicating if this file is checked out by the current user.
Python Docstring:
IsCheckedOutByMe( (FBAssetFile)arg1) -> bool
C++ Signature:
bool IsCheckedOutByMe()
- Returns
- A boolean value indicating if this node is checked out by the current user.