/usr/include/libnoise/module/clamp.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 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 | // clamp.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_CLAMP_H
#define NOISE_MODULE_CLAMP_H
#include "modulebase.h"
namespace noise
{
namespace module
{
/// @addtogroup libnoise
/// @{
/// @addtogroup modules
/// @{
/// @addtogroup modifiermodules
/// @{
/// Default lower bound of the clamping range for the noise::module::Clamp
/// noise module.
const double DEFAULT_CLAMP_LOWER_BOUND = -1.0;
/// Default upper bound of the clamping range for the noise::module::Clamp
/// noise module.
const double DEFAULT_CLAMP_UPPER_BOUND = 1.0;
/// Noise module that clamps the output value from a source module to a
/// range of values.
///
/// @image html moduleclamp.png
///
/// The range of values in which to clamp the output value is called the
/// <i>clamping range</i>.
///
/// If the output value from the source module is less than the lower
/// bound of the clamping range, this noise module clamps that value to
/// the lower bound. If the output value from the source module is
/// greater than the upper bound of the clamping range, this noise module
/// clamps that value to the upper bound.
///
/// To specify the upper and lower bounds of the clamping range, call the
/// SetBounds() method.
///
/// This noise module requires one source module.
class Clamp: public Module
{
public:
/// Constructor.
///
/// The default lower bound of the clamping range is set to
/// noise::module::DEFAULT_CLAMP_LOWER_BOUND.
///
/// The default upper bound of the clamping range is set to
/// noise::module::DEFAULT_CLAMP_UPPER_BOUND.
Clamp ();
/// Returns the lower bound of the clamping range.
///
/// @returns The lower bound.
///
/// If the output value from the source module is less than the lower
/// bound of the clamping range, this noise module clamps that value
/// to the lower bound.
double GetLowerBound () const
{
return m_lowerBound;
}
virtual int GetSourceModuleCount () const
{
return 1;
}
/// Returns the upper bound of the clamping range.
///
/// @returns The upper bound.
///
/// If the output value from the source module is greater than the
/// upper bound of the clamping range, this noise module clamps that
/// value to the upper bound.
double GetUpperBound () const
{
return m_upperBound;
}
virtual double GetValue (double x, double y, double z) const;
/// Sets the lower and upper bounds of the clamping range.
///
/// @param lowerBound The lower bound.
/// @param upperBound The upper bound.
///
/// @pre The lower bound must be less than or equal to the
/// upper bound.
///
/// @throw noise::ExceptionInvalidParam An invalid parameter was
/// specified; see the preconditions for more information.
///
/// If the output value from the source module is less than the lower
/// bound of the clamping range, this noise module clamps that value
/// to the lower bound. If the output value from the source module
/// is greater than the upper bound of the clamping range, this noise
/// module clamps that value to the upper bound.
void SetBounds (double lowerBound, double upperBound);
protected:
/// Lower bound of the clamping range.
double m_lowerBound;
/// Upper bound of the clamping range.
double m_upperBound;
};
/// @}
/// @}
/// @}
}
}
#endif
|