2 * Copyright (c) 2017 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali-toolkit/internal/controls/progress-bar/progress-bar-impl.h>
22 #include <cstring> // for strcmp
25 #include <dali/public-api/object/type-registry-helper.h>
26 #include <dali/public-api/size-negotiation/relayout-container.h>
27 #include <dali/public-api/math/math-utils.h>
28 #include <dali-toolkit/devel-api/align-enums.h>
29 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
30 #include <dali-toolkit/public-api/visuals/color-visual-properties.h>
31 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
32 #include <dali-toolkit/devel-api/visuals/text-visual-properties.h>
33 #include <dali-toolkit/devel-api/visuals/visual-properties-devel.h>
34 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
36 #include <dali/integration-api/debug.h>
47 namespace // Unnamed namespace
52 return Dali::Toolkit::ProgressBar::New();
55 // Setup properties, signals and actions using the type-registry.
56 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::ProgressBar, Toolkit::Control, Create )
58 DALI_PROPERTY_REGISTRATION( Toolkit, ProgressBar, "progressValue", FLOAT, PROGRESS_VALUE )
59 DALI_PROPERTY_REGISTRATION( Toolkit, ProgressBar, "secondaryProgressValue", FLOAT, SECONDARY_PROGRESS_VALUE )
60 DALI_PROPERTY_REGISTRATION( Toolkit, ProgressBar, "indeterminate", BOOLEAN, INDETERMINATE )
61 DALI_PROPERTY_REGISTRATION( Toolkit, ProgressBar, "trackVisual", MAP, TRACK_VISUAL )
62 DALI_PROPERTY_REGISTRATION( Toolkit, ProgressBar, "progressVisual", MAP, PROGRESS_VISUAL )
63 DALI_PROPERTY_REGISTRATION( Toolkit, ProgressBar, "secondaryProgressVisual", MAP, SECONDARY_PROGRESS_VISUAL )
64 DALI_PROPERTY_REGISTRATION( Toolkit, ProgressBar, "indeterminateVisual", MAP, INDETERMINATE_VISUAL )
65 DALI_PROPERTY_REGISTRATION( Toolkit, ProgressBar, "indeterminateVisualAnimation", ARRAY, INDETERMINATE_VISUAL_ANIMATION )
66 DALI_PROPERTY_REGISTRATION( Toolkit, ProgressBar, "labelVisual", MAP, LABEL_VISUAL )
67 DALI_SIGNAL_REGISTRATION( Toolkit, ProgressBar, "valueChanged", SIGNAL_VALUE_CHANGED )
69 DALI_TYPE_REGISTRATION_END()
71 struct ProgressDepthIndex
73 // Enum to make sure the visual order
77 SECONDARY_PROGRESS_VISUAL,
84 float DEFAULT_VALUE = 0.0f;
85 float DEFAULT_LOWER_BOUND = 0.0f;
86 float DEFAULT_UPPER_BOUND = 1.0f;
87 float DEFAULT_FONT_SIZE = 12.0f;
89 } // Unnamed namespace
91 ///////////////////////////////////////////////////////////////////////////////////////////////////
93 ///////////////////////////////////////////////////////////////////////////////////////////////////
95 Dali::Toolkit::ProgressBar ProgressBar::New()
97 // Create the implementation
98 ProgressBarPtr progressBar( new ProgressBar() );
100 // Pass ownership to CustomActor via derived handle
101 Dali::Toolkit::ProgressBar handle( *progressBar );
103 // Second-phase init of the implementation
104 // This can only be done after the CustomActor connection has been made...
105 progressBar->Initialize();
110 ProgressBar::ProgressBar()
111 : Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
112 mProgressValue( DEFAULT_VALUE ),
113 mSecondaryProgressValue( DEFAULT_VALUE ),
114 mIndeterminate( false )
118 ProgressBar::~ProgressBar()
122 void ProgressBar::OnInitialize()
126 void ProgressBar::OnRelayout( const Vector2& size, RelayoutContainer& container )
129 Vector2 trackSize( size );
130 mDomain = CalcDomain( size );
132 trackSize.width = std::max( 0.0f, size.width ); // Ensure we don't go negative
134 Toolkit::Visual::Base trackVisual = GetVisual( Toolkit::ProgressBar::Property::TRACK_VISUAL );
135 Toolkit::Visual::Base secondProgressVisual = GetVisual( Toolkit::ProgressBar::Property::SECONDARY_PROGRESS_VISUAL );
136 Toolkit::Visual::Base progressVisual = GetVisual( Toolkit::ProgressBar::Property::PROGRESS_VISUAL );
137 Toolkit::Visual::Base labelVisual = GetVisual( Toolkit::ProgressBar::Property::LABEL_VISUAL );
138 Toolkit::Visual::Base indeterminateVisual = GetVisual( Toolkit::ProgressBar::Property::INDETERMINATE_VISUAL );
142 Property::Map visualTransform;
144 visualTransform.Add( Toolkit::DevelVisual::Transform::Property::SIZE, trackSize )
145 .Add( Toolkit::DevelVisual::Transform::Property::OFFSET_POLICY, Vector2( DevelVisual::Transform::Policy::ABSOLUTE, DevelVisual::Transform::Policy::ABSOLUTE ) )
146 .Add( Toolkit::DevelVisual::Transform::Property::SIZE_POLICY, Vector2( DevelVisual::Transform::Policy::ABSOLUTE, DevelVisual::Transform::Policy::ABSOLUTE ) );
148 trackVisual.SetTransformAndSize( visualTransform, trackSize );
151 if( secondProgressVisual )
153 Property::Map visualTransform;
155 visualTransform.Add( Toolkit::DevelVisual::Transform::Property::SIZE, Vector2( mDomain.from.x + mSecondaryProgressValue * ( mDomain.to.x - mDomain.from.x ), trackSize.height ) )
156 .Add( Toolkit::DevelVisual::Transform::Property::OFFSET_POLICY, Vector2( DevelVisual::Transform::Policy::ABSOLUTE, DevelVisual::Transform::Policy::ABSOLUTE ) )
157 .Add( Toolkit::DevelVisual::Transform::Property::SIZE_POLICY, Vector2( DevelVisual::Transform::Policy::ABSOLUTE, DevelVisual::Transform::Policy::ABSOLUTE ) )
158 .Add( Toolkit::DevelVisual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
159 .Add( Toolkit::DevelVisual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN );
160 secondProgressVisual.SetTransformAndSize( visualTransform, trackSize );
165 Property::Map visualTransform;
167 visualTransform.Add( Toolkit::DevelVisual::Transform::Property::SIZE, Vector2( mDomain.from.x + mProgressValue * ( mDomain.to.x - mDomain.from.x ), trackSize.height ) )
168 .Add( Toolkit::DevelVisual::Transform::Property::OFFSET_POLICY, Vector2( DevelVisual::Transform::Policy::ABSOLUTE, DevelVisual::Transform::Policy::ABSOLUTE ) )
169 .Add( Toolkit::DevelVisual::Transform::Property::SIZE_POLICY, Vector2( DevelVisual::Transform::Policy::ABSOLUTE, DevelVisual::Transform::Policy::ABSOLUTE ) )
170 .Add( Toolkit::DevelVisual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
171 .Add( Toolkit::DevelVisual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN );
172 progressVisual.SetTransformAndSize( visualTransform, trackSize );
177 Property::Map visualTransform;
179 visualTransform.Add( Toolkit::DevelVisual::Transform::Property::SIZE, trackSize )
180 .Add( Toolkit::DevelVisual::Transform::Property::OFFSET_POLICY, Vector2( DevelVisual::Transform::Policy::ABSOLUTE, DevelVisual::Transform::Policy::ABSOLUTE ) )
181 .Add( Toolkit::DevelVisual::Transform::Property::SIZE_POLICY, Vector2( DevelVisual::Transform::Policy::ABSOLUTE, DevelVisual::Transform::Policy::ABSOLUTE ) );
182 labelVisual.SetTransformAndSize( visualTransform, trackSize );
185 if( indeterminateVisual )
187 Property::Map visualTransform;
189 visualTransform.Add( Toolkit::DevelVisual::Transform::Property::SIZE, trackSize )
190 .Add( Toolkit::DevelVisual::Transform::Property::OFFSET_POLICY, Vector2( DevelVisual::Transform::Policy::ABSOLUTE, DevelVisual::Transform::Policy::ABSOLUTE ) )
191 .Add( Toolkit::DevelVisual::Transform::Property::SIZE_POLICY, Vector2( DevelVisual::Transform::Policy::ABSOLUTE, DevelVisual::Transform::Policy::ABSOLUTE ) );
192 indeterminateVisual.SetTransformAndSize( visualTransform, trackSize );
197 Vector3 ProgressBar::GetNaturalSize()
199 // Return the bigger size after comparing trackVisual naturalSize and labelVisual naturalSize
200 Toolkit::Visual::Base trackVisual = GetVisual( Toolkit::ProgressBar::Property::TRACK_VISUAL );
201 Toolkit::Visual::Base labelVisual = GetVisual( Toolkit::ProgressBar::Property::LABEL_VISUAL );
208 trackVisual.GetNaturalSize( trackSize );
212 labelVisual.GetNaturalSize( labelSize );
216 naturalSize.width = ( trackSize.width > labelSize.width ) ? trackSize.width: labelSize.width;
217 naturalSize.height = ( trackSize.height > labelSize.height ) ? trackSize.height: labelSize.height;
222 ProgressBar::Domain ProgressBar::CalcDomain( const Vector2& currentSize )
224 return Domain( Vector2( 0.0f, 0.0f ), currentSize );
227 Toolkit::ProgressBar::ValueChangedSignalType& ProgressBar::ValueChangedSignal()
229 return mValueChangedSignal;
232 void ProgressBar::SetProgressValue( float value )
234 // update the progress bar value (taking float precision errors into account)
235 // TODO : it seems 0.0f cannot into this statement.
236 if( ( mProgressValue != value ) &&
237 ( ( value >= DEFAULT_LOWER_BOUND ) || ( Equals( value, DEFAULT_LOWER_BOUND ) ) ) &&
238 ( ( value <= DEFAULT_UPPER_BOUND ) || ( Equals( value, DEFAULT_UPPER_BOUND ) ) ) )
240 mProgressValue = Clamp( value, DEFAULT_LOWER_BOUND, DEFAULT_UPPER_BOUND );
242 Toolkit::ProgressBar self = Toolkit::ProgressBar::DownCast( Self() );
243 mValueChangedSignal.Emit( self, mProgressValue, mSecondaryProgressValue );
248 float ProgressBar::GetProgressValue() const
250 return mProgressValue;
253 void ProgressBar::SetSecondaryProgressValue( float value )
255 // update the progress bar value (taking float precision errors into account)
256 // TODO : it seems 0.0f cannot into this statement.
257 if( ( mSecondaryProgressValue != value ) &&
258 ( ( value >= DEFAULT_LOWER_BOUND ) || ( Equals( value, DEFAULT_LOWER_BOUND ) ) ) &&
259 ( ( value <= DEFAULT_UPPER_BOUND ) || ( Equals( value, DEFAULT_UPPER_BOUND ) ) ) )
261 mSecondaryProgressValue = Clamp( value, DEFAULT_LOWER_BOUND, DEFAULT_UPPER_BOUND );
263 Toolkit::ProgressBar self = Toolkit::ProgressBar::DownCast( Self() );
264 mValueChangedSignal.Emit( self, mProgressValue, mSecondaryProgressValue );
270 float ProgressBar::GetSecondaryProgressValue() const
272 return mSecondaryProgressValue;
275 void ProgressBar::SetIndeterminate( bool value )
277 mIndeterminate = value;
278 EnableVisual( Toolkit::ProgressBar::Property::INDETERMINATE_VISUAL, mIndeterminate );
283 if( mIndeterminateVisualTransition )
285 PlayIndeterminateVisualTransition();
290 if( mIndeterminateVisualAni )
292 mIndeterminateVisualAni.Stop();
297 bool ProgressBar::GetIndeterminate() const
299 return mIndeterminate;
302 void ProgressBar::SetIndeterminateVisualTransition( Toolkit::TransitionData transition )
304 mIndeterminateVisualTransition = transition;
307 PlayIndeterminateVisualTransition();
311 void ProgressBar::PlayIndeterminateVisualTransition()
313 if( mIndeterminateVisualAni )
315 mIndeterminateVisualAni.Stop();
316 mIndeterminateVisualAni.Clear();
319 mIndeterminateVisualAni = CreateTransition( mIndeterminateVisualTransition );
321 if( mIndeterminate && mIndeterminateVisualAni )
323 mIndeterminateVisualAni.SetLooping(true);
324 mIndeterminateVisualAni.Play();
328 Toolkit::TransitionData ProgressBar::ConvertPropertyToTransition( const Property::Value& value )
330 Toolkit::TransitionData transitionData;
332 if( value.GetType() == Property::ARRAY )
334 transitionData = Toolkit::TransitionData::New( *value.GetArray() );
336 else if( value.GetType() == Property::MAP )
338 transitionData = Toolkit::TransitionData::New( *value.GetMap() );
341 return transitionData;
345 * Create Visual for given index from a property map or url.
346 * 1) Check if value passed in is a url and create visual
347 * 2) Create visual from map if step (1) is false
348 * 3) Register visual with control with false for enable flag.
349 * 4) Unregister visual if empty map was provided. This is the method to remove a visual
352 void ProgressBar::CreateVisualsForComponent( Property::Index index, const Property::Value& value, const float visualDepth )
354 Toolkit::VisualFactory visualFactory = Toolkit::VisualFactory::Get();
355 Toolkit::Visual::Base progressVisual;
357 std::string imageUrl;
358 if( value.Get( imageUrl ) )
360 if ( !imageUrl.empty() )
362 progressVisual = visualFactory.CreateVisual( imageUrl, ImageDimensions() );
365 else // Does this code make text-visual can be accepted as visual?
367 // if its not a string then get a Property::Map from the property if possible.
368 Property::Map *map = value.GetMap();
369 if( map && !map->Empty() ) // Empty map results in current visual removal.
371 progressVisual = visualFactory.CreateVisual( *map );
375 if ( progressVisual )
377 progressVisual.SetDepthIndex( visualDepth );
378 if( index == Toolkit::ProgressBar::Property::INDETERMINATE_VISUAL )
380 RegisterVisual( index, progressVisual, mIndeterminate );
384 RegisterVisual( index, progressVisual, true );
389 UnregisterVisual( index );
393 bool ProgressBar::GetPropertyMapForVisual( Property::Index visualIndex, Property::Map& retreivedMap ) const
395 bool success = false;
396 Toolkit::Visual::Base visual = GetVisual( visualIndex );
400 visual.CreatePropertyMap( retreivedMap );
407 // Static class method to support script connecting signals
408 bool ProgressBar::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
410 Dali::BaseHandle handle( object );
412 bool connected = true;
413 Toolkit::ProgressBar ProgressBar = Toolkit::ProgressBar::DownCast( handle );
415 if( 0 == strcmp( signalName.c_str(), SIGNAL_VALUE_CHANGED ) )
417 ProgressBar.ValueChangedSignal().Connect( tracker, functor );
421 // signalName does not match any signal
428 void ProgressBar::SetProperty( BaseObject* object, Property::Index propertyIndex, const Property::Value& value )
430 Toolkit::ProgressBar progressBar = Toolkit::ProgressBar::DownCast( Dali::BaseHandle( object ) );
434 ProgressBar& progressBarImpl( GetImpl( progressBar ) );
436 switch ( propertyIndex )
438 case Toolkit::ProgressBar::Property::TRACK_VISUAL:
440 progressBarImpl.CreateVisualsForComponent( propertyIndex, value, ProgressDepthIndex::TRACK_VISUAL );
444 case Toolkit::ProgressBar::Property::SECONDARY_PROGRESS_VISUAL:
446 progressBarImpl.CreateVisualsForComponent( propertyIndex, value, ProgressDepthIndex::SECONDARY_PROGRESS_VISUAL );
450 case Toolkit::ProgressBar::Property::PROGRESS_VISUAL:
452 progressBarImpl.CreateVisualsForComponent( propertyIndex, value, ProgressDepthIndex::PROGRESS_VISUAL );
456 case Toolkit::ProgressBar::Property::INDETERMINATE_VISUAL:
458 progressBarImpl.CreateVisualsForComponent( propertyIndex, value, ProgressDepthIndex::INDETERMINATE_VISUAL );
462 case Toolkit::ProgressBar::Property::LABEL_VISUAL:
465 std::string textString;
467 if ( value.Get( textString ) )
469 // set new text string as TEXT property
470 Property::Map newTextMap;
471 Toolkit::Visual::Base label = progressBarImpl.GetVisual( Toolkit::ProgressBar::Property::LABEL_VISUAL );
475 label.CreatePropertyMap( map );
478 // if LABEL_VISUAL doesn't set before, add Visual property "TYPE" to create new text Visual
481 newTextMap.Add( Toolkit::Visual::Property::TYPE, Toolkit::DevelVisual::TEXT );
482 newTextMap.Add( Toolkit::TextVisual::Property::POINT_SIZE, DEFAULT_FONT_SIZE );
484 newTextMap.Add( Toolkit::TextVisual::Property::TEXT, textString );
486 map.Merge( newTextMap );
495 progressBarImpl.CreateVisualsForComponent( propertyIndex, map, ProgressDepthIndex::LABEL_VISUAL );
500 case Toolkit::ProgressBar::Property::PROGRESS_VALUE:
502 progressBarImpl.SetProgressValue( value.Get< float >() );
506 case Toolkit::ProgressBar::Property::SECONDARY_PROGRESS_VALUE:
508 progressBarImpl.SetSecondaryProgressValue( value.Get< float >() );
512 case Toolkit::ProgressBar::Property::INDETERMINATE:
514 progressBarImpl.SetIndeterminate( value.Get< bool >() );
518 case Toolkit::ProgressBar::Property::INDETERMINATE_VISUAL_ANIMATION:
520 progressBarImpl.SetIndeterminateVisualTransition( progressBarImpl.ConvertPropertyToTransition( value ) );
527 Property::Value ProgressBar::GetProperty( BaseObject* object, Property::Index propertyIndex )
529 Property::Value value;
531 Toolkit::ProgressBar progressBar = Toolkit::ProgressBar::DownCast( Dali::BaseHandle( object ) );
535 ProgressBar& progressBarImpl( GetImpl( progressBar ) );
537 switch ( propertyIndex )
539 case Toolkit::ProgressBar::Property::TRACK_VISUAL:
540 case Toolkit::ProgressBar::Property::PROGRESS_VISUAL:
541 case Toolkit::ProgressBar::Property::SECONDARY_PROGRESS_VISUAL:
542 case Toolkit::ProgressBar::Property::INDETERMINATE_VISUAL:
543 case Toolkit::ProgressBar::Property::LABEL_VISUAL:
545 Property::Map visualProperty;
546 if ( progressBarImpl.GetPropertyMapForVisual( propertyIndex, visualProperty ) )
548 value = visualProperty;
553 case Toolkit::ProgressBar::Property::PROGRESS_VALUE:
555 value = progressBarImpl.GetProgressValue();
559 case Toolkit::ProgressBar::Property::SECONDARY_PROGRESS_VALUE:
561 value = progressBarImpl.GetSecondaryProgressValue();
565 case Toolkit::ProgressBar::Property::INDETERMINATE:
567 value = progressBarImpl.GetIndeterminate();
571 case Toolkit::ProgressBar::Property::INDETERMINATE_VISUAL_ANIMATION:
573 //TODO: Return INDETERMINATE_VISUAL_TRANSITION;
581 void ProgressBar::OnStageConnection( int depth )
583 // Chain up first (ensures visuals are ready to draw)
584 Control::OnStageConnection( depth );
588 PlayIndeterminateVisualTransition();
592 } // namespace Internal
594 } // namespace Toolkit