IGameControl.h

Go to the documentation of this file.

/**********************************************************************
 *<
    FILE: IGameControl.h

    DESCRIPTION: Controller interfaces for IGame

    CREATED BY: Neil Hazzard, Discreet

    HISTORY: created 02/02/02

    IGame Version: 1.122

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

#include "..\maxheap.h"
#include "..\istdplug.h"
#include "IGameProperty.h"
#include "IConversionManager.h"
// forward declarations
class IGameNode;



enum IGameControlType{
     IGAME_POS,                     
     IGAME_ROT,                     
     IGAME_SCALE,                   
     IGAME_FLOAT,                   
     IGAME_POINT3,                  
     IGAME_TM,                      
     IGAME_EULER_X,                 
     IGAME_EULER_Y,                 
     IGAME_EULER_Z,                 
     IGAME_POINT4,                  
     IGAME_POS_X,                   
     IGAME_POS_Y,                   
     IGAME_POS_Z,                   
};




class IGameConstraint;
class GMatrix;


class IGameTCBKey: public MaxHeapOperators {
    public: 

        float tens, cont, bias, easeIn, easeOut;

        float fval;

        Point3 pval;

        Point4 p4val;

        AngAxis aval;

        ScaleValue sval;
    };


class IGameBezierKey: public MaxHeapOperators {
    public:

        float fintan, fouttan;


        float fval;

        float finLength, foutLength;


        Point3 pintan, pouttan;
        

        Point3 pval;

        Point3 pinLength, poutLength;

        Quat qval;

        ScaleValue sval;


        Point4 p4intan, p4outtan;


        Point4 p4inLength, p4outLength;


        Point4 p4val;

    };


class IGameLinearKey: public MaxHeapOperators  {
    public:

        float fval;

        Point3 pval;

        Quat qval;

        ScaleValue sval;
    };



class IGameSampleKey: public MaxHeapOperators {
    public:

        Point3 pval;

        Point4 p4val;

        float fval;

        Quat qval;

        ScaleValue sval;

        GMatrix gval;

};



class IGameKey: public MaxHeapOperators
{
    public:
        TimeValue t;
        DWORD flags;

        IGameTCBKey tcbKey;

        IGameBezierKey bezierKey;

        IGameLinearKey linearKey;


        IGameSampleKey sampleKey;
};

typedef  Tab<IGameKey> IGameKeyTab;




class IGameControl: public MaxHeapOperators
{
    public:
        enum MaxControlType{
            IGAME_UNKNOWN,                  
            IGAME_MAXSTD,                   
            IGAME_BIPED,                    
            IGAME_EULER,                    
            IGAME_ROT_CONSTRAINT,           
            IGAME_POS_CONSTRAINT,           
            IGAME_LINK_CONSTRAINT,          
            IGAME_LIST,                     
            IGAME_INDEPENDENT_POS,          
            IGAME_MASTER,                  
        };
        

        enum EulerOrder{
            XYZ,    
            XZY,    
            YZX,    
            YXZ,    
            ZXY,    
            ZYX,    
            XYX,    
            YZY,    
            ZXZ,    
            BAD     
        };
        
        virtual ~IGameControl() {;}


        virtual bool GetBezierKeys(IGameKeyTab &gameKeyTab,IGameControlType Type)=0;


        virtual bool GetLinearKeys(IGameKeyTab &gameKeyTab, IGameControlType Type)=0;


        virtual bool GetTCBKeys(IGameKeyTab &gameKeyTab, IGameControlType Type)=0;


        virtual bool GetFullSampledKeys(IGameKeyTab &sample, int frameRate, IGameControlType Type, bool Relative = true) =0;


        virtual bool GetQuickSampledKeys(IGameKeyTab &sample, IGameControlType Type) =0;



        virtual bool GetBezierIGameKey(IGameControlType Type, IGameKey &bezKey, int index) =0 ;


        virtual bool GetTCBIGameKey(IGameControlType Type, IGameKey &tcbKey, int index)=0 ;


        virtual bool GetLinearIGameKey(IGameControlType Type, IGameKey &linearKey, int index)=0;
        

        virtual int GetIGameKeyCount(IGameControlType Type)=0;


        virtual MaxControlType GetControlType(IGameControlType Type)=0;


        virtual void GetClassName (IGameControlType Type, MSTR &className)=0;


        virtual bool IsAnimated(IGameControlType Type)=0;


        virtual bool IsLeaf(IGameControlType Type)=0;


        virtual IGameConstraint * GetConstraint(IGameControlType Type)=0;
        

        virtual EulerOrder GetEulerOrder()=0;


        virtual Control * GetMaxControl(IGameControlType Type)=0;


        virtual IGameControl * GetListSubControl(int index, IGameControlType Type)=0;


        virtual int GetNumOfListSubControls(IGameControlType Type)=0;



        virtual int GetNumOfVertControls()=0;


        virtual IGameControl * GetVertexControl(int index)=0;

};


class IGameConstraint : public IExportEntity
{
        

public:

    enum ConstraintType{
        IGAME_PATH,         
        IGAME_ORIENTATION,  
        IGAME_LOOKAT,       
        IGAME_POSITION,     
        IGAME_LINK,         
        IGAME_UNKNOWN,      
    };


    virtual int NumberOfConstraintNodes()=0;


    virtual IGameNode * GetConstraintNodes(int index)=0;


    virtual float GetConstraintWeight(int nodeIndex)=0;


    virtual int GetLinkConstBeginFrame(int index) = 0;


    virtual ConstraintType GetConstraintType()=0;
    

};