base/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) 2014 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
  23 // INTERNAL INCLUDES
  24
  25 namespace Dali DALI_IMPORT_API
  26 {
  27
  28 struct Vector2;
  29 struct Vector3;
  30 struct Vector4;
  31 class PropertyInput;
  32
  33 namespace Toolkit
  34 {
  35
  36 // Constraints ////////////////////////////////////////////////////////////////////////////////////
  37
  38 /**
  39  * Useful constraints to apply to a ScrollView.
  40  */
  41
  42 /**
  43  * Move Actor constraint.
  44  *
  45  * Moves an Actor in accordance to scroll position.
  46  */
  47 Vector3 MoveActorConstraint(const Vector3&    current,
  48                             const PropertyInput& scrollPositionProperty);
  49
  50 /**
  51  * Move-Scaled Actor constraint.
  52  *
  53  * Moves an Actor in accordance to scroll position (and scroll scale).
  54  */
  55 Vector3 MoveScaledActorConstraint(const Vector3&    current,
  56                                   const PropertyInput& scrollPositionProperty,
  57                                   const PropertyInput& scrollScaleProperty);
  58
  59 /**
  60  * Scale Actor constraint.
  61  *
  62  * Scales an Actor in accordance to scroll scale.
  63  */
  64 Vector3 ScaleActorConstraint(const Vector3&    current,
  65                              const PropertyInput& scrollScaleProperty);
  66
  67 /**
  68  * Wrap Actor constraint.
  69  *
  70  * Wraps an Actors position in accordance to min/max bounds of domain.
  71  */
  72 Vector3 WrapActorConstraint(const Vector3&    current,
  73                             const PropertyInput& actorScaleProperty,
  74                             const PropertyInput& actorAnchorPointProperty,
  75                             const PropertyInput& actorSizeProperty,
  76                             const PropertyInput& scrollPositionMin,
  77                             const PropertyInput& scrollPositionMax,
  78                             const PropertyInput& scrollWrap);
  79
  80 } // namespace Toolkit
  81
  82 } // namespace Dali
  83
  84 #endif // __DALI_TOOLKIT_SCROLL_VIEW_CONSTRAINTS_H__