/usr/include/libnoise/model/plane.h is in libnoise-dev 1.0.0+repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 | // plane.h
//
// Copyright (C) 2004 Owen Jacobson
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation; either version 2.1 of the License, or (at
// your option) any later version.
//
// This library 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 Lesser General Public
// License (COPYING.txt) for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the Free Software Foundation,
// Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
// The developer's email is ojacobson@lionsanctuary.net
//
#ifndef NOISE_MODEL_PLANE_H
#define NOISE_MODEL_PLANE_H
#include <assert.h>
#include "../module/modulebase.h"
namespace noise
{
namespace model
{
/// @addtogroup libnoise
/// @{
/// @addtogroup models
/// @{
/// Model that defines the surface of a plane.
///
/// This model returns an output value from a noise module given the
/// coordinates of an input value located on the surface of an ( @a x,
/// @a z ) plane.
///
/// To generate an output value, pass the ( @a x, @a z ) coordinates of
/// an input value to the GetValue() method.
///
/// This model is useful for creating:
/// - two-dimensional textures
/// - terrain height maps for local areas
///
/// This plane extends infinitely in both directions.
class Plane
{
public:
/// Constructor.
Plane ();
/// Constructor
///
/// @param module The noise module that is used to generate the output
/// values.
Plane (const module::Module& module);
/// Returns the noise module that is used to generate the output
/// values.
///
/// @returns A reference to the noise module.
///
/// @pre A noise module was passed to the SetModule() method.
const module::Module& GetModule () const
{
assert (m_pModule != NULL);
return *m_pModule;
}
/// Returns the output value from the noise module given the
/// ( @a x, @a z ) coordinates of the specified input value located
/// on the surface of the plane.
///
/// @param x The @a x coordinate of the input value.
/// @param z The @a z coordinate of the input value.
///
/// @returns The output value from the noise module.
///
/// @pre A noise module was passed to the SetModule() method.
///
/// This output value is generated by the noise module passed to the
/// SetModule() method.
double GetValue (double x, double z) const;
/// Sets the noise module that is used to generate the output values.
///
/// @param module The noise module that is used to generate the output
/// values.
///
/// This noise module must exist for the lifetime of this object,
/// until you pass a new noise module to this method.
void SetModule (const module::Module& module)
{
m_pModule = &module;
}
private:
/// A pointer to the noise module used to generate the output values.
const module::Module* m_pModule;
};
/// @}
/// @}
}
}
#endif
|