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/public-api/align-enumerations.h>
29 #include <dali-toolkit/devel-api/controls/control-devel.h>
30 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
31 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
32 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
33 #include <dali-toolkit/devel-api/visuals/arc-visual-properties-devel.h>
34 #include <dali-toolkit/public-api/visuals/color-visual-properties.h>
35 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
36 #include <dali-toolkit/public-api/visuals/text-visual-properties.h>
37 #include <dali-toolkit/public-api/visuals/visual-properties.h>
38 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
40 #include <dali/integration-api/debug.h>
51 namespace // Unnamed namespace
56 return Dali::Toolkit::ProgressBar::New();
59 // Setup properties, signals and actions using the type-registry.
60 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::ProgressBar, Toolkit::Control, Create )
62 DALI_PROPERTY_REGISTRATION( Toolkit, ProgressBar, "progressValue", FLOAT, PROGRESS_VALUE )
63 DALI_PROPERTY_REGISTRATION( Toolkit, ProgressBar, "secondaryProgressValue", FLOAT, SECONDARY_PROGRESS_VALUE )
64 DALI_PROPERTY_REGISTRATION( Toolkit, ProgressBar, "indeterminate", BOOLEAN, INDETERMINATE )
65 DALI_PROPERTY_REGISTRATION( Toolkit, ProgressBar, "trackVisual", MAP, TRACK_VISUAL )
66 DALI_PROPERTY_REGISTRATION( Toolkit, ProgressBar, "progressVisual", MAP, PROGRESS_VISUAL )
67 DALI_PROPERTY_REGISTRATION( Toolkit, ProgressBar, "secondaryProgressVisual", MAP, SECONDARY_PROGRESS_VISUAL )
68 DALI_PROPERTY_REGISTRATION( Toolkit, ProgressBar, "indeterminateVisual", MAP, INDETERMINATE_VISUAL )
69 DALI_PROPERTY_REGISTRATION( Toolkit, ProgressBar, "indeterminateVisualAnimation", ARRAY, INDETERMINATE_VISUAL_ANIMATION )
70 DALI_PROPERTY_REGISTRATION( Toolkit, ProgressBar, "labelVisual", MAP, LABEL_VISUAL )
71 DALI_SIGNAL_REGISTRATION( Toolkit, ProgressBar, "valueChanged", SIGNAL_VALUE_CHANGED )
73 DALI_TYPE_REGISTRATION_END()
75 struct ProgressDepthIndex
77 // Enum to make sure the visual order
81 SECONDARY_PROGRESS_VISUAL,
88 float DEFAULT_VALUE = 0.0f;
89 float DEFAULT_LOWER_BOUND = 0.0f;
90 float DEFAULT_UPPER_BOUND = 1.0f;
91 float DEFAULT_FONT_SIZE = 12.0f;
92 const char* CIRCULAR_PROGRESS_BAR_STYLE_NAME = "CircularProgressBar";
95 void BackupVisualProperties( const Control* control, Property::Index index, Property::Map& map )
97 Toolkit::Visual::Base visual = DevelControl::GetVisual( *control, index );
102 visual.CreatePropertyMap( map );
106 void RestoreVisualProperties( Control* control, Property::Index index, Property::Map& map, int depth )
110 Toolkit::Visual::Base visual = DevelControl::GetVisual( *control, index );
112 Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
114 visualImpl.SetProperties( map );
116 DevelControl::UnregisterVisual( *control, index );
118 DevelControl::RegisterVisual( *control, index, visual, true, depth );
122 } // Unnamed namespace
124 ///////////////////////////////////////////////////////////////////////////////////////////////////
126 ///////////////////////////////////////////////////////////////////////////////////////////////////
128 Dali::Toolkit::ProgressBar ProgressBar::New( DevelProgressBar::Style progressBarStyle )
130 // Create the implementation
131 ProgressBarPtr progressBar( new ProgressBar() );
133 Dali::Toolkit::ProgressBar handle( *progressBar );
135 switch( progressBarStyle )
137 case DevelProgressBar::Style::CIRCULAR:
139 progressBar->SetStyleName( CIRCULAR_PROGRESS_BAR_STYLE_NAME );
148 // Second-phase init of the implementation
149 // This can only be done after the CustomActor connection has been made...
150 progressBar->Initialize();
155 ProgressBar::ProgressBar()
156 : Control( ControlBehaviour( CONTROL_BEHAVIOUR_DEFAULT ) ),
157 mProgressValue( DEFAULT_VALUE ),
158 mSecondaryProgressValue( DEFAULT_VALUE ),
159 mIndeterminate( false )
163 ProgressBar::~ProgressBar()
167 void ProgressBar::OnInitialize()
171 void ProgressBar::OnRelayout( const Vector2& size, RelayoutContainer& container )
174 Vector2 trackSize( size );
175 mDomain = CalcDomain( size );
177 trackSize.width = std::max( 0.0f, size.width ); // Ensure we don't go negative
179 Toolkit::Visual::Base trackVisual = DevelControl::GetVisual( *this, Toolkit::ProgressBar::Property::TRACK_VISUAL );
180 Toolkit::Visual::Base labelVisual = DevelControl::GetVisual( *this, Toolkit::ProgressBar::Property::LABEL_VISUAL );
181 Toolkit::Visual::Base indeterminateVisual = DevelControl::GetVisual( *this, Toolkit::ProgressBar::Property::INDETERMINATE_VISUAL );
185 Property::Map visualTransform;
187 visualTransform.Add( Toolkit::Visual::Transform::Property::SIZE, trackSize )
188 .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
189 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) );
191 trackVisual.SetTransformAndSize( visualTransform, trackSize );
194 ApplyProgressToVisualTransform( mSecondaryProgressValue, trackSize, Toolkit::ProgressBar::Property::SECONDARY_PROGRESS_VISUAL );
196 ApplyProgressToVisualTransform( mProgressValue, trackSize, Toolkit::ProgressBar::Property::PROGRESS_VISUAL );
200 Property::Map visualTransform;
202 visualTransform.Add( Toolkit::Visual::Transform::Property::SIZE, trackSize )
203 .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
204 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) );
205 labelVisual.SetTransformAndSize( visualTransform, trackSize );
208 if( indeterminateVisual )
210 Property::Map visualTransform;
212 visualTransform.Add( Toolkit::Visual::Transform::Property::SIZE, trackSize )
213 .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
214 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) );
215 indeterminateVisual.SetTransformAndSize( visualTransform, trackSize );
220 Vector3 ProgressBar::GetNaturalSize()
222 // Return the bigger size after comparing trackVisual naturalSize and labelVisual naturalSize
223 Toolkit::Visual::Base trackVisual = DevelControl::GetVisual( *this, Toolkit::ProgressBar::Property::TRACK_VISUAL );
224 Toolkit::Visual::Base labelVisual = DevelControl::GetVisual( *this, Toolkit::ProgressBar::Property::LABEL_VISUAL );
231 trackVisual.GetNaturalSize( trackSize );
235 labelVisual.GetNaturalSize( labelSize );
239 naturalSize.width = ( trackSize.width > labelSize.width ) ? trackSize.width: labelSize.width;
240 naturalSize.height = ( trackSize.height > labelSize.height ) ? trackSize.height: labelSize.height;
245 ProgressBar::Domain ProgressBar::CalcDomain( const Vector2& currentSize )
247 return Domain( Vector2( 0.0f, 0.0f ), currentSize );
250 Toolkit::ProgressBar::ValueChangedSignalType& ProgressBar::ValueChangedSignal()
252 return mValueChangedSignal;
255 void ProgressBar::SetProgressValue( float value )
257 // update the progress bar value (taking float precision errors into account)
258 // TODO : it seems 0.0f cannot into this statement.
259 if( ( mProgressValue != value ) &&
260 ( ( value >= DEFAULT_LOWER_BOUND ) || ( Equals( value, DEFAULT_LOWER_BOUND ) ) ) &&
261 ( ( value <= DEFAULT_UPPER_BOUND ) || ( Equals( value, DEFAULT_UPPER_BOUND ) ) ) )
263 mProgressValue = Clamp( value, DEFAULT_LOWER_BOUND, DEFAULT_UPPER_BOUND );
265 ApplyProgressToVisual( mProgressValue, Toolkit::ProgressBar::Property::PROGRESS_VISUAL, ProgressDepthIndex::PROGRESS_VISUAL );
267 Toolkit::ProgressBar self = Toolkit::ProgressBar::DownCast( Self() );
268 mValueChangedSignal.Emit( self, mProgressValue, mSecondaryProgressValue );
273 float ProgressBar::GetProgressValue() const
275 return mProgressValue;
278 void ProgressBar::SetSecondaryProgressValue( float value )
280 // update the progress bar value (taking float precision errors into account)
281 // TODO : it seems 0.0f cannot into this statement.
282 if( ( mSecondaryProgressValue != value ) &&
283 ( ( value >= DEFAULT_LOWER_BOUND ) || ( Equals( value, DEFAULT_LOWER_BOUND ) ) ) &&
284 ( ( value <= DEFAULT_UPPER_BOUND ) || ( Equals( value, DEFAULT_UPPER_BOUND ) ) ) )
286 mSecondaryProgressValue = Clamp( value, DEFAULT_LOWER_BOUND, DEFAULT_UPPER_BOUND );
288 ApplyProgressToVisual( mSecondaryProgressValue, Toolkit::ProgressBar::Property::SECONDARY_PROGRESS_VISUAL, ProgressDepthIndex::SECONDARY_PROGRESS_VISUAL );
290 Toolkit::ProgressBar self = Toolkit::ProgressBar::DownCast( Self() );
291 mValueChangedSignal.Emit( self, mProgressValue, mSecondaryProgressValue );
297 float ProgressBar::GetSecondaryProgressValue() const
299 return mSecondaryProgressValue;
302 void ProgressBar::SetIndeterminate( bool value )
304 mIndeterminate = value;
305 DevelControl::EnableVisual( *this, Toolkit::ProgressBar::Property::INDETERMINATE_VISUAL, mIndeterminate );
310 if( mIndeterminateVisualTransition )
312 PlayIndeterminateVisualTransition();
317 if( mIndeterminateVisualAni )
319 mIndeterminateVisualAni.Stop();
322 // Restore previous visual data after animation finished.
323 RestoreVisualProperties( this, Toolkit::ProgressBar::Property::TRACK_VISUAL, mTrackVisualMap, ProgressDepthIndex::TRACK_VISUAL );
324 RestoreVisualProperties( this, Toolkit::ProgressBar::Property::SECONDARY_PROGRESS_VISUAL, mSecondaryProgressVisualMap, ProgressDepthIndex::SECONDARY_PROGRESS_VISUAL );
325 RestoreVisualProperties( this, Toolkit::ProgressBar::Property::PROGRESS_VISUAL, mProgressVisualMap, ProgressDepthIndex::PROGRESS_VISUAL );
331 bool ProgressBar::GetIndeterminate() const
333 return mIndeterminate;
336 void ProgressBar::SetIndeterminateVisualTransition( Toolkit::TransitionData transition )
338 mIndeterminateVisualTransition = transition;
341 PlayIndeterminateVisualTransition();
345 void ProgressBar::PlayIndeterminateVisualTransition()
347 // Store current visual data before animation changes it.
348 BackupVisualProperties( this, Toolkit::ProgressBar::Property::TRACK_VISUAL, mTrackVisualMap );
349 BackupVisualProperties( this, Toolkit::ProgressBar::Property::SECONDARY_PROGRESS_VISUAL, mSecondaryProgressVisualMap );
350 BackupVisualProperties( this, Toolkit::ProgressBar::Property::PROGRESS_VISUAL, mProgressVisualMap );
352 if( mIndeterminateVisualAni )
354 mIndeterminateVisualAni.Stop();
355 mIndeterminateVisualAni.Clear();
358 mIndeterminateVisualAni = DevelControl::CreateTransition( *this, mIndeterminateVisualTransition );
360 if( mIndeterminate && mIndeterminateVisualAni )
362 mIndeterminateVisualAni.SetLooping(true);
363 mIndeterminateVisualAni.Play();
367 Toolkit::TransitionData ProgressBar::ConvertPropertyToTransition( const Property::Value& value )
369 Toolkit::TransitionData transitionData;
371 if( value.GetType() == Property::ARRAY )
373 transitionData = Toolkit::TransitionData::New( *value.GetArray() );
375 else if( value.GetType() == Property::MAP )
377 transitionData = Toolkit::TransitionData::New( *value.GetMap() );
380 return transitionData;
384 * Create Visual for given index from a property map or url.
385 * 1) Check if value passed in is a url and create visual
386 * 2) Create visual from map if step (1) is false
387 * 3) Register visual with control with false for enable flag.
388 * 4) Unregister visual if empty map was provided. This is the method to remove a visual
391 void ProgressBar::CreateVisualsForComponent( Property::Index index, const Property::Value& value, const int visualDepth )
393 Toolkit::VisualFactory visualFactory = Toolkit::VisualFactory::Get();
394 Toolkit::Visual::Base progressVisual;
396 std::string imageUrl;
397 if( value.Get( imageUrl ) )
399 if ( !imageUrl.empty() )
401 progressVisual = visualFactory.CreateVisual( imageUrl, ImageDimensions() );
404 else // Does this code make text-visual can be accepted as visual?
406 // if its not a string then get a Property::Map from the property if possible.
407 const Property::Map *map = value.GetMap();
408 if( map && !map->Empty() ) // Empty map results in current visual removal.
410 progressVisual = visualFactory.CreateVisual( *map );
414 if ( progressVisual )
416 if( index == Toolkit::ProgressBar::Property::INDETERMINATE_VISUAL )
418 DevelControl::RegisterVisual( *this, index, progressVisual, mIndeterminate, visualDepth );
422 DevelControl::RegisterVisual( *this, index, progressVisual, true, visualDepth );
427 DevelControl::UnregisterVisual( *this, index );
431 bool ProgressBar::GetPropertyMapForVisual( Property::Index visualIndex, Property::Map& retreivedMap ) const
433 bool success = false;
434 Toolkit::Visual::Base visual = DevelControl::GetVisual( *this, visualIndex );
438 visual.CreatePropertyMap( retreivedMap );
446 void ProgressBar::ApplyProgressToVisual( float progress, Property::Index index, int depth )
448 Toolkit::Visual::Base visual = DevelControl::GetVisual( *this, index );
450 if( visual && static_cast<DevelVisual::Type>( visual.GetType() ) == DevelVisual::ARC && !mIndeterminate )
452 Visual::Base& visualImpl = Toolkit::GetImplementation( visual );
456 map[ Toolkit::DevelArcVisual::Property::SWEEP_ANGLE ] = Property::Value( 360.0f * progress );
458 visualImpl.SetProperties( map );
460 DevelControl::UnregisterVisual( *this, index );
461 DevelControl::RegisterVisual( *this, index, visual, true, depth );
465 void ProgressBar::ApplyProgressToVisualTransform( float progress, Vector2 trackSize, Property::Index index )
467 Toolkit::Visual::Base visual = DevelControl::GetVisual( *this, index );
471 Property::Map visualTransform;
473 if( static_cast<DevelVisual::Type>( visual.GetType() ) != DevelVisual::ARC )
475 visualTransform.Add( Toolkit::Visual::Transform::Property::SIZE, Vector2( mDomain.from.x + progress * ( mDomain.to.x - mDomain.from.x ), trackSize.height ) )
476 .Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
477 .Add( Toolkit::Visual::Transform::Property::SIZE_POLICY, Vector2( Toolkit::Visual::Transform::Policy::ABSOLUTE, Toolkit::Visual::Transform::Policy::ABSOLUTE ) )
478 .Add( Toolkit::Visual::Transform::Property::ORIGIN, Toolkit::Align::TOP_BEGIN )
479 .Add( Toolkit::Visual::Transform::Property::ANCHOR_POINT, Toolkit::Align::TOP_BEGIN );
482 visual.SetTransformAndSize( visualTransform, trackSize );
486 // Static class method to support script connecting signals
487 bool ProgressBar::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
489 Dali::BaseHandle handle( object );
491 bool connected = true;
492 Toolkit::ProgressBar ProgressBar = Toolkit::ProgressBar::DownCast( handle );
494 if( 0 == strcmp( signalName.c_str(), SIGNAL_VALUE_CHANGED ) )
496 ProgressBar.ValueChangedSignal().Connect( tracker, functor );
500 // signalName does not match any signal
507 void ProgressBar::SetProperty( BaseObject* object, Property::Index propertyIndex, const Property::Value& value )
509 Toolkit::ProgressBar progressBar = Toolkit::ProgressBar::DownCast( Dali::BaseHandle( object ) );
513 ProgressBar& progressBarImpl( GetImpl( progressBar ) );
515 switch ( propertyIndex )
517 case Toolkit::ProgressBar::Property::TRACK_VISUAL:
519 progressBarImpl.CreateVisualsForComponent( propertyIndex, value, ProgressDepthIndex::TRACK_VISUAL );
523 case Toolkit::ProgressBar::Property::SECONDARY_PROGRESS_VISUAL:
525 progressBarImpl.CreateVisualsForComponent( propertyIndex, value, ProgressDepthIndex::SECONDARY_PROGRESS_VISUAL );
526 progressBarImpl.ApplyProgressToVisual( progressBarImpl.mSecondaryProgressValue, propertyIndex, ProgressDepthIndex::SECONDARY_PROGRESS_VISUAL );
530 case Toolkit::ProgressBar::Property::PROGRESS_VISUAL:
532 progressBarImpl.CreateVisualsForComponent( propertyIndex, value, ProgressDepthIndex::PROGRESS_VISUAL );
533 progressBarImpl.ApplyProgressToVisual( progressBarImpl.mProgressValue, propertyIndex, ProgressDepthIndex::PROGRESS_VISUAL );
537 case Toolkit::ProgressBar::Property::INDETERMINATE_VISUAL:
539 progressBarImpl.CreateVisualsForComponent( propertyIndex, value, ProgressDepthIndex::INDETERMINATE_VISUAL );
543 case Toolkit::ProgressBar::Property::LABEL_VISUAL:
546 std::string textString;
548 if ( value.Get( textString ) )
550 // set new text string as TEXT property
551 Property::Map newTextMap;
552 Toolkit::Visual::Base label = DevelControl::GetVisual( progressBarImpl, Toolkit::ProgressBar::Property::LABEL_VISUAL );
556 label.CreatePropertyMap( map );
559 // if LABEL_VISUAL doesn't set before, add Visual property "TYPE" to create new text Visual
562 newTextMap.Add( Toolkit::Visual::Property::TYPE, Toolkit::Visual::TEXT );
563 newTextMap.Add( Toolkit::TextVisual::Property::POINT_SIZE, DEFAULT_FONT_SIZE );
565 newTextMap.Add( Toolkit::TextVisual::Property::TEXT, textString );
567 map.Merge( newTextMap );
576 progressBarImpl.CreateVisualsForComponent( propertyIndex, map, ProgressDepthIndex::LABEL_VISUAL );
581 case Toolkit::ProgressBar::Property::PROGRESS_VALUE:
583 progressBarImpl.SetProgressValue( value.Get< float >() );
587 case Toolkit::ProgressBar::Property::SECONDARY_PROGRESS_VALUE:
589 progressBarImpl.SetSecondaryProgressValue( value.Get< float >() );
593 case Toolkit::ProgressBar::Property::INDETERMINATE:
595 progressBarImpl.SetIndeterminate( value.Get< bool >() );
599 case Toolkit::ProgressBar::Property::INDETERMINATE_VISUAL_ANIMATION:
601 progressBarImpl.SetIndeterminateVisualTransition( progressBarImpl.ConvertPropertyToTransition( value ) );
608 Property::Value ProgressBar::GetProperty( BaseObject* object, Property::Index propertyIndex )
610 Property::Value value;
612 Toolkit::ProgressBar progressBar = Toolkit::ProgressBar::DownCast( Dali::BaseHandle( object ) );
616 ProgressBar& progressBarImpl( GetImpl( progressBar ) );
618 switch ( propertyIndex )
620 case Toolkit::ProgressBar::Property::TRACK_VISUAL:
621 case Toolkit::ProgressBar::Property::PROGRESS_VISUAL:
622 case Toolkit::ProgressBar::Property::SECONDARY_PROGRESS_VISUAL:
623 case Toolkit::ProgressBar::Property::INDETERMINATE_VISUAL:
624 case Toolkit::ProgressBar::Property::LABEL_VISUAL:
626 Property::Map visualProperty;
627 if ( progressBarImpl.GetPropertyMapForVisual( propertyIndex, visualProperty ) )
629 value = visualProperty;
634 case Toolkit::ProgressBar::Property::PROGRESS_VALUE:
636 value = progressBarImpl.GetProgressValue();
640 case Toolkit::ProgressBar::Property::SECONDARY_PROGRESS_VALUE:
642 value = progressBarImpl.GetSecondaryProgressValue();
646 case Toolkit::ProgressBar::Property::INDETERMINATE:
648 value = progressBarImpl.GetIndeterminate();
652 case Toolkit::ProgressBar::Property::INDETERMINATE_VISUAL_ANIMATION:
654 //TODO: Return INDETERMINATE_VISUAL_TRANSITION;
662 void ProgressBar::OnSceneConnection( int depth )
664 // Chain up first (ensures visuals are ready to draw)
665 Control::OnSceneConnection( depth );
669 PlayIndeterminateVisualTransition();
673 } // namespace Internal
675 } // namespace Toolkit