#include <mobu-python-api.h>

Class Description

Used to access asset manager functionity to get files locally or from a server.

Inheritance diagram for FBAssetMng:

Public Member Functions
	__reduce__ ()

object	BrowseForFolder (FBAssetMng arg1)
	Let the user browse the asset database to select a folder. More...

object	BrowseForFile (FBAssetMng arg1)
	Let the user browse the asset database to select a file. More...

bool	CheckAvailability (FBAssetMng arg1)
	Check if this manager can be used on the computer. More...

object	CreateServerPath (FBAssetMng arg1, str arg2)
	Create a folder path on the server side by adding each missing folders. More...

bool	FileIsManaged (FBAssetMng arg1, str arg2)
	Is the specified local file managed (ie. More...

object	GetAssetFile (FBAssetMng arg1, str arg2)
	Get a file object using it's server path. More...

object	GetAssetFileFromLocalPath (FBAssetMng arg1, str arg2)
	Get a file object using it's local path. More...

object	GetAssetFolder (FBAssetMng arg1, str arg2)
	Get a folder object using it's server path. More...

object	GetAssetFolderFromLocalPath (FBAssetMng arg1, str arg2)
	Get a folder object using it's local path. More...

int	GetFileOptions (FBAssetMng arg1)
	Get the file options (i.e. More...

bool	Initialize (FBAssetMng arg1)
	Initialize the connection to the server. More...

str	MapLocalPathToServerPath (FBAssetMng arg1, str arg2)
	Convert the local path to a server path by using managed paths mapping. More...

	ShowSettings (FBAssetMng arg1)
	Display a dialog that let the user changes settings. More...

bool	WithinManagedPath (FBAssetMng arg1, str arg2)
	Is the specified local path below a managed path. 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__ (...)

Public Attributes
ORSDK2018::FBPropertyString	Description
	Read Write Property: Description of the manager. More...

ORSDK2018::FBString	LastError
	Last error string. More...

FBPropertyInt	MenuFlags
	Read Write Property: Flags specifing which menu items are added by the manager. More...

ORSDK2018::FBPropertyString	Name
	Read Write Property: Unique Name. 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:

 FBAssetMng(const char * pName, HIObject pObject = ((void *) 0))

Parameters

pName	Name of Command.
pObject	Internal parent object to own FBComponent (default is NULL).

See the C++ reference

__reduce__ ( )

object BrowseForFile ( FBAssetMng arg1 )

Let the user browse the asset database to select a file.

Python Docstring:

BrowseForFile( (FBAssetMng)arg1) -> object

C++ Signature:

ORSDK2018::FBAssetFile * BrowseForFile()

Returns: A file object representing the file that was selected, or NULL if none.

See the C++ reference

object BrowseForFolder ( FBAssetMng arg1 )

Let the user browse the asset database to select a folder.

Python Docstring:

BrowseForFolder( (FBAssetMng)arg1) -> object

C++ Signature:

ORSDK2018::FBAssetFolder * BrowseForFolder()

Returns: A FBAssetFolder* object representing the folder that was selected, or NULL if none.

See the C++ reference

bool CheckAvailability ( FBAssetMng arg1 )

Check if this manager can be used on the computer.

Python Docstring:

CheckAvailability( (FBAssetMng)arg1) -> bool

C++ Signature:

bool CheckAvailability()

See the C++ reference

object CreateServerPath	(	FBAssetMng	arg1,
		str	arg2
	)

Create a folder path on the server side by adding each missing folders.

Python Docstring:

CreateServerPath( (FBAssetMng)arg1, (str)arg2) -> object

C++ Signature:

ORSDK2018::FBAssetFolder * CreateServerPath(const ORSDK2018::FBString & pServerPath)

Parameters

pServerPath The path to create on the server side.

Returns: A FBAssetFolder* object representing the deepest folder of the path.

See the C++ reference

bool FileIsManaged	(	FBAssetMng	arg1,
		str	arg2
	)

Is the specified local file managed (ie.

Python Docstring:

FileIsManaged( (FBAssetMng)arg1, (str)arg2) -> bool

C++ Signature:

bool FileIsManaged(const ORSDK2018::FBString & pFilename)

also present in the database).

Parameters

pFilename Path to the file on the local disk.

Returns: A boolean indicating if the file is managed or not.

See the C++ reference

object GetAssetFile	(	FBAssetMng	arg1,
		str	arg2
	)

Get a file object using it's server path.

Python Docstring:

GetAssetFile( (FBAssetMng)arg1, (str)arg2) -> object

C++ Signature:

ORSDK2018::FBAssetFile * GetAssetFile(const ORSDK2018::FBString & pServerFilename)

Parameters

pServerFilename Path to the file on the server.

Returns: An FBAssetFile* object, or NULL if the file was not found.

See the C++ reference

object GetAssetFileFromLocalPath	(	FBAssetMng	arg1,
		str	arg2
	)

Get a file object using it's local path.

Python Docstring:

GetAssetFileFromLocalPath( (FBAssetMng)arg1, (str)arg2) -> object

C++ Signature:

ORSDK2018::FBAssetFile * GetAssetFileFromLocalPath(const ORSDK2018::FBString & pLocalFilename)

Parameters

pLocalFilename Path to the file on the local disk.

Returns: An FBAssetFile* object, or NULL if the file was not found or no mapping could be done.

See the C++ reference

object GetAssetFolder	(	FBAssetMng	arg1,
		str	arg2
	)

Get a folder object using it's server path.

Python Docstring:

GetAssetFolder( (FBAssetMng)arg1, (str)arg2) -> object

C++ Signature:

ORSDK2018::FBAssetFolder * GetAssetFolder(const ORSDK2018::FBString & pServerPath)

Parameters

pServerPath Path the the folder on the server.

Returns: An FBAssetFolder* object, or NULL if the folder was not found.

See the C++ reference

object GetAssetFolderFromLocalPath	(	FBAssetMng	arg1,
		str	arg2
	)

Get a folder object using it's local path.

Python Docstring:

GetAssetFolderFromLocalPath( (FBAssetMng)arg1, (str)arg2) -> object

C++ Signature:

ORSDK2018::FBAssetFolder * GetAssetFolderFromLocalPath(const ORSDK2018::FBString & pLocalPath)

Parameters

pLocalPath Path to the folder on the local disk.

Returns: An FBAssetFolder* object, or NULL if the folder was not found or no mapping could be done.

See the C++ reference

int GetFileOptions ( FBAssetMng arg1 )

Get the file options (i.e.

Python Docstring:

GetFileOptions( (FBAssetMng)arg1) -> int

C++ Signature:

int GetFileOptions()

what to do when loading, saving or closing managed files).

Returns: The options.

See the C++ reference

bool Initialize ( FBAssetMng arg1 )

Initialize the connection to the server.

Python Docstring:

Initialize( (FBAssetMng)arg1) -> bool

C++ Signature:

bool Initialize()

Returns: True if the connection was established, false otherwise.

See the C++ reference

str MapLocalPathToServerPath	(	FBAssetMng	arg1,
		str	arg2
	)

Convert the local path to a server path by using managed paths mapping.

Python Docstring:

MapLocalPathToServerPath( (FBAssetMng)arg1, (str)arg2) -> str

C++ Signature:

ORSDK2018::FBString MapLocalPathToServerPath(const ORSDK2018::FBString & pLocalPath)

Parameters

pLocalPath Local path to be mapped.

Returns: A string with the resulting server path, will be empty if the mapping fail.

See the C++ reference

ShowSettings ( FBAssetMng arg1 )

Display a dialog that let the user changes settings.

Python Docstring:

ShowSettings( (FBAssetMng)arg1) -> None

C++ Signature:

void ShowSettings()

See the C++ reference

bool WithinManagedPath	(	FBAssetMng	arg1,
		str	arg2
	)

Is the specified local path below a managed path.

Python Docstring:

WithinManagedPath( (FBAssetMng)arg1, (str)arg2) -> bool

C++ Signature:

bool WithinManagedPath(const ORSDK2018::FBString & pLocalPath)

Parameters

pLocalPath Local path to be checked.

Returns: A boolean indicating if the path is within a managed path or not.

See the C++ reference

Member Data Documentation

ORSDK2018::FBPropertyString Description

Read Write Property: Description of the manager.

See the C++ reference

ORSDK2018::FBString LastError

Last error string.

See the C++ reference

FBPropertyInt MenuFlags

Read Write Property: Flags specifing which menu items are added by the manager.

See the C++ reference

ORSDK2018::FBPropertyString Name

Read Write Property: Unique Name.

See the C++ reference

FBAssetMng Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation