scummvm/common/sinetables.h
David Fioramonti 650e26b6ab COMMON: Add at() index function to cosine/sine table
The cos/sin table class now has an at() function for indexing
safely into its internal array.

This allows the checking and computing of the correct
indexes to be done internally.

The indexing in allows cos/sine of 0 to 2pi to be
obtained.

The values returned by getTable are the same as before.

Comments that describe the values that the table
contains has been modified to line up with what
the code is doing.
2018-07-25 10:18:32 +02:00

73 lines
2.1 KiB
C++

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* 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 COMMON_SINETABLES_H
#define COMMON_SINETABLES_H
namespace Common {
class SineTable {
public:
/**
* Construct a sine table with the specified bit precision
*
* @param bitPrecision Precision of the table, which must be in range [4, 16]
*/
SineTable(int bitPrecision);
~SineTable();
/**
* Get pointer to table
*
* This table contains 2^bitPrecision/2 entries.
* Prefer to use at()
* The layout of this table is as follows:
* - Entries 0 up to (excluding) 2^bitPrecision/4:
* sin(0) till (excluding) sin(1/2*pi)
* - Entries 2^bitPrecision/4 up to 2^bitPrecision/2:
* sin(pi) till (excluding) sin(3/2*pi)
*/
const float *getTable() { return _table; }
/**
* Returns sin(2*pi * index / 2^bitPrecision )
* Index must be in range [0,2^bitPrecision-1]
*/
float at(int index) const;
/**
* Get bit precision
*/
int getBitPrecision() { return _bitPrecision; }
private:
float *_table;
int _bitPrecision;
double _radResolution; // Smallest radian increment
int _refSize; // _nPoints / 4
int _nPoints; // range of operator[]
};
} // End of namespace Common
#endif // COMMON_SINETABLES_H