True Axis Physics SDK 1.2.0.1 Beta Documentation
www.trueaxis.com

---

DescriptorItemNumeric.h

//---------------------------------------------------------------------------------
// File Name: DescriptorItemNumeric.h
// Description:
//
// Copyright (C) 2004 True Axis Pty Ltd, Australia. 
// All Rights Reserved.
//
// History:
//      Created File.
//---------------------------------------------------------------------------------

#ifndef TA_DESCRIPTORITEMNUMERIC_H
#define TA_DESCRIPTORITEMNUMERIC_H

#ifndef TA_DESCRIPTORITEM_H
#include "DescriptorItem.h"
#endif // TA_DESCRIPTORITEM_H

namespace TA
{

template <class Type>
class DescriptorItemNumericOfType;

#ifndef DOXYGEN
typedef DescriptorItemNumericOfType<float> DescriptorItemNumericFloat;
typedef DescriptorItemNumericOfType<int> DescriptorItemNumericInt;
#endif // DOXYGEN

class TACOMMON_CLASS DescriptorItemNumeric : public DescriptorItem
{
public:
    DescriptorItemNumeric() : DescriptorItem() { }
    virtual ~DescriptorItemNumeric() { Finalise(); }

    void Initialise(const char* szName, const char* szDescription)
    {
        DescriptorItem::Initialise(szName, szDescription);
    }

    void Finalise()
    {
        DescriptorItem::Finalise();
    }

    virtual u32 GetTypeID() const { return s_nClassID; }
    static u32 GetStaticTypeID() { return s_nClassID; }

private:
    static u32 s_nClassID;
};

template <class Type>
class DescriptorItemNumericOfType : public DescriptorItemNumeric
{
public:
    enum { INVALID_DATA_OFFSET = 0xFFFFFFFF };
    DescriptorItemNumericOfType() : DescriptorItemNumeric() 
    { 
        m_nDataOffset = INVALID_DATA_OFFSET;
        m_pSetValueCallBack = 0;
        m_pGetValueCallBack = 0;
        m_defaultValue = 0;
        m_minValue = 0;
        m_maxValue = 0;
    }

    virtual ~DescriptorItemNumericOfType() { Finalise(); }

    void Initialise(
        const Char* szName,
        Descriptor* pDescriptor,
        Type& var,
        Type defaultValue,
        Type min,
        Type max,
        const Char* szDescription)
    {
        Initialise(
            szName,
            0,
            0,
            defaultValue,
            min,
            max,
            szDescription);
        m_nDataOffset = (u32)&var - (u32)pDescriptor;
    }

    void Initialise(
        const Char* szName,
        void (*SetVar)(Type, void* pData),
        Type (*GetVar)(void* pData),
        Type defaultValue,
        Type min,
        Type max,
        const Char* szDescription)
    {
        DescriptorItemNumeric::Initialise(szName, szDescription);
        m_defaultValue = defaultValue;
        m_minValue = min;
        m_maxValue = max;

        m_pSetValueCallBack = SetVar;
        m_pGetValueCallBack = GetVar;
    }

    void Finalise()
    {
        DescriptorItemNumeric::Finalise();
        m_nDataOffset = INVALID_DATA_OFFSET;
        m_pSetValueCallBack = 0;
        m_pGetValueCallBack = 0;
        m_defaultValue = 0;
        m_minValue = 0;
        m_maxValue = 0;
    }
    
    virtual String GetValueAsString(Descriptor* pDescriptor) const
    { 
        return String(GetValue(pDescriptor)); 
    }
    virtual String GetDisplayString(Descriptor* pDescriptor) const 
    { 
        String strDisplayString = GetName();
        strDisplayString += ": ";       
        strDisplayString += GetValue(pDescriptor);
        return strDisplayString;
    }
    virtual void SetValueFromString(const char* szString, Descriptor* pDescriptor)
    {
        SetValue((Type)atof(szString), pDescriptor);
    }
    virtual void SetToDefaultValue(Descriptor* pDescriptor) { SetValue(m_defaultValue, pDescriptor); }  

private:
    u32 m_nDataOffset;
    Type m_defaultValue;
    Type m_minValue;
    Type m_maxValue;
    void (*m_pSetValueCallBack)(Type, void* pData);
    Type (*m_pGetValueCallBack)(void* pData);
    
    Type& GetValueRef(Descriptor* pDescriptor) const
    { 
        return *(Type*)((u32)pDescriptor + m_nDataOffset);
    }

    void SetValue(Type value, Descriptor* pDescriptor)
    {
        if (m_nDataOffset != INVALID_DATA_OFFSET)
            GetValueRef(pDescriptor) = value;
        else if (m_pSetValueCallBack)
            m_pSetValueCallBack(value, pDescriptor);
    }
    Type GetValue(Descriptor* pDescriptor) const
    {
        if (m_nDataOffset != INVALID_DATA_OFFSET)
            return GetValueRef(pDescriptor);
        else if (m_pGetValueCallBack)
            return m_pGetValueCallBack(pDescriptor);
        else
            return Type(0);
    }
};

}

#include "DescriptorItemNumeric.inl"


#endif // TA_DESCRIPTORITEMNUMERIC_H

---

© Copyright 2004-2006 TRUE AXIS PTY LTD Australia. All rights reserved.