FBAssetMng Class Reference

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

#include <pyfbsdk.h>

Inheritance diagram for FBAssetMng:

Public Member Functions
	FBAssetMng (str pName)
	Constructor.
FBAssetFile	BrowseForFile ()
	Let the user browse the asset database to select a file.
FBAssetFolder	BrowseForFolder ()
	Let the user browse the asset database to select a folder.
bool	CheckAvailability ()
	Check if this manager can be used on the computer.
FBAssetFolder	CreateServerPath (str pServerPath)
	Create a folder path on the server side by adding each missing folders.
bool	FileIsManaged (str pFilename)
	Is the specified local file managed (ie.
FBAssetFile	GetAssetFile (str pServerFilename)
	Get a file object using it's server path.
FBAssetFile	GetAssetFileFromLocalPath (str pLocalFilename)
	Get a file object using it's local path.
FBAssetFolder	GetAssetFolder (str pServerPath)
	Get a folder object using it's server path.
FBAssetFolder	GetAssetFolderFromLocalPath (str pLocalPath)
	Get a folder object using it's local path.
int	GetFileOptions ()
	Get the file options (i.e.
bool	Initialize ()
	Initialize the connection to the server.
str	MapLocalPathToServerPath (str pLocalPath)
	Convert the local path to a server path by using managed paths mapping.
	ShowSettings ()
	Display a dialog that let the user changes settings.
bool	WithinManagedPath (str pLocalPath)
	Is the specified local path below a managed path.
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	Description
	Read Write Property: Description of the manager.
str	LastError
	Last error string.
int	MenuFlags
	Read Write Property: Flags specifing which menu items are added by the manager.
str	Name
	Read Write Property: Unique Name.
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

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

Constructor & Destructor Documentation

FBAssetMng()

FBAssetMng

(

str

pName

)

Constructor.

Parameters

pName

Name of Command.

Member Function Documentation

BrowseForFile()

FBAssetFile BrowseForFile

(

)

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

Returns

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

BrowseForFolder()

FBAssetFolder BrowseForFolder

(

)

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

Returns

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

CheckAvailability()

bool CheckAvailability

(

)

Check if this manager can be used on the computer.

CreateServerPath()

FBAssetFolder CreateServerPath

(

str

pServerPath

)

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

Parameters

pServerPath

The path to create on the server side.

Returns

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

FileIsManaged()

bool FileIsManaged

(

str

pFilename

)

Is the specified local file managed (ie.

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.

GetAssetFile()

FBAssetFile GetAssetFile

(

str

pServerFilename

)

Get a file object using it's server path.

Parameters

pServerFilename

Path to the file on the server.

Returns

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

GetAssetFileFromLocalPath()

FBAssetFile GetAssetFileFromLocalPath

(

str

pLocalFilename

)

Get a file object using it's local path.

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.

GetAssetFolder()

FBAssetFolder GetAssetFolder

(

str

pServerPath

)

Get a folder object using it's server path.

Parameters

pServerPath

Path the the folder on the server.

Returns

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

GetAssetFolderFromLocalPath()

FBAssetFolder GetAssetFolderFromLocalPath

(

str

pLocalPath

)

Get a folder object using it's local path.

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.

GetFileOptions()

int GetFileOptions

(

)

Get the file options (i.e.

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

Returns

The options.

Initialize()

bool Initialize

(

)

Initialize the connection to the server.

Returns

True if the connection was established, false otherwise.

MapLocalPathToServerPath()

str MapLocalPathToServerPath

(

str

pLocalPath

)

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

Parameters

pLocalPath

Local path to be mapped.

Returns

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

ShowSettings()

ShowSettings

(

)

Display a dialog that let the user changes settings.

WithinManagedPath()

bool WithinManagedPath

(

str

pLocalPath

)

Is the specified local path below a managed path.

Parameters

pLocalPath

Local path to be checked.

Returns

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

Member Data Documentation

Description

str Description

Read Write Property: Description of the manager.

LastError

str LastError

Last error string.

MenuFlags

int MenuFlags

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

Name

str Name

Read Write Property: Unique Name.