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

#include <fbassetmng.h>

Inheritance diagram for FBAssetFolder:

[legend]

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

	IObject_Declare (override)

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

virtual int	GetChildCount () const =0
	Get the number of items in this folder. More...

virtual FBAssetItem *	GetChild (int pIndex)=0
	Get the child at index pIndex. More...

virtual FBAssetFile *	GetFile (const FBString &pName)=0
	Get a file present in this folder by using it's name. More...

virtual FBAssetFolder *	GetFolder (const FBString &pName)=0
	Get a folder present in this folder by using it's name. More...

virtual FBAssetFile *	AddFile (const FBString &pLocalPath, const FBString &pComment="", bool pCheckOut=false, bool pSilent=false)=0
	Add a specified file into the database. More...

virtual FBAssetFolder *	AddFolder (const FBString &pName, const FBString &pComment="", bool pSilent=false)=0
	Add a folder in the database. More...

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

virtual FBString	GetName () const =0
	Get the name of this item (file name or folder name). More...

virtual FBString	GetLocalPath () const =0
	Get the path to this item on the local hard disk. More...

virtual FBString	GetServerPath () const =0
	Get the path to this item on the database. More...

virtual FBAssetFolder *	GetParent () const =0
	Get the parent folder of this item. More...

virtual bool	GetLatest (bool pReplaceCheckedOut=false, bool pSilent=false)=0
	Obtain the latest version of the item from the server. More...

virtual bool	CheckIn (const FBString &pComment="", bool pKeepCheckedOut=false, bool pSilent=false)=0
	Checks in this item and all its children (if this is a folder item). More...

virtual bool	CheckOut (const FBString &pComment="", bool pDontGetLocal=false, bool pSilent=false)=0
	Checks out this item and it's childs (if this is a folder item) and makes them writeable on the local disk. More...

virtual bool	UndoCheckOut (bool pReplaceLocalFile=true, bool pSilent=false)=0
	Cancel the last check out operation. More...

virtual void	ShowHistory () const =0
	Display a dialog with this item history. More...

virtual void	ShowProperties () const =0
	Display a dialog showing the properties of this item. More...

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

virtual	~FBComponent ()
	Destructor. 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 *)

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)

Public Attributes inherited from FBAssetItem
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...

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

Class representing a folder stored in a version control database.

Definition at line 275 of file fbassetmng.h.

Constructor & Destructor Documentation

◆ FBAssetFolder()

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

◆ AddFile()

virtual FBAssetFile* AddFile	(	const FBString &	pLocalPath,
		const FBString &	pComment = `""`,
		bool	pCheckOut = `false`,
		bool	pSilent = `false`
	)

pure virtual

Add a specified file into the database.

It will be added in this folder.

Parameters

pLocalPath	The full path to the file on the local disk.
pComment	Comment to be applied for the operation.
pCheckOut	Whether the file should be checked out or not.
pSilent	If pSilent is set to true, no dialog will be displayed by this method.

Returns: An FBAssetfile* object representing the newly added file.

◆ AddFolder()

virtual FBAssetFolder* AddFolder	(	const FBString &	pName,
		const FBString &	pComment = `""`,
		bool	pSilent = `false`
	)

pure virtual

Add a folder in the database.

It will be added in this folder.

Parameters

pName	Name of the folder to be created.
pComment	Comment to be applied for the operation.
pSilent	If pSilent is set to true, no dialog will be displayed by this method.

Returns: An FBAssetFolder* object representing the newly added folder.

◆ FBCreate()

virtual bool FBCreate ( )

overridevirtual

Open Reality Creation function.

Returns: Outcome of creation (true/false).

Reimplemented from FBComponent.

◆ GetChild()

virtual FBAssetItem* GetChild ( int pIndex )

pure virtual

Get the child at index pIndex.

Returns: The child at pIndex, or NULL if the index was out of range.

◆ GetChildCount()

virtual int GetChildCount ( ) const

pure virtual

Get the number of items in this folder.

Returns: The number of items in this folder.

◆ GetFile()

virtual FBAssetFile* GetFile ( const FBString & pName )

pure virtual

Get a file present in this folder by using it's name.

Returns: The file with the given name, or NULL if it was not found.

◆ GetFolder()

virtual FBAssetFolder* GetFolder ( const FBString & pName )

pure virtual

Get a folder present in this folder by using it's name.

Returns: The folder with the given name, or NULL if it was not found.

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

fbassetmng.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBAssetFolder()

Member Function Documentation

◆ AddFile()

◆ AddFolder()

◆ FBCreate()

◆ GetChild()

◆ GetChildCount()

◆ GetFile()

◆ GetFolder()