IContainerManager.h

Go to the documentation of this file.

/*****************************************************************************

    FILE: IContainerManager.h

    DESCRIPTION: Describes the interface for global container functionality.

    CREATED BY: Nicolas Leonard

    HISTORY:    July 9th, 2008  Creation

    Copyright (c) 2008, All Rights Reserved.
 *****************************************************************************/
#pragma once

#include "iFnPub.h"
#include "GetCOREInterface.h"
#include "AssetManagement/AssetUser.h"
#include "IContainerObject.h"

// forward declarations
class INodeTab;



class IContainerManager : public FPStaticInterface
{
public:

    virtual INode* CreateContainer(INodeTab& contentNodes) = 0;


    virtual INode* CreateInheritedContainer(const MaxSDK::AssetManagement::AssetUser& asset) = 0;


    virtual IContainerObject* IsInContainer(INode *node) = 0;


    virtual IContainerObject* IsContainerNode(INode *node) = 0;

    // Function IDs for function publishing
    enum 
    { 
        IMPORT_CONTAINER_ID,
        CREATE_CONTAINER_ID,
        IS_IN_CONTAINER_ID,
        IS_CONTAINER_NODE_ID,
    };
};

#define IID_IContainerManager Interface_ID(0xD951AEE9, 0x5769E48B)

inline IContainerManager* GetContainerManagerInterface() { 
    return static_cast<IContainerManager*>(GetCOREInterface(IID_IContainerManager)); 
}


//==============================================================================
// class IContainerPreferences
//
//==============================================================================
class IContainerPreferences: public FPStaticInterface
{
public:
    enum DisplayStatusOverride { 
        eAlways = 0x0, 
        eNever, 
        ePerContainer
    };

    virtual IContainerObject13::AccessType SaveAsPreviousAccessType() const = 0;
    virtual void SetSaveAsPreviousAccessType(IContainerObject13::AccessType accessType) = 0;

    virtual DisplayStatusOverride DisplayStatus() const = 0;
    virtual void SetDisplayStatus(DisplayStatusOverride displayStatus) = 0;

    virtual bool NoUpdateCheck() const = 0;
    virtual void SetNoUpdateCheck(bool noUpdateCheck) = 0;

    virtual bool UpdateOnLoad() const = 0;
    virtual void SetUpdateOnLoad(bool updateOnLoad) = 0;

    virtual bool UpdateOnReload() const = 0;
    virtual void SetUpdateOnReload(bool updateOnReload) = 0;

    virtual float StatusUpdateInterval() const = 0;
    virtual void SetStatusUpdateInterval(float statusInterval) = 0;
};

#define IID_IContainerPreferences Interface_ID(0xFA3B4E00, 0xEF1BA027)

inline IContainerPreferences* GetContainerPreferences() {
    return static_cast<IContainerPreferences*>(GetCOREInterface(IID_IContainerPreferences));
}