Tizen Native API  4.0
Public Member Functions | Static Public Member Functions
Dali::Toolkit::ScrollViewPagePathEffect Class Reference
Scroll View

ScrollView Page Path Effect. More...

Inheritance diagram for Dali::Toolkit::ScrollViewPagePathEffect:
Dali::Toolkit::ScrollViewEffect Dali::BaseHandle

Public Member Functions

 ScrollViewPagePathEffect ()
 Creates an uninitialized ScrollViewPagePathEffect; this can be initialized with ScrollViewPagePathEffect::New(). Calling member functions with an uninitialized Toolkit::ScrollViewPagePathEffect is not allowed.
void ApplyToPage (Actor page, unsigned int pageOrder)
 Manually apply effect to a page in the scroll-view.

Static Public Member Functions

static ScrollViewPagePathEffect New (Path path, const Vector3 &forward, Dali::Property::Index inputPropertyIndex, const Vector3 &pageSize, unsigned int pageCount)
 Creates an initialized ScrollViewPagePathEffect.
static ScrollViewPagePathEffect DownCast (BaseHandle handle)
 Downcasts a handle to ScrollViewPagePathEffect handle.

Detailed Description

ScrollView Page Path Effect.

This effect causes Actors to follow a given path. The opacity of the actor will be 0.0 at the beginning of the path and will go to 1.0 as it is approximating to half of the path to return to 0.0 at the end of the path.

ScrollView | Page (1..n)

You should ensure ScrollView's default constraints have been removed, by calling ScrollView::RemoveConstraintsFromChildren() before applying this effect to ScrollView.

Manual operation: ApplyToPage(...) method should be called on every page.

Automatic operation: not implemented.

Since:
3.0, DALi version 1.0.0

Constructor & Destructor Documentation

Dali::Toolkit::ScrollViewPagePathEffect::ScrollViewPagePathEffect ( )

Creates an uninitialized ScrollViewPagePathEffect; this can be initialized with ScrollViewPagePathEffect::New(). Calling member functions with an uninitialized Toolkit::ScrollViewPagePathEffect is not allowed.

Since:
3.0, DALi version 1.0.0

Member Function Documentation

void Dali::Toolkit::ScrollViewPagePathEffect::ApplyToPage ( Actor  page,
unsigned int  pageOrder 
)

Manually apply effect to a page in the scroll-view.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]pageThe page to be affected by this effect
[in]pageOrderThe order of the page in the scroll view
static ScrollViewPagePathEffect Dali::Toolkit::ScrollViewPagePathEffect::DownCast ( BaseHandle  handle) [static]

Downcasts a handle to ScrollViewPagePathEffect handle.

If handle points to a ScrollViewPagePathEffect, the downcast produces valid handle. If not, the returned handle is left uninitialized.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]handleHandle to an object
Returns:
Handle to a ScrollViewPagePathEffect or an uninitialized handle
static ScrollViewPagePathEffect Dali::Toolkit::ScrollViewPagePathEffect::New ( Path  path,
const Vector3 &  forward,
Dali::Property::Index  inputPropertyIndex,
const Vector3 &  pageSize,
unsigned int  pageCount 
) [static]

Creates an initialized ScrollViewPagePathEffect.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]pathThe path that will be used by the scroll effect
[in]forwardVector in page object space which will be aligned with the tangent of the path
[in]inputPropertyIndexIndex of a property of the scroll-view which will be used as the input for the path
[in]pageSizeSize of a page in the scrollview
[in]pageCountTotal number of pages in the scrollview
Returns:
A handle to a newly allocated Dali resource