dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-constraints.h

   1 #ifndef __DALI_TOOLKIT_SCROLL_VIEW_CONSTRAINTS_H__
   2 #define __DALI_TOOLKIT_SCROLL_VIEW_CONSTRAINTS_H__
   3
   4 /*
   5  * Copyright (c) 2018 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/animation/constraint.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/public-api/dali-toolkit-common.h>
  26
  27 namespace Dali
  28 {
  29
  30 struct Vector2;
  31 struct Vector3;
  32 struct Vector4;
  33 class PropertyInput;
  34
  35 namespace Toolkit
  36 {
  37 /**
  38  * @addtogroup dali_toolkit_controls_scroll_view
  39  * @{
  40  */
  41
  42 // Constraints ////////////////////////////////////////////////////////////////////////////////////
  43
  44 /**
  45  * Useful constraints to apply to a ScrollView.
  46  */
  47
  48 /**
  49  * @brief Moves an Actor in accordance with the scroll position.
  50  *
  51  * @SINCE_1_0.0
  52  * @param[in] current Current position
  53  * @param[in] inputs The position input that Actor will move
  54  */
  55 DALI_TOOLKIT_API void MoveActorConstraint( Vector3& current, const PropertyInputContainer& inputs );
  56
  57 /**
  58  * @brief Wraps an Actor's position in accordance with the min/max bounds of domain.
  59  *
  60  * @SINCE_1_0.0
  61  * @param[in] position Position to be wrapped
  62  * @param[in] inputs The input that Actor's position will be wrapped
  63  */
  64 DALI_TOOLKIT_API void WrapActorConstraint( Vector3& position, const PropertyInputContainer& inputs );
  65
  66 /**
  67  * @}
  68  */
  69 } // namespace Toolkit
  70
  71 } // namespace Dali
  72
  73 #endif // __DALI_TOOLKIT_SCROLL_VIEW_CONSTRAINTS_H__