/usr/include/libnoise/module/blend.h is in libnoise-dev 1.0.0+repack-0+nmu1.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 | // blend.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_BLEND_H
#define NOISE_MODULE_BLEND_H
#include "modulebase.h"
namespace noise
{
namespace module
{
/// @addtogroup libnoise
/// @{
/// @addtogroup modules
/// @{
/// @defgroup selectormodules Selector Modules
/// @addtogroup selectormodules
/// @{
/// Noise module that outputs a weighted blend of the output values from
/// two source modules given the output value supplied by a control module.
///
/// @image html moduleblend.png
///
/// Unlike most other noise modules, the index value assigned to a source
/// module determines its role in the blending operation:
/// - Source module 0 (upper left in the diagram) outputs one of the
/// values to blend.
/// - Source module 1 (lower left in the diagram) outputs one of the
/// values to blend.
/// - Source module 2 (bottom of the diagram) is known as the <i>control
/// module</i>. The control module determines the weight of the
/// blending operation. Negative values weigh the blend towards the
/// output value from the source module with an index value of 0.
/// Positive values weigh the blend towards the output value from the
/// source module with an index value of 1.
///
/// An application can pass the control module to the SetControlModule()
/// method instead of the SetSourceModule() method. This may make the
/// application code easier to read.
///
/// This noise module uses linear interpolation to perform the blending
/// operation.
///
/// This noise module requires three source modules.
class Blend: public Module
{
public:
/// Constructor.
Blend ();
/// Returns the control module.
///
/// @returns A reference to the control module.
///
/// @pre A control module has been added to this noise module via a
/// call to SetSourceModule() or SetControlModule().
///
/// @throw noise::ExceptionNoModule See the preconditions for more
/// information.
///
/// The control module determines the weight of the blending
/// operation. Negative values weigh the blend towards the output
/// value from the source module with an index value of 0. Positive
/// values weigh the blend towards the output value from the source
/// module with an index value of 1.
const Module& GetControlModule () const
{
if (m_pSourceModule == NULL || m_pSourceModule[2] == NULL) {
throw noise::ExceptionNoModule ();
}
return *(m_pSourceModule[2]);
}
virtual int GetSourceModuleCount () const
{
return 3;
}
virtual double GetValue (double x, double y, double z) const;
/// Sets the control module.
///
/// @param controlModule The control module.
///
/// The control module determines the weight of the blending
/// operation. Negative values weigh the blend towards the output
/// value from the source module with an index value of 0. Positive
/// values weigh the blend towards the output value from the source
/// module with an index value of 1.
///
/// This method assigns the control module an index value of 2.
/// Passing the control module to this method produces the same
/// results as passing the control module to the SetSourceModule()
/// method while assigning that noise module an index value of 2.
///
/// This control module must exist throughout the lifetime of this
/// noise module unless another control module replaces that control
/// module.
void SetControlModule (const Module& controlModule)
{
assert (m_pSourceModule != NULL);
m_pSourceModule[2] = &controlModule;
}
};
/// @}
/// @}
/// @}
}
}
#endif
|