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

#include <fbassetmng.h>

Inheritance diagram for FBAssetMng:

[legend]

Public Member Functions
	FBAssetMng (const char *pName, HIObject pObject=NULL)
	Constructor. More...

	IObject_Declare (override)

virtual bool	Initialize ()=0
	Initialize the connection to the server. More...

virtual FBAssetFile *	BrowseForFile ()=0
	Let the user browse the asset database to select a file. More...

virtual FBAssetFolder *	BrowseForFolder ()=0
	Let the user browse the asset database to select a folder. More...

virtual FBAssetFolder *	CreateServerPath (const FBString &pServerPath)=0
	Create a folder path on the server side by adding each missing folders. More...

virtual bool	FileIsManaged (const FBString &pFilename)=0
	Is the specified local file managed (ie. More...

virtual bool	WithinManagedPath (const FBString &pLocalPath)=0
	Is the specified local path below a managed path. More...

virtual FBString	MapLocalPathToServerPath (const FBString &pLocalPath)=0
	Convert the local path to a server path by using managed paths mapping. More...

virtual FBAssetFile *	GetAssetFile (const FBString &pServerFilename)=0
	Get a file object using it's server path. More...

virtual FBAssetFile *	GetAssetFileFromLocalPath (const FBString &pLocalFilename)=0
	Get a file object using it's local path. More...

virtual FBAssetFolder *	GetAssetFolder (const FBString &pServerPath)=0
	Get a folder object using it's server path. More...

virtual FBAssetFolder *	GetAssetFolderFromLocalPath (const FBString &pLocalPath)=0
	Get a folder object using it's local path. More...

virtual void	ShowSettings ()=0
	Display a dialog that let the user changes settings. More...

virtual int	GetFileOptions ()=0
	Get the file options (i.e. More...

virtual bool	CheckAvailability () const =0
	Check if this manager can be used on the computer. More...

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor. More...

virtual	~FBComponent ()
	Destructor. More...

virtual bool	FBCreate ()
	Open Reality Creation function. More...

virtual void	FBDestroy ()
	Open Reality destruction function. More...

virtual void	FBDelete () override
	Open Reality deletion function. More...

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer. More...

virtual 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...

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager. More...

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading. More...

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property. More...

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated). More...

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags. More...

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled. More...

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags. More...

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags. More...

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status. More...

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled. More...

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace. More...

virtual const char *	ClassName () override
	Get the class name. More...

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not. More...

const char *	GetFullName (void)
	Get the full name. More...

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object. More...

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object. More...

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object. More...

void	HardSelect ()
	HardSelect. More...

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId. More...

virtual int	GetTypeId () override
	GetTypeId( int pTypeId ) More...

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject. More...

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Public Attributes
FBPropertyString	Name
	Read Write Property: Unique Name. More...

FBPropertyString	Description
	Read Write Property: Description of the manager. More...

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

FBString	LastError
	Last error string. More...

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyListComponent	Components
	List: List of components. More...

FBPropertyListComponent	Parents
	List: Parents. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

FBPropertyString	Name
	Read Write Property: Unique name of object. More...

FBPropertyString	LongName
	Read Write Property: Name and namespace for object. More...

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component. More...

Additional Inherited Members
Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object. More...

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component. More...

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection. More...

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection. More...

void	DisconnectAllSrc ()
	Remove all source connections. More...

void	DisconnectAllDst ()
	Remove all destination connections. More...

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index. More...

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index. More...

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B. More...

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex. More...

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc. More...

int	GetSrcCount ()
	Get source connection count. More...

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index. More...

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index. More...

int	GetDstCount ()
	Get destination connection count. More...

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index. More...

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index. More...

bool	BeginChange ()
	Begins a change on multiple plugs. More...

void	EndChange ()
	Ends a change on multiple plugs. More...

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed. More...

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status. More...

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag. More...

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed. More...

FBPlug *	GetOwner ()
	Get the owner of this plug. More...

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index. More...

int	GetOwnedCount ()
	Get the owned plug count. More...

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More...

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More...

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More...

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id. More...

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component. More...

HIObject	mObject
	Handle on the Plug. More...

bool	mSDKComponent
	bool Plug is an SDK component. More...

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object. More...

static int	TypeInfo
	TypeInfo. More...

static int	mGlobalTypeInfo
	Represente the Type Index. More...

Detailed Description

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

Definition at line 434 of file fbassetmng.h.

Constructor & Destructor Documentation

◆ FBAssetMng()

FBAssetMng	(	const char *	pName,
		HIObject	pObject = `NULL`
	)

Constructor.

Parameters

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

Member Function Documentation

◆ BrowseForFile()

virtual FBAssetFile* BrowseForFile ( )

pure virtual

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()

virtual FBAssetFolder* BrowseForFolder ( )

pure virtual

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()

virtual bool CheckAvailability ( ) const

pure virtual

Check if this manager can be used on the computer.

◆ CreateServerPath()

virtual FBAssetFolder* CreateServerPath ( const FBString & pServerPath )

pure virtual

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()

virtual bool FileIsManaged ( const FBString & pFilename )

pure virtual

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()

virtual FBAssetFile* GetAssetFile ( const FBString & pServerFilename )

pure virtual

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()

virtual FBAssetFile* GetAssetFileFromLocalPath ( const FBString & pLocalFilename )

pure virtual

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()

virtual FBAssetFolder* GetAssetFolder ( const FBString & pServerPath )

pure virtual

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()

virtual FBAssetFolder* GetAssetFolderFromLocalPath ( const FBString & pLocalPath )

pure virtual

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()

virtual int GetFileOptions ( )

pure virtual

Get the file options (i.e.

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

Returns: The options.

◆ Initialize()

virtual bool Initialize ( )

pure virtual

Initialize the connection to the server.

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

◆ MapLocalPathToServerPath()

virtual FBString MapLocalPathToServerPath ( const FBString & pLocalPath )

pure virtual

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()

virtual void ShowSettings ( )

pure virtual

Display a dialog that let the user changes settings.

◆ WithinManagedPath()

virtual bool WithinManagedPath ( const FBString & pLocalPath )

pure virtual

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

FBPropertyString Description

Read Write Property: Description of the manager.

Definition at line 522 of file fbassetmng.h.

◆ LastError

FBString LastError

Last error string.

Definition at line 524 of file fbassetmng.h.

◆ MenuFlags

FBPropertyInt MenuFlags

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

Definition at line 523 of file fbassetmng.h.

◆ Name

FBPropertyString Name

Read Write Property: Unique Name.

Definition at line 521 of file fbassetmng.h.

The documentation for this class was generated from the following file:

fbassetmng.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBAssetMng()

Member Function Documentation

◆ BrowseForFile()

◆ BrowseForFolder()

◆ CheckAvailability()

◆ CreateServerPath()

◆ FileIsManaged()

◆ GetAssetFile()

◆ GetAssetFileFromLocalPath()

◆ GetAssetFolder()

◆ GetAssetFolderFromLocalPath()

◆ GetFileOptions()

◆ Initialize()

◆ MapLocalPathToServerPath()

◆ ShowSettings()

◆ WithinManagedPath()

Member Data Documentation

◆ Description

◆ LastError

◆ MenuFlags

◆ Name