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

Base class for all managed assets. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBAssetItem:

Public Member Functions

 FBAssetItem (str pName)
 Constructor.
 
bool CheckIn (str pComment="", bool pKeepCheckedOut=False, bool pSilent=False)
 Checks in this item and all its children (if this is a folder item).
 
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.
 
bool GetLatest (bool pReplaceCheckedOut=False, bool pSilent=False)
 Obtain the latest version of the item from the server.
 
str GetLocalPath ()
 Get the path to this item on the local hard disk.
 
str GetName ()
 Get the name of this item (file name or folder name).
 
FBAssetFolder GetParent ()
 Get the parent folder of this item.
 
str GetServerPath ()
 Get the path to this item on the database.
 
 ShowHistory ()
 Display a dialog with this item history.
 
 ShowProperties ()
 Display a dialog showing the properties of this item.
 
bool UndoCheckOut (bool pReplaceLocalFile=True, bool pSilent=False)
 Cancel the last check out 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

str LastError
 Last error string.

 
- 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

Base class for all managed assets.


Constructor & Destructor Documentation

◆ FBAssetItem()

FBAssetItem ( str  pName)

Constructor.

Parameters
pNameName of Command.

Member Function Documentation

◆ CheckIn()

bool CheckIn ( str  pComment = "",
bool  pKeepCheckedOut = False,
bool  pSilent = False 
)

Checks in this item and all its children (if this is a folder item).

Parameters
pCommentComment to be applied for the check in.
pKeepCheckedOutFlag that indicates whether the item will be kept checked out.
pSilentIf pSilent is set to true, no dialog will be displayed by this method.
Returns
A boolean indicating if the operation was successful.

◆ CheckOut()

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.

Parameters
pCommentComment to be applied for the check out.
pDontGetLocalIndicate if local copy should retrieved or not.
pSilentIf pSilent is set to true, no dialog will be displayed by this method.
Returns
A boolean indicating if the operation was successful.

◆ GetLatest()

bool GetLatest ( bool  pReplaceCheckedOut = False,
bool  pSilent = False 
)

Obtain the latest version of the item from the server.

Parameters
pReplaceCheckedOutWhether to replace the checked out file or not.
pSilentIf pSilent is set to true, no dialog will be displayed by this method.
Returns
A boolean indicating if the operation was successful.

◆ GetLocalPath()

str GetLocalPath ( )

Get the path to this item on the local hard disk.

Returns
The path as an FBString.

◆ GetName()

str GetName ( )

Get the name of this item (file name or folder name).

Returns
The name of the item, as an FBString.

◆ GetParent()

FBAssetFolder GetParent ( )

Get the parent folder of this item.

Returns
An FBAssetFolder* if the parent was found, or NULL if this is the root item.

◆ GetServerPath()

str GetServerPath ( )

Get the path to this item on the database.

Returns
The server path as an FBString.

◆ ShowHistory()

ShowHistory ( )

Display a dialog with this item history.

◆ ShowProperties()

ShowProperties ( )

Display a dialog showing the properties of this item.

◆ UndoCheckOut()

bool UndoCheckOut ( bool  pReplaceLocalFile = True,
bool  pSilent = False 
)

Cancel the last check out operation.

Parameters
pReplaceLocalFileFlag indicating if the local item(s) should be replaced by the server version.
pSilentIf pSilent is set to true, no dialog will be displayed by this method.
Returns
A boolean indicating if the operation was successful.

Member Data Documentation

◆ LastError

str LastError

Last error string.