#include <kaydaradef.h>
#include <fbsdk/fbcomponent.h>

File Description

Declaration for the FBAssetMng class.

Definition in file fbassetmng.h.

Classes
class	FBAssetItem
	Base class for all managed assets. More...

class	FBAssetFile
	Class representing a file stored in a version control database. More...

class	FBAssetFolder
	Class representing a folder stored in a version control database. More...

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

Namespaces
	ORSDK2018

Macros
#define	FBSDK_DLL K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once... More...

#define	FBRegisterAssetFile(UniqueNameStr, ClassName, Label, Desc, IconFilename)
	AssetFile class registration. More...

#define	FBAssetFileDeclare(ClassName, Parent )
	AssetFile class declaration. More...

#define	FBAssetFileImplementation(ThisComponent) FBClassImplementation( ThisComponent )
	AssetFile class implementation. More...

#define	FBRegisterAssetFolder(UniqueNameStr, ClassName, Label, Desc, IconFilename)
	AssetFolder class registration. More...

#define	FBAssetFolderDeclare(ClassName, Parent )
	AssetFolder class declaration. More...

#define	FBAssetFolderImplementation(ThisComponent) FBClassImplementation( ThisComponent )
	AssetFolder class implementation. More...

#define	FBRegisterAssetMng(UniqueNameStr, ClassName, Label, Desc, IconFilename)
	Asset manager class registration. More...

#define	FBAssetMngDeclare(ClassName, Parent )
	Asset manager class declaration. More...

#define	FBAssetMngImplementation(ThisComponent) FBClassImplementation( ThisComponent )
	Asset manager class implementation. More...

Typedefs
typedef class FBPropertyBase< FBAssetMng *, kFBPT_object >	FBPropertyBaseAssetMng

typedef class FBPropertyBaseComponent< FBAssetMng * >	FBPropertyAssetMng

Enumerations
enum	FBAssetMngMenuOptions { kMenuOpenFromDatabase = 1<<0, kMenuAddToDatabase = 1<<1, kMenuUploadToDatabase = 1<<2, kMenuGetLatest = 1<<3, kMenuCheckIn = 1<<4, kMenuCheckOut = 1<<5, kMenuUndoCheckOut = 1<<6, kMenuShowHistory = 1<<7, kMenuShowProperties = 1<<8, kMenuShowExplorer = 1<<9, kMenuShowReferenceMng = 1<<10, kMenuShowSettings = 1<<11, kMenuEnable = 1<<12, kMenuFileAll = kMenuOpenFromDatabase \| kMenuAddToDatabase \| kMenuUploadToDatabase, kMenuSourceControlAll, kMenuSourceControlMin, kMenuAll = 0xFFFFFFFF }
	Show or hide version control menu items. More...

enum	FBAssetMngFileOptions { kFileCheckOutOnLoad = 1<<0, kFileCheckOutOnLoad_Ask = 1<<1, kFileUploadOnSave = 1<<2, kFileUploadOnSave_Ask = 1<<3, kFileAddOnNewSave = 1<<4, kFileAddOnNewSave_Ask = 1<<5, kFileCheckInOnClose = 1<<6, kFileCheckInOnClose_Ask = 1<<7, kFileOptionsAll = 0xFFFFFFFF }
	Behavior of the application when working with managed files. More...

Macro Definition Documentation

#define FBAssetFileDeclare	(	ClassName,
		Parent
	)

Value:

FBClassDeclare( ClassName,Parent); \
  public: \
    ClassName(const char* pName):Parent(pName) { FBClassInit; } \
  private:

AssetFile class declaration.

Parameters

ClassName	AssetFile class name.
Parent	Class parent.

Definition at line 174 of file fbassetmng.h.

#define FBAssetFileImplementation ( ThisComponent ) FBClassImplementation( ThisComponent )

AssetFile class implementation.

Parameters

ThisComponent Class to implement.

Definition at line 183 of file fbassetmng.h.

#define FBAssetFolderDeclare	(	ClassName,
		Parent
	)

Value:

FBClassDeclare( ClassName,Parent); \
  public: \
    ClassName(const char* pName):Parent(pName) { FBClassInit; } \
  private:

AssetFolder class declaration.

Parameters

ClassName	AssetFolder class name.
Parent	Class parent.

Definition at line 256 of file fbassetmng.h.

#define FBAssetFolderImplementation ( ThisComponent ) FBClassImplementation( ThisComponent )

AssetFolder class implementation.

Parameters

ThisComponent Class to implement.

Definition at line 265 of file fbassetmng.h.

#define FBAssetMngDeclare	(	ClassName,
		Parent
	)

Value:

FBClassDeclare( ClassName,Parent); \
  public: \
    ClassName(const char* pName):Parent(pName) { FBClassInit; } \
  private:

Asset manager class declaration.

Parameters

ClassName	Asset manager class name.
Parent	Class parent.

Definition at line 361 of file fbassetmng.h.

#define FBAssetMngImplementation ( ThisComponent ) FBClassImplementation( ThisComponent )

Asset manager class implementation.

Parameters

ThisComponent Class to implement.

Definition at line 370 of file fbassetmng.h.

#define FBRegisterAssetFile	(	UniqueNameStr,
		ClassName,
		Label,
		Desc,
		IconFilename
	)

Value:

HIObject RegisterAssetFile##ClassName( HIObject /*pOwner*/,const char* pName,void * /*pData*/) \
    { \
      ClassName *Class = new ClassName( Label ); \
        Class->Name = UniqueNameStr; \
        if (Class->FBCreate()) { \
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
	FBLibraryModule( ClassName )   \
    {   \
		FBRegisterObject( ClassName,"Asset/AssetItem/AssetFile",Label,Desc,RegisterAssetFile##ClassName, true, IconFilename );    \
    }

AssetFile class registration.

Parameters

UniqueNameStr	Unique name.
ClassName	AssetFile class name.
Label	Short description.
Desc	Long description.
IconFilename	Name of the icon file to use.

Definition at line 153 of file fbassetmng.h.

#define FBRegisterAssetFolder	(	UniqueNameStr,
		ClassName,
		Label,
		Desc,
		IconFilename
	)

Value:

HIObject RegisterAssetFolder##ClassName( HIObject /*pOwner*/,const char* pName,void * /*pData*/) \
    { \
      ClassName *Class = new ClassName( Label ); \
        Class->Name = UniqueNameStr; \
        if (Class->FBCreate()) { \
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
	FBLibraryModule( ClassName )   \
    {   \
		FBRegisterObject( ClassName,"Asset/AssetItem/AssetFolder",Label,Desc,RegisterAssetFolder##ClassName, true, IconFilename );    \
    }

AssetFolder class registration.

Parameters

UniqueNameStr	Unique name.
ClassName	AssetFolder class name.
Label	Short description.
Desc	Long description.
IconFilename	Name of the icon file to use.

Definition at line 235 of file fbassetmng.h.

#define FBRegisterAssetMng	(	UniqueNameStr,
		ClassName,
		Label,
		Desc,
		IconFilename
	)

Value:

HIObject RegisterAssetMng##ClassName( HIObject /*pOwner*/,const char* pName,void * /*pData*/) \
    { \
      ClassName *Class = new ClassName( Label ); \
        Class->Name = UniqueNameStr; \
        Class->Description = Desc; \
        if (Class->FBCreate()) { \
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
	FBLibraryModule( ClassName )   \
    {   \
		FBRegisterObject( ClassName,"Asset/AssetMng",Label,Desc,RegisterAssetMng##ClassName, false, IconFilename );   \
    }

Asset manager class registration.

Parameters

UniqueNameStr	Unique name.
ClassName	Asset manager class name.
Label	Short description.
Desc	Long description.
IconFilename	Name of the icon file to use.

Definition at line 339 of file fbassetmng.h.

#define FBSDK_DLL K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbassetmng.h.

Go to the source code of this file.

fbsdk/fbassetmng.h File Reference

File Description

Classes

Namespaces

Macros

Typedefs

Enumerations

Macro Definition Documentation