dali/public-api/math/random.h

   1 #ifndef __DALI_RANDOM_H__
   2 #define __DALI_RANDOM_H__
   3
   4 /*
   5  * Copyright (c) 2017 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/math/vector4.h>
  23
  24 namespace Dali
  25 {
  26 /**
  27  * @addtogroup dali_core_math
  28  * @{
  29  */
  30
  31 /**
  32  * @brief Provides methods to generate and use random values.
  33  * @SINCE_1_0.0
  34  */
  35 namespace Random
  36 {
  37
  38 /**
  39  * @brief Returns a random number between f0 and f1.
  40  *
  41  * Note, uses a limited number of values.
  42  * @SINCE_1_0.0
  43  * @param[in] f0 The lower bound
  44  * @param[in] f1 The upper bound
  45  * @return A random value between the lower and upper bound
  46  */
  47 inline float Range(float f0, float f1)
  48 {
  49   float min = std::min(f0, f1);
  50   float max = std::max(f0, f1);
  51
  52   // Ensure we initialize only once. As it's inlined, this static variable will exist in the code-block using it, thus,
  53   // will be created and then initialized again when another code-block uses this.
  54   static bool initialized( false );
  55   if( !initialized )
  56   {
  57     auto seed = time( NULL );
  58     srand( seed );
  59     initialized = true;
  60   }
  61
  62   auto randValue = rand();
  63   return (randValue & 0xfff) * (1.0f/4095.0f) * (max-min) + min;
  64 }
  65
  66 /**
  67  * @brief Function to return a normalized axis in a random direction.
  68  *
  69  * @SINCE_1_0.0
  70  * @return The axis
  71  */
  72 inline Vector4 Axis()
  73 {
  74   Vector4 axis;
  75   // This function needs to return a vector with direction, that is to say a non-zero vector
  76   // There is a possibility that a random vector will be a zero vector, so a loop is needed to ensure that a non-zero vector is returned
  77   do
  78   {
  79     axis.x = Range(-1.0f, 1.0f);
  80     axis.y = Range( 0.0f, 1.0f);
  81     axis.z = Range( 0.0f, 1.0f);
  82     axis.w = 0.0f;
  83   } while (axis == Vector4::ZERO);
  84   axis.Normalize();
  85   return axis;
  86 }
  87
  88 } // namespace Random
  89
  90 /**
  91  * @}
  92  */
  93 } // namespace Dali
  94
  95 #endif // __DALI_RANDOM_H__