IMetaData.h

Go to the documentation of this file.

//**************************************************************************/
// Copyright (c) 1998-2007 Autodesk, Inc.
// All rights reserved.
// 
// These coded instructions, statements, and computer programs contain
// unpublished proprietary information written by Autodesk, Inc., and are
// protected by Federal copyright law. They may not be disclosed to third
// parties or copied or duplicated in any form, in whole or in part, without
// the prior written consent of Autodesk, Inc.
/**************************************************************************
    FILE: IMetaData.h

    DESCRIPTION: Declares a public header for a function publish interface
        for creating and managing meta-data.
                    - interface ID
                    - FP command ID's
                    - Static FP interface declaration

    AUTHOR: leonarni - created 29-AUG-2007
/***************************************************************************/

#pragma once

#include "iFnPub.h"
#include "iparamb2.h"       // PB2Value
#include "GetCOREInterface.h"
// forward declarations
class CustAttrib;

#define IID_METADA_MANAGER Interface_ID(0xdcdd1738, 0x15ee4791)


class IMetaDataManager : public FPStaticInterface 
{
public:

    typedef Class_ID MetaDataID;

    enum ControlAlign
    {
        eAlignLeft,
        eAlignCenter,
        eAlignRight
    };
    

    struct ParamDescriptor
    {
        ParamDescriptor():
            m_name(NULL),
            m_ctrlLabel(NULL),
            m_dataType(TYPE_STRING),
            m_ctrlType(TYPE_EDITBOX),
            m_width(-1),
            m_height(-1),
            m_offset(0, 0),
            m_ctrlAlign(eAlignCenter),
            m_sliderHorizontal(true),
            m_sliderTicks(0),
            m_labelOnTop(false),
            m_highlightColor(0.99f, 0.86f, 0.03f)
        {
        }

        MCHAR*      m_name;         // parameter name
        ParamType2  m_dataType;     // parameter data type
        PB2Value    m_defValue;     // default value

        // unused for now
        ULONGLONG   m_flags;        // per-parameter constructor flags (P_ANIMATABLE, P_TRANSIENT, etc.)

        // Optional fields (for integer or float parameters)
        PB2Value    m_rangeLow;     // low range value
        PB2Value    m_rangeHigh;    // high range value

        // UI
        ControlType2 m_ctrlType;    // Type of UI control
        MCHAR*      m_ctrlLabel;    // Control label
        int         m_width;
        int         m_height;
        IPoint2     m_offset;       // x and y offset in pixels, for fine-tuning control placement
        ControlAlign m_ctrlAlign;   

        bool        m_sliderHorizontal; // If not, vertical.
        int         m_sliderTicks;      // The number of ticks drawn along the slider
        bool        m_labelOnTop;       // For editboxes
        Color       m_highlightColor;   // For checkbutton booleans; color components between 0.0f and 1.0f
    };


    virtual MetaDataID CreateMetaDataDefinition
        (
            MCHAR*          in_custAttribSetName,
            MCHAR*          in_rollOutName,
            const Tab<ParamDescriptor>& in_paramDefs,
            MSTR*           out_errMsg = NULL
        ) = 0;


    virtual CustAttrib* AddMetaDataToAnimatable
        (
            const MetaDataID&   in_metaDataID,  
            Animatable&         in_animatable,
            int                 in_rank = -1            // default -1 means append
        ) = 0;


    virtual void AddMetaDataToAnimatables
        (
            const MetaDataID&       in_metaDataID,  
            const Tab<Animatable*>& in_animatables,
            Tab<CustAttrib*>&       out_metaData,
            bool    in_shared = false,
            int     in_rank = -1            // default -1 means append
        ) = 0;


    virtual bool RemoveMetaDataFromAnimatable
        (
            const MetaDataID&   in_metaDataID,  
            Animatable& in_animatable
        ) = 0;

    virtual int MetaDataCount() const = 0;


    virtual void GetAllMetaDataOwners(const MetaDataID& in_ID, Tab<Animatable*>& out_owners) = 0;


    virtual bool IsMetaDataDefined(const MetaDataID& in_ID) const = 0 ;


    virtual CustAttrib* GetMetaData(Animatable& in_animatable, const MetaDataID& in_ID) const = 0;


    virtual void GetAllMetaData(Animatable& in_animatable, Tab<CustAttrib*>& out_metaData) const = 0;

    static IMetaDataManager* GetInstance() {
        return static_cast<IMetaDataManager*>(GetCOREInterface(IID_METADA_MANAGER)); 
    }
};

static const IMetaDataManager::MetaDataID& EmptyMetaDataID = Class_ID(0x00000000, 0x00000000);


// EOF