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