examples/contact-cards/clipped-image.h

   1 #ifndef CLIPPED_IMAGE_H
   2 #define CLIPPED_IMAGE_H
   3
   4 /*
   5  * Copyright (c) 2016 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 <string>
  23 #include <dali-toolkit/public-api/controls/control.h>
  24
  25 /**
  26  * @brief This namespace provides a helper function to create a control that clips an image either as a quad or a circle.
  27  *
  28  * The CIRCLE_GEOMETRY and QUAD_GEOMETRY constants can be used to set or animate to the different clipping geometries.
  29  */
  30 namespace ClippedImage
  31 {
  32
  33 extern const float CIRCLE_GEOMETRY; ///< Setting or animating the returned propertyIndex in Create() to this value will provide a circle geometry on the image @see Create
  34 extern const float QUAD_GEOMETRY; ///< Setting or animating the returned propertyIndex in Create() to this value will provide a quad geometry on the image @see Create
  35
  36 /**
  37  * @brief Creates a clipping image whose geometry (i.e. clip area) can be morphed between a circle and a quad by animating the propertyIndex out parameter.
  38  *
  39  * The propertyIndex parameter can be set or animated to CIRCLE_GEOMETRY or QUAD_GEOMETRY depending on the type of clipping required.
  40  * If set to a value between these two constants, then the resulting geometry will be somewhere in between a circle and a quad.
  41  *
  42  * @param[in]   imagePath      The path to the image to show.
  43  * @param[out]  propertyIndex  Gets set with the property index which the caller can animate using the CIRCLE_GEOMETRY & QUAD_GEOMETRY values.
  44  * @return The image-mesh control
  45  */
  46 Dali::Toolkit::Control Create( const std::string& imagePath, Dali::Property::Index& propertyIndex );
  47
  48 } // namespace ClippedImage
  49
  50 #endif // CLIPPED_IMAGE_H