ISimpleFaceDataChannel.h

Go to the documentation of this file.

//**************************************************************************/
// Copyright (c) 1998-2006 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: ISimpleFaceDataChannel.h

    DESCRIPTION: Declares a public header for a function publish interface
                 for controlling the SimpleFaceData custom attributes.
                    - interface ID
                    - FP command ID's
                    - Mixin FP interface declaration and function map

    AUTHOR: ktong - created 02.16.2006
/***************************************************************************/

#pragma once

#include "iFnPub.h"

#define SimpleFaceDataChannel_InterfaceID Interface_ID(0x1b2f01d0, 0x1c42591f)


class ISimpleFaceDataChannel : public FPMixinInterface
{
public:
    enum {
        eFpGetChannelName,  // get the channel's name
        eFpSetChannelName,  // set the channel's name
        eFpGetChannelID,    // get the identifying channel id
        eFpGetChannelType,  // get the channel's data type
        eFpGetNumFaces,     // get the number of faces in the channel
        eFpGetValue,        // get a specific face value
        eFpSetValue,        // set a specific face value
        eFpGetValues,       // get all face values
        eFpSetValues,       // set all face values
        eFpGetValueBySelection,     // get the value of a selection of faces
        eFpSetValueBySelection,     // set the value of a selection of faces

        eFpChannelTypeEnum, // the function-published channel-type enum
    };

#pragma warning(push)
#pragma warning(disable:4238)
    BEGIN_FUNCTION_MAP
        // functions exposed to Maxscript as properties
        PROP_FNS(eFpGetChannelName, GetChannelName, eFpSetChannelName, SetChannelName, TYPE_STRING);
        RO_PROP_FN(eFpGetChannelID, ChannelID, TYPE_DWORD_TAB_BV)
        RO_PROP_FN(eFpGetChannelType, ChannelType, TYPE_ENUM)
        RO_PROP_FN(eFpGetNumFaces, NumFaces, TYPE_DWORD)

        // functions exposed to Maxscript as methods
        FN_1(eFpGetValue, TYPE_FPVALUE_BV, GetValue, TYPE_INDEX)
        FN_2(eFpSetValue, TYPE_BOOL, SetValue, TYPE_INDEX, TYPE_VALUE)
        FN_0(eFpGetValues, TYPE_FPVALUE_BV, GetValues)
        FN_1(eFpSetValues, TYPE_BOOL, SetValues, TYPE_VALUE)
        FN_1(eFpGetValueBySelection, TYPE_FPVALUE_BV, GetValueBySelection, TYPE_BITARRAY)
        FN_2(eFpSetValueBySelection, TYPE_BOOL, SetValueBySelection, TYPE_BITARRAY, TYPE_VALUE)
    END_FUNCTION_MAP
#pragma warning(pop)


    virtual void        SetChannelName(const MCHAR* pName)=0;


    virtual MCHAR*      GetChannelName() =0;


    virtual Class_ID    GetChannelID()  =0;


    virtual Tab<DWORD>  ChannelID() =0;


    virtual ULONG       NumFaces() =0;


    virtual int         ChannelType() =0;


    virtual FPValue     GetValue(ULONG face) =0;


    virtual BOOL        SetValue(ULONG face, Value* pVal)=0;


    virtual FPValue     GetValues() =0;


    virtual BOOL        SetValues(Value* pVal)=0;


    virtual FPValue     GetValueBySelection(const BitArray* pFaces) =0;


    virtual BOOL        SetValueBySelection(const BitArray* pFaces, Value* pVal)=0;
};

// EOF