openscenegraph
BoundsChecking
Go to the documentation of this file.
1/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
2 *
3 * This library is open source and may be redistributed and/or modified under
4 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
5 * (at your option) any later version. The full license is in LICENSE file
6 * included with this distribution, and on the openscenegraph.org website.
7 *
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * OpenSceneGraph Public License for more details.
12*/
13
14#ifndef OSG_BOUNDSCHECKING
15#define OSG_BOUNDSCHECKING 1
16
17#include <osg/Notify>
18
19namespace osg {
20
21
25template <typename T>
26inline void clampGEQUAL(T& value,const T minValue,const char* valueName)
27{
28 if (value<minValue)
29 {
30 notify(WARN) << "Warning: "<<valueName<<" of "<<value<<" is below permitted minimum, clamping to "<<minValue<<"."<< std::endl;
31 value = minValue;
32 }
33}
34
38template <typename T>
39inline void clampLEQUAL(T& value,const T maxValue,const char* valueName)
40{
41 if (value>maxValue)
42 {
43 notify(WARN) << "Warning: "<<valueName<<" of "<<value<<" is above permitted maximum, clamping to "<<maxValue<<"."<< std::endl;
44 value = maxValue;
45 }
46}
47
53template <typename T>
54inline void clampBetweenRange(T& value,const T minValue,const T maxValue,const char* valueName)
55{
56 if (value<minValue)
57 {
58 notify(WARN) << "Warning: "<<valueName<<" of "<<value<<" is below permitted minimum, clamping to "<<minValue<<"."<< std::endl;
59 value = minValue;
60 }
61 else
62 if (value>maxValue)
63 {
64 notify(WARN) << "Warning: "<<valueName<<" of "<<value<<" is above permitted maximum, clamping to "<<maxValue<<"."<< std::endl;
65 value = maxValue;
66 }
67
68}
69
73template <typename A, typename T>
74inline void clampArrayElementGEQUAL(A& value,unsigned int i,const T minValue,const char* valueName)
75{
76 if (value[i]<minValue)
77 {
78 notify(WARN) << "Warning: "<<valueName<<"["<<i<<"] of "<<value[i]<<" is below permitted minimum, clamping to "<<minValue<<"."<< std::endl;
79 value[i] = minValue;
80 }
81}
82
86template <typename A, typename T>
87inline void clampArrayElementLEQUAL(A& value,unsigned int i,const T maxValue,const char* valueName)
88{
89 if (value[i]>maxValue)
90 {
91 notify(WARN) << "Warning: "<<valueName<<"["<<i<<"] of "<<value[i]<<" is above permitted maximum, clamping to "<<maxValue<<"."<< std::endl;
92 value = maxValue;
93 }
94}
95
101template <typename A, typename T>
102inline void clampArrayElementBetweenRange(A& value,unsigned int i,const T minValue,const T maxValue,const char* valueName)
103{
104 if (value[i]<minValue)
105 {
106 notify(WARN) << "Warning: "<<valueName<<"["<<i<<"] of "<<value[i]<<" is below permitted minimum, clamping to "<<minValue<<"."<< std::endl;
107 value[i] = minValue;
108 }
109 else
110 if (value[i]>maxValue)
111 {
112 notify(WARN) << "Warning: "<<valueName<<"["<<i<<"] of "<<value[i]<<" is above permitted maximum, clamping to "<<maxValue<<"."<< std::endl;
113 value[i] = maxValue;
114 }
115
116}
117
121template <typename A, typename T>
122inline void clampArrayElementsGEQUAL(A& value,unsigned int first,unsigned int last,const T minValue,const char* valueName)
123{
124 for(unsigned int i=first;i<=last;++i)
125 clampArrayElementGEQUAL(value,i,minValue,valueName);
126}
127
131template <typename A, typename T>
132inline void clampArrayElementsLEQUAL(A& value,unsigned int first,unsigned int last,const T maxValue,const char* valueName)
133{
134 for(unsigned int i=first;i<=last;++i)
135 clampArrayElementLEQUAL(value,i,maxValue,valueName);
136}
137
144template <typename A, typename T>
145inline void clampArrayElementsBetweenRange(A& value,unsigned int first,unsigned int last,const T minValue,const T maxValue,const char* valueName)
146{
147 for(unsigned int i=first;i<=last;++i)
148 clampArrayElementBetweenRange(value,i,minValue,maxValue,valueName);
149}
150
151
155template <typename A, typename T>
156inline void clampArray3GEQUAL(A& value,const T minValue,const char* valueName)
157{
158 clampArrayElementsGEQUAL(value,0u,2u,minValue,valueName);
159}
160
164template <typename A, typename T>
165inline void clampArray3LEQUAL(A& value,const T maxValue,const char* valueName)
166{
167 clampArrayElementsLEQUAL(value,0u,2u,maxValue,valueName);
168}
169
176template <typename A, typename T>
177inline void clampArray3BetweenRange(A& value,const T minValue,const T maxValue,const char* valueName)
178{
179 clampArrayElementsBetweenRange(value,0u,2u,minValue,maxValue,valueName);
180}
181
182
183
187template <typename A, typename T>
188inline void clampArray4GEQUAL(A& value,const T minValue,const char* valueName)
189{
190 clampArrayElementsGEQUAL(value,0u,3u,minValue,valueName);
191}
192
196template <typename A, typename T>
197inline void clampArray4LEQUAL(A& value,const T maxValue,const char* valueName)
198{
199 clampArrayElementsLEQUAL(value,0u,3u,maxValue,valueName);
200}
201
208template <typename A, typename T>
209inline void clampArray4BetweenRange(A& value,const T minValue,const T maxValue,const char* valueName)
210{
211 clampArrayElementsBetweenRange(value,0u,3u,minValue,maxValue,valueName);
212}
213
214}
215
216#endif
author: Julien Valentin 2017 (mp3butcher@hotmail.com)
Definition AlphaFunc:19
void clampArrayElementGEQUAL(A &value, unsigned int i, const T minValue, const char *valueName)
Definition BoundsChecking:74
void clampArray4GEQUAL(A &value, const T minValue, const char *valueName)
Definition BoundsChecking:188
@ WARN
Definition Notify:33
void clampArray3GEQUAL(A &value, const T minValue, const char *valueName)
Definition BoundsChecking:156
void clampArrayElementBetweenRange(A &value, unsigned int i, const T minValue, const T maxValue, const char *valueName)
Definition BoundsChecking:102
void clampArrayElementsBetweenRange(A &value, unsigned int first, unsigned int last, const T minValue, const T maxValue, const char *valueName)
Definition BoundsChecking:145
void clampArray3BetweenRange(A &value, const T minValue, const T maxValue, const char *valueName)
Definition BoundsChecking:177
void clampArray3LEQUAL(A &value, const T maxValue, const char *valueName)
Definition BoundsChecking:165
void clampArrayElementsLEQUAL(A &value, unsigned int first, unsigned int last, const T maxValue, const char *valueName)
Definition BoundsChecking:132
void clampArrayElementsGEQUAL(A &value, unsigned int first, unsigned int last, const T minValue, const char *valueName)
Definition BoundsChecking:122
void clampArray4LEQUAL(A &value, const T maxValue, const char *valueName)
Definition BoundsChecking:197
void clampBetweenRange(T &value, const T minValue, const T maxValue, const char *valueName)
Definition BoundsChecking:54
void clampArrayElementLEQUAL(A &value, unsigned int i, const T maxValue, const char *valueName)
Definition BoundsChecking:87
std::ostream & notify(void)
Definition Notify:80
void clampGEQUAL(T &value, const T minValue, const char *valueName)
Definition BoundsChecking:26
void clampArray4BetweenRange(A &value, const T minValue, const T maxValue, const char *valueName)
Definition BoundsChecking:209
void clampLEQUAL(T &value, const T maxValue, const char *valueName)
Definition BoundsChecking:39