Biped8Api.h

Go to the documentation of this file.

/*********************************************************************
 *<
    FILE: Biped8Api.h

    DESCRIPTION: These are functions that are exported in biped.dlc, updated for Max 8

    CREATED BY: Susan Amkraut

    HISTORY: Created 18 January 2005

 *> Copyright (c) 2005 All Rights Reserved.
 **********************************************************************/

#pragma once

#include "..\maxheap.h"
#include "BipedApi.h"
#include "IMixer8.h"

#define I_BIPMASTER8    0x9167    //!< Biped interface identifier
#define GetBipMaster8Interface(anim) ((IBipMaster8*)(anim)->GetInterface(I_BIPMASTER8)) //!< Gets the Biped interface


#define SNAP_VIEW       0    //!< Snapshot of the active viewport
#define SNAP_AUTO       1    //!< Snapshot camera position computed automatically to make a close up of the copied parts
#define SNAP_NONE       2    //!< No Snapshot


#define PST_DEF         0    //!< Paste the default TCB / IK values
#define PST_COPY        1    //!< Paste the TCB / IK values which were stored in the copy
#define PST_INTERP      2    //!< Paste an interpolation of the surrounding TCB / IK values


#define BMODE_TWISTLINKS    (1<<12)    //!< Twist Links Mode
#define BMODE_TWISTIND      (1<<13)    //!< Twist Individual Mode
#define BMODE_SMOOTHTWIST   (1<<14)    //!< Smooth Twist Mode
#define BMODE_ALL           (BMODE_FIGURE|BMODE_FOOTSTEP|BMODE_MOTIONFLOW| \
                             BMODE_BUFFER|BMODE_RUBBERBAND| \
                             BMODE_BENDLINKS|BMODE_TWISTLINKS|BMODE_TWISTIND|BMODE_SMOOTHTWIST \
                             BMODE_SCALESTRIDE|BMODE_INPLACE|BMODE_MIXER|BMODE_MOVEALL)    //!< All Modes


class IBipMaster8;


class IBipedCopy: public MaxHeapOperators
{
  public:
    virtual ~IBipedCopy() {;}

    virtual const MCHAR *GetName() const = 0;

    virtual bool SetName(const MCHAR *name) = 0;

    virtual int GetCopyType() const = 0;
};


class ICopyCollection: public MaxHeapOperators
{
  public:
    virtual ~ICopyCollection() {;}

    virtual const MCHAR *GetName() const = 0;

    virtual bool SetName(const MCHAR *name) = 0;

    virtual int NumCopies(int copyType) = 0;

    virtual IBipedCopy *GetCopy(int copyType, int index) = 0;

    virtual IBipedCopy *GetCopy(int copyType, const MCHAR *name, int *index) = 0;

    virtual bool DeleteCopy(int copyType, int index) = 0;

    virtual void DeleteAllCopies(int copyType) = 0;
};


class IBipMaster8: public IBipMaster 
{
    public:

        virtual void    RefreshBipedUI() = 0;

        /************ Quaternion / Euler Track Specification **************/




        virtual bool GetEulerActive(const int id) = 0;

        virtual int  GetEulerOrder(const int id) = 0;

        virtual bool SetEulerActive(int id, int eulerOrder) = 0;

        virtual bool SetQuaternionActive(int id) = 0;
        
        virtual bool SetEulerOrder(int id, int eulerOrder) = 0;

        /************ Center of Mass Selection ***************/



        virtual bool    IsComLocked()=0;

        virtual void    LockCom(bool lock)=0;

        /************ Functions to Manipulate Twist Bones ***************/



        virtual bool    GetTwist() const =0;
        
        virtual void    SetTwist(bool enable)=0;
        
        virtual float   GetTwistBias(int twisttrack) const =0;
            
        virtual void    SetTwistBias(int twisttrack, float bias)=0;

        /************ Functions to Manipulate Twist Poses ***************/




        virtual int  NumTwistPoses(int keytrack)=0;

        virtual bool CreateTwistPose(int keytrack)=0;

        virtual bool SetTwistPose(int keytrack, int index)=0;

        virtual bool DeleteTwistPose(int keytrack, int index)=0;

        virtual void SetDefaultTwistPoses(int keytrack)=0;

        virtual bool SetTwistPoseName(int keytrack, int index, const MCHAR *name)=0;

        virtual bool SetTwistPoseTwist(int keytrack, int index, float twist)=0;

        virtual bool SetTwistPoseBias(int keytrack, int index, float bias)=0;

        virtual const MCHAR *GetTwistPoseName(int keytrack, int index)=0;

        virtual float GetTwistPoseTwist(int keytrack, int index)=0;

        virtual float GetTwistPoseBias(int keytrack, int index)=0;

        virtual void SetLimbToTwistPose(int keytrack, int index, bool opposite)=0;

        virtual int     LoadFigNoTwists     (const MCHAR *fname, BOOL redraw = false, BOOL msgs = false)=0; 

        virtual int     LoadFigJustTwists   (const MCHAR *fname, BOOL redraw = false, BOOL msgs = false)=0; 

        /************ Bend Links Menu Functions, for rotations of spine, neck, tail, and pony tail links ***************/



        virtual void    ZeroTwist(int keytrack)=0;

        virtual void    ZeroAll(int keytrack)=0;

        virtual void    SmoothTwist(int keytrack, float bias)=0;

        /************ Copy/Paste Functions which work with Copy Collections ***************/



        virtual int NumCopyCollections() const = 0;

        virtual ICopyCollection *GetCopyCollection(int index) const = 0;

        virtual ICopyCollection *GetCopyCollection(const MCHAR *name, int *index) const = 0;

        virtual ICopyCollection *CreateCopyCollection(const MCHAR *colname) = 0;

        virtual bool DeleteCopyCollection(int index) = 0;

        virtual void DeleteAllCopyCollections() = 0;

        virtual IBipedCopy *CopyBipPosture(ICopyCollection *ICC, INodeTab *nodes, int snapshottype) = 0;

        virtual IBipedCopy *CopyBipPose(ICopyCollection *ICC, int snapshottype) = 0;
        
        virtual IBipedCopy *CopyBipTrack(ICopyCollection *ICC, INodeTab *nodes, int snapshottype) = 0;
        
        virtual bool PasteBipPosture(IBipedCopy *CP, bool opposite, int KeyPasteType, bool Hor, bool Ver, bool Trn, bool ByVel) = 0;
                
        virtual bool PasteBipPose(IBipedCopy *CP, bool opposite, int KeyPasteType, bool Hor, bool Ver, bool Trn, bool ByVel) = 0;
                
        virtual bool PasteBipTrack(IBipedCopy *CP, bool opposite, bool Hor, bool Ver, bool Trn) = 0;



        virtual IMixer8 * GetMixer8() =0;
};