/usr/include/libnoise/module/scalepoint.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 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 | // scalepoint.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_SCALEPOINT_H
#define NOISE_MODULE_SCALEPOINT_H
#include "modulebase.h"
namespace noise
{
namespace module
{
/// @addtogroup libnoise
/// @{
/// @addtogroup modules
/// @{
/// @addtogroup transformermodules
/// @{
/// Default scaling factor applied to the @a x coordinate for the
/// noise::module::ScalePoint noise module.
const double DEFAULT_SCALE_POINT_X = 1.0;
/// Default scaling factor applied to the @a y coordinate for the
/// noise::module::ScalePoint noise module.
const double DEFAULT_SCALE_POINT_Y = 1.0;
/// Default scaling factor applied to the @a z coordinate for the
/// noise::module::ScalePoint noise module.
const double DEFAULT_SCALE_POINT_Z = 1.0;
/// Noise module that scales the coordinates of the input value before
/// returning the output value from a source module.
///
/// @image html modulescalepoint.png
///
/// The GetValue() method multiplies the ( @a x, @a y, @a z ) coordinates
/// of the input value with a scaling factor before returning the output
/// value from the source module. To set the scaling factor, call the
/// SetScale() method. To set the scaling factor to apply to the
/// individual @a x, @a y, or @a z coordinates, call the SetXScale(),
/// SetYScale() or SetZScale() methods, respectively.
///
/// This noise module requires one source module.
class ScalePoint: public Module
{
public:
/// Constructor.
///
/// The default scaling factor applied to the @a x coordinate is set
/// to noise::module::DEFAULT_SCALE_POINT_X.
///
/// The default scaling factor applied to the @a y coordinate is set
/// to noise::module::DEFAULT_SCALE_POINT_Y.
///
/// The default scaling factor applied to the @a z coordinate is set
/// to noise::module::DEFAULT_SCALE_POINT_Z.
ScalePoint ();
virtual int GetSourceModuleCount () const
{
return 1;
}
virtual double GetValue (double x, double y, double z) const;
/// Returns the scaling factor applied to the @a x coordinate of the
/// input value.
///
/// @returns The scaling factor applied to the @a x coordinate.
double GetXScale () const
{
return m_xScale;
}
/// Returns the scaling factor applied to the @a y coordinate of the
/// input value.
///
/// @returns The scaling factor applied to the @a y coordinate.
double GetYScale () const
{
return m_yScale;
}
/// Returns the scaling factor applied to the @a z coordinate of the
/// input value.
///
/// @returns The scaling factor applied to the @a z coordinate.
double GetZScale () const
{
return m_zScale;
}
/// Sets the scaling factor to apply to the input value.
///
/// @param scale The scaling factor to apply.
///
/// The GetValue() method multiplies the ( @a x, @a y, @a z )
/// coordinates of the input value with a scaling factor before
/// returning the output value from the source module.
void SetScale (double scale)
{
m_xScale = scale;
m_yScale = scale;
m_zScale = scale;
}
/// Sets the scaling factor to apply to the ( @a x, @a y, @a z )
/// coordinates of the input value.
///
/// @param xScale The scaling factor to apply to the @a x coordinate.
/// @param yScale The scaling factor to apply to the @a y coordinate.
/// @param zScale The scaling factor to apply to the @a z coordinate.
///
/// The GetValue() method multiplies the ( @a x, @a y, @a z )
/// coordinates of the input value with a scaling factor before
/// returning the output value from the source module.
void SetScale (double xScale, double yScale, double zScale)
{
m_xScale = xScale;
m_yScale = yScale;
m_zScale = zScale;
}
/// Sets the scaling factor to apply to the @a x coordinate of the
/// input value.
///
/// @param xScale The scaling factor to apply to the @a x coordinate.
///
/// The GetValue() method multiplies the ( @a x, @a y, @a z )
/// coordinates of the input value with a scaling factor before
/// returning the output value from the source module.
void SetXScale (double xScale)
{
m_xScale = xScale;
}
/// Sets the scaling factor to apply to the @a y coordinate of the
/// input value.
///
/// @param yScale The scaling factor to apply to the @a y coordinate.
///
/// The GetValue() method multiplies the ( @a x, @a y, @a z )
/// coordinates of the input value with a scaling factor before
/// returning the output value from the source module.
void SetYScale (double yScale)
{
m_yScale = yScale;
}
/// Sets the scaling factor to apply to the @a z coordinate of the
/// input value.
///
/// @param zScale The scaling factor to apply to the @a z coordinate.
///
/// The GetValue() method multiplies the ( @a x, @a y, @a z )
/// coordinates of the input value with a scaling factor before
/// returning the output value from the source module.
void SetZScale (double zScale)
{
m_zScale = zScale;
}
protected:
/// Scaling factor applied to the @a x coordinate of the input value.
double m_xScale;
/// Scaling factor applied to the @a y coordinate of the input value.
double m_yScale;
/// Scaling factor applied to the @a z coordinate of the input value.
double m_zScale;
};
/// @}
/// @}
/// @}
}
}
#endif
|