IGameProperty.h

Go to the documentation of this file.

/**********************************************************************
 *<
    FILE: IGameProperty.h

    DESCRIPTION: IGameProperty 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 "..\strbasic.h"
#include "..\maxtypes.h"
#include "..\BuildWarnings.h"
#include "..\iparamb2Typedefs.h"

// forward declarations
class IParamBlock;
class IParamBlock2;
class Point3;
class Point4;


enum PropType{
    IGAME_UNKNOWN_PROP, 
    IGAME_FLOAT_PROP,   
    IGAME_POINT3_PROP,  
    IGAME_INT_PROP,     
    IGAME_STRING_PROP,  
    IGAME_POINT4_PROP,  
};

class IGameControl;


class IGameProperty: public MaxHeapOperators
{

public:
    virtual ~IGameProperty() {;}


    virtual const MCHAR * GetName() =0;


    virtual bool IsPBlock2()=0;
    

    virtual bool IsPropAnimated()=0;


    virtual IGameControl * GetIGameControl() =0;


    virtual IParamBlock2 * GetMaxParamBlock2() =0;


    virtual IParamBlock * GetMaxParamBlock() =0;


    virtual bool IsParamBlock()=0;


    virtual PropType GetType() =0;


    virtual bool IsParameterSupported() = 0;

    MAX_DEPRECATED int GetParamBlockIndex();


    virtual int GetParamIndex() = 0;


    virtual ParamID GetParamID() = 0;
    


    virtual bool GetPropertyValue(float& f, TimeValue t = TIME_NegInfinity, bool p = false)=0;


    virtual bool GetPropertyValue(int &i, TimeValue t=TIME_NegInfinity)=0;
    

    virtual bool GetPropertyValue(Point3 &p, TimeValue t=TIME_NegInfinity)=0;


    virtual bool GetPropertyValue(Point4 &p, TimeValue t=TIME_NegInfinity)=0;


    virtual bool GetPropertyValue(const MCHAR*& v, TimeValue t=TIME_NegInfinity)=0;

};


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


    virtual bool Proc(IGameProperty* prop) = 0;
};


#pragma warning(push)
#pragma warning(disable:4100)
class IPropertyContainer: public MaxHeapOperators
{
public:
    virtual ~IPropertyContainer() {;}


    virtual IGameProperty * QueryProperty(DWORD PropID) {return NULL;}


    virtual int GetNumberOfProperties(){return 0;}
    

    virtual IGameProperty * GetProperty(int index) {return NULL;}


    virtual IGameProperty * QueryProperty(const MCHAR * propName) {return NULL;}


    virtual void EnumerateProperties(PropertyEnum & Enum) = 0;
};
#pragma warning(pop)


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


    virtual IPropertyContainer * GetIPropertyContainer(){return NULL;}


    virtual bool IsEntitySupported() {return false;}


    virtual MCHAR * GetClassName()=0;
};