IContainerObject.h

Go to the documentation of this file.

//*****************************************************************************
// Copyright 2010 Autodesk, Inc.  All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license agreement
// provided at the time of installation or download, or which otherwise accompanies 
// this software in either electronic or hard copy form.   
//
//*****************************************************************************
//
//  FILE: IContainerObject.h
//  DESCRIPTION: Describes the container object interface 
//  CREATED BY: Nicolas Leonard
//
//  HISTORY:    July 9th, 2008  Creation
//*****************************************************************************

#pragma once

#include "iFnPub.h"
#include "AssetManagement\iassetmanager.h"
#include "Animatable.h"
// forward declarations
class INodeTab;


//  Container ClassIDs and Interface IDs   

#define CONTAINER_CLASS_ID  Class_ID(0x6E34B493, 0xE3C48E41)

#define IID_CONTAINER Interface_ID(0xB314E0F8, 0x4B104959)
#define IID_CONTAINER13 Interface_ID(0x6f9826aa, 0x75a12aa6)




class IContainerObject: public FPMixinInterface
{
public:



    FPInterfaceDesc* GetDesc(); 


    virtual INode*      GetContainerNode() const = 0;




    virtual void        GetContentNodes(bool nestedContainerNodes, INodeTab& contentNodes) const = 0;
    virtual bool        IsNodeInContent(INode* in_node, bool nestedContainerNodes) const = 0;
    virtual bool        IsNodeInInheritedContent(INode* in_node, bool nestedContainerNodes) const = 0;




    virtual bool        AddNodeToContent(INode* in_node) = 0;           
    virtual bool        AddNodesToContent(INodeTab& in_nodeTab) = 0;





    virtual bool        RemoveNodeFromContent(INode* in_node, bool detach = true) = 0;



    virtual MaxSDK::AssetManagement::AssetUser  GetLocalDefinitionFileName() const = 0;
    virtual bool        SetLocalDefinitionFileName(const MaxSDK::AssetManagement::AssetUser &val) = 0;

    virtual MaxSDK::AssetManagement::AssetUser  GetSourceDefinitionFileName() const = 0;
    virtual bool        SetSourceDefinitionFileName(const MaxSDK::AssetManagement::AssetUser &val) = 0;





    virtual bool        SaveContainer(bool newFileName = false) = 0;
    virtual bool        UpdateContainer() = 0;
    virtual bool        UnloadContainer() = 0;
    virtual bool        LoadContainer() = 0;
    virtual bool        ReloadContainer() = 0;
    virtual bool        MergeSource() = 0;
    virtual bool        MakeUnique() = 0;



    virtual bool        IsInherited() const = 0;

    virtual bool        IsOpen() const = 0;

    virtual bool        SetOpen(bool isOpen) = 0;

    virtual bool        IsContainerOpenableOrClosable() const = 0;

    virtual bool        IsUnloaded() const = 0;

    virtual bool        IsUnique() const = 0;



    virtual void        AllowInPlaceEdit(bool allowEdit) = 0;
    virtual bool        GetAllowInPlaceEdit() const = 0;

    virtual void        SetEditInPlace(bool edit) = 0;
    virtual bool        IsInPlaceEditing() const = 0;

    virtual bool        CanEditInPlace() const = 0;


    virtual void        SetAutoUpdateClosed(bool setAutoUpdate) = 0;
    virtual bool        AutoUpdateClosed() const = 0;



    virtual void        SetLabelDisplay(bool display) = 0;
    virtual bool        GetLabelDisplay() const = 0;

    virtual void        UseContentBoundingBox(bool useContent) = 0;
    virtual bool        IsUsingContentBoundingBox() const = 0;

    virtual void        SetOverrideNodeProperties(bool setOverride) = 0;
    virtual bool        OverrideNodeProperties() const = 0;

    virtual void        SetSize(float size, TimeValue t = 0) = 0;
    virtual float       GetSize(TimeValue t = 0) const = 0;


    static inline IContainerObject* GetInterface(Animatable* anim) { 
        return anim? static_cast<IContainerObject*>(anim->GetInterface(IID_CONTAINER)): NULL;}
};



class IContainerObject13  : public IContainerObject
{
public:

    enum 
        AccessType{ 
            eNoAccess = 0x0, 
            eOnlyEditInPlace , 
            eOnlyAddNewObjects,  
            eAnythingUnlocked};
    
    enum LockedContents {
        eLockAllMaterials =0x1, 
        eLockAllModifiers = 0x2 , 
        eLockAllTransforms =0x4, 
        eLockAllObjects= 0x8};

    enum ProxyType {
        PROXYTYPE_NONE,
        PROXYTYPE_ALTERNATE
    };





    virtual void SetAccessType(AccessType accessType) =0;

    virtual AccessType GetAccessType() const = 0;

    virtual AccessType InheritedAccessType() const = 0;






    virtual void SetLockedContents(LockedContents content, bool clear) =0;

    virtual void ClearLockedContents() =0;

    virtual bool IsLockedContents(LockedContents content)const =0;

    virtual bool SaveContainerAsVersion(bool newFileName, unsigned long saveAsVersion) = 0;

    virtual MCHAR*      GetStatusString() = 0;

    virtual void        SetStatusDisplay(bool status) = 0;
    virtual bool        GetStatusDisplay() const = 0;

    virtual const MCHAR* GetEditingUser() const = 0;

    virtual bool        IsUpdateNeeded() const = 0;



    virtual ProxyType   GetProxyType() const = 0;
    virtual void        SetProxyType(ProxyType type) = 0;

    virtual int         GetAlternateDefinitionCount() const = 0;
    virtual MaxSDK::AssetManagement::AssetUser  GetAlternateDefinition(int defIndex) const = 0;
    virtual bool        SetAlternateDefinition(int defIndex, const MaxSDK::AssetManagement::AssetUser &val) = 0;
    // Appending an alternate definition does not set the current alternate to the added asset
    virtual bool        AppendAlternateDefinition(const MaxSDK::AssetManagement::AssetUser &val) = 0;
    virtual bool        RemoveAlternateDefinition(int defIndex) = 0;

    virtual int         GetCurrentAlternateDefinitionIndex() const = 0;
    virtual void        SetCurrentAlternateDefinitionIndex(int defIndex) = 0;
    virtual MaxSDK::AssetManagement::AssetUser  GetCurrentAlternateDefinition() const = 0;

    virtual bool        IsInheritedClosed() const = 0;

    static inline IContainerObject13* GetInterface(Animatable* anim) { 
        return anim? static_cast<IContainerObject13*>(anim->GetInterface(IID_CONTAINER13)): NULL;}
};