/usr/include/libnoise/module/cylinders.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 122 123 124 125 126 127 128 129 | // cylinders.h
//
// Copyright (C) 2003, 2004 Jason Bevins
//
// 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 jlbezigvins@gmzigail.com (for great email, take
// off every 'zig'.)
//
#ifndef NOISE_MODULE_CYLINDERS_H
#define NOISE_MODULE_CYLINDERS_H
#include "modulebase.h"
namespace noise
{
namespace module
{
/// @addtogroup libnoise
/// @{
/// @addtogroup modules
/// @{
/// @addtogroup generatormodules
/// @{
/// Default frequency value for the noise::module::Cylinders noise module.
const double DEFAULT_CYLINDERS_FREQUENCY = 1.0;
/// Noise module that outputs concentric cylinders.
///
/// @image html modulecylinders.png
///
/// This noise module outputs concentric cylinders centered on the origin.
/// These cylinders are oriented along the @a y axis similar to the
/// concentric rings of a tree. Each cylinder extends infinitely along
/// the @a y axis.
///
/// The first cylinder has a radius of 1.0. Each subsequent cylinder has
/// a radius that is 1.0 unit larger than the previous cylinder.
///
/// The output value from this noise module is determined by the distance
/// between the input value and the the nearest cylinder surface. The
/// input values that are located on a cylinder surface are given the
/// output value 1.0 and the input values that are equidistant from two
/// cylinder surfaces are given the output value -1.0.
///
/// An application can change the frequency of the concentric cylinders.
/// Increasing the frequency reduces the distances between cylinders. To
/// specify the frequency, call the SetFrequency() method.
///
/// This noise module, modified with some low-frequency, low-power
/// turbulence, is useful for generating wood-like textures.
///
/// This noise module does not require any source modules.
class Cylinders: public Module
{
public:
/// Constructor.
///
/// The default frequency is set to
/// noise::module::DEFAULT_CYLINDERS_FREQUENCY.
Cylinders ();
/// Returns the frequency of the concentric cylinders.
///
/// @returns The frequency of the concentric cylinders.
///
/// Increasing the frequency increases the density of the concentric
/// cylinders, reducing the distances between them.
double GetFrequency () const
{
return m_frequency;
}
virtual int GetSourceModuleCount () const
{
return 0;
}
virtual double GetValue (double x, double y, double z) const;
/// Sets the frequenct of the concentric cylinders.
///
/// @param frequency The frequency of the concentric cylinders.
///
/// Increasing the frequency increases the density of the concentric
/// cylinders, reducing the distances between them.
void SetFrequency (double frequency)
{
m_frequency = frequency;
}
protected:
/// Frequency of the concentric cylinders.
double m_frequency;
};
/// @}
/// @}
/// @}
}
}
#endif
|