src/tools/tFunction.h

Go to the documentation of this file.

/*

*************************************************************************

ArmageTron -- Just another Tron Lightcycle Game in 3D.
Copyright (C) 2000  Manuel Moos (manuel@moosnet.de)

**************************************************************************

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  
***************************************************************************

*/

#ifndef ArmageTron_tFunction_H
#define ArmageTron_tFunction_H

#include "defs.h"
#include "tError.h"

class tFunction
{
public:
    tFunction();  
    tFunction(REAL offset, REAL slope);  
    ~tFunction(); 

    REAL Evaluate( REAL argument ) const; 
    inline REAL operator()( REAL argument ) const; 

    // function parameters: currently limited to offset_ + slope_ * argument
    REAL offset_; 
    REAL slope_;  

public:
    inline tFunction & SetOffset( REAL const & offset );        
    inline REAL const & GetOffset( void ) const;        
    inline tFunction const & GetOffset( REAL & offset ) const;  
    inline tFunction & SetSlope( REAL const & slope );  
    inline REAL const & GetSlope( void ) const; 
    inline tFunction const & GetSlope( REAL & slope ) const;    
protected:
private:
};

//These templates are probably only useable with nMessage as parameter.
//The reason they're templates is that nMessage isn't available in src/tools
//and that tFunction might be needed to be in src/tools in the future.
//Imagine a constructor for vValue that converts from a tFunction as an
//example (or the other way, as far as possible). --wrtlprnft

template<typename T> T & operator << ( T & m, tFunction const & f ); 
template<typename T> T & operator >> ( T & m, tFunction & f );       

// *******************************************************************************
// *
// *    operator ( )
// *
// *******************************************************************************
// *******************************************************************************

REAL tFunction::operator ( )( REAL argument ) const
{
    return Evaluate( argument );
}

// *******************************************************************************
// *
// *    GetOffset
// *
// *******************************************************************************
// *******************************************************************************

REAL const & tFunction::GetOffset( void ) const
{
    return this->offset_;
}

// *******************************************************************************
// *
// *    GetOffset
// *
// *******************************************************************************
// *******************************************************************************

tFunction const & tFunction::GetOffset( REAL & offset ) const
{
    offset = this->offset_;
    return *this;
}

// *******************************************************************************
// *
// *    SetOffset
// *
// *******************************************************************************
// *******************************************************************************

tFunction & tFunction::SetOffset( REAL const & offset )
{
    this->offset_ = offset;
    return *this;
}

// *******************************************************************************
// *
// *    GetSlope
// *
// *******************************************************************************
// *******************************************************************************

REAL const & tFunction::GetSlope( void ) const
{
    return this->slope_;
}

// *******************************************************************************
// *
// *    GetSlope
// *
// *******************************************************************************
// *******************************************************************************

tFunction const & tFunction::GetSlope( REAL & slope ) const
{
    slope = this->slope_;
    return *this;
}

// *******************************************************************************
// *
// *    SetSlope
// *
// *******************************************************************************
// *******************************************************************************

tFunction & tFunction::SetSlope( REAL const & slope )
{
    this->slope_ = slope;
    return *this;
}

// *******************************************************************************
// *
// *    operator <<
// *
// *******************************************************************************
// *******************************************************************************

template<typename T> T & operator << ( T & m, tFunction const & f )
{
    // write ID for compatibility with future extensions
    unsigned short ID = 1;
    m.Write( ID );

    // write values
    m << f.GetOffset();
    m << f.GetSlope();

    return m;
}

// *******************************************************************************
// *
// *    operator >>
// *
// *******************************************************************************
// *******************************************************************************

template<typename T> T & operator >> ( T & m, tFunction & f )
{
    // write ID for compatibility with future extensions
    unsigned short ID;
    m.Read(ID);
    tASSERT( ID == 1 );

    // read values
    REAL slope, offset;
    m >> offset >> slope;

    // store values
    f.SetOffset( offset ).SetSlope( slope );

    return m;
}

#endif

---