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/public-api/actors/actor.h>
22 #include <dali/public-api/actors/layer.h>
23 #include <dali/public-api/animation/constraint.h>
24 #include <dali/public-api/common/dali-common.h>
25 #include <dali/public-api/math/radian.h>
26 #include <dali/public-api/math/vector2.h>
28 #include <dali/internal/event/actors/actor-impl.h>
29 #include <dali/internal/event/actors/layer-impl.h>
30 #include <dali/internal/event/rendering/renderer-impl.h>
31 #include <dali/internal/event/animation/constraint-impl.h>
32 #include <dali/internal/event/size-negotiation/relayout-controller-impl.h>
43 Internal::ActorPtr internal = Internal::Actor::New();
45 return Actor(internal.Get());
48 Actor Actor::DownCast( BaseHandle handle )
50 return Actor( dynamic_cast<Dali::Internal::Actor*>(handle.GetObjectPtr()) );
57 Actor::Actor(const Actor& copy)
62 Actor& Actor::operator=(const Actor& rhs)
64 BaseHandle::operator=(rhs);
68 const std::string& Actor::GetName() const
70 return GetImplementation(*this).GetName();
73 void Actor::SetName(const std::string& name)
75 GetImplementation(*this).SetName(name);
78 uint32_t Actor::GetId() const
80 return GetImplementation(*this).GetId();
83 bool Actor::IsRoot() const
85 return GetImplementation(*this).IsRoot();
88 bool Actor::OnStage() const
90 return GetImplementation(*this).OnStage();
93 bool Actor::IsLayer() const
95 return GetImplementation(*this).IsLayer();
98 Layer Actor::GetLayer()
100 return GetImplementation(*this).GetLayer();
103 void Actor::Add(Actor actor)
105 GetImplementation(*this).Add(GetImplementation(actor));
108 void Actor::Remove(Actor actor)
110 GetImplementation(*this).Remove(GetImplementation(actor));
113 void Actor::Unparent()
115 GetImplementation(*this).Unparent();
118 uint32_t Actor::GetChildCount() const
120 return GetImplementation(*this).GetChildCount();
123 Actor Actor::GetChildAt( uint32_t index ) const
125 Internal::ActorPtr child = GetImplementation(*this).GetChildAt( index );
126 return Actor( child.Get() );
129 Actor Actor::FindChildByName(const std::string& actorName)
131 Internal::ActorPtr child = GetImplementation(*this).FindChildByName( actorName );
132 return Actor( child.Get() );
135 Actor Actor::FindChildById( const uint32_t id )
137 Internal::ActorPtr child = GetImplementation(*this).FindChildById( id );
138 return Actor( child.Get() );
141 Actor Actor::GetParent() const
143 Internal::Actor* parent = GetImplementation(*this).GetParent();
145 return Actor(parent);
148 void Actor::SetParentOrigin(const Vector3& origin)
150 GetImplementation(*this).SetParentOrigin(origin);
153 Vector3 Actor::GetCurrentParentOrigin() const
155 return GetImplementation(*this).GetCurrentParentOrigin();
158 void Actor::SetAnchorPoint(const Vector3& anchorPoint)
160 GetImplementation(*this).SetAnchorPoint(anchorPoint);
163 Vector3 Actor::GetCurrentAnchorPoint() const
165 return GetImplementation(*this).GetCurrentAnchorPoint();
168 void Actor::SetSize(float width, float height)
170 GetImplementation(*this).SetSize(width, height);
173 void Actor::SetSize(float width, float height, float depth)
175 GetImplementation(*this).SetSize(width, height, depth);
178 void Actor::SetSize(const Vector2& size)
180 GetImplementation(*this).SetSize( size );
183 void Actor::SetSize(const Vector3& size)
185 GetImplementation(*this).SetSize( size );
188 Vector3 Actor::GetTargetSize() const
190 return GetImplementation(*this).GetTargetSize();
193 Vector3 Actor::GetCurrentSize() const
195 return GetImplementation(*this).GetCurrentSize();
198 Vector3 Actor::GetNaturalSize() const
200 return GetImplementation(*this).GetNaturalSize();
203 void Actor::SetPosition(float x, float y)
205 GetImplementation(*this).SetPosition(x, y);
208 void Actor::SetPosition(float x, float y, float z)
210 GetImplementation(*this).SetPosition(x, y, z);
213 void Actor::SetPosition(const Vector3& position)
215 GetImplementation(*this).SetPosition(position);
218 void Actor::SetX(float x)
220 GetImplementation(*this).SetX(x);
223 void Actor::SetY(float y)
225 GetImplementation(*this).SetY(y);
228 void Actor::SetZ(float z)
230 GetImplementation(*this).SetZ(z);
233 void Actor::TranslateBy(const Vector3& distance)
235 GetImplementation(*this).TranslateBy(distance);
238 Vector3 Actor::GetCurrentPosition() const
240 return GetImplementation(*this).GetCurrentPosition();
243 Vector3 Actor::GetCurrentWorldPosition() const
245 return GetImplementation(*this).GetCurrentWorldPosition();
248 void Actor::SetOrientation(const Radian& angle, const Vector3& axis)
250 GetImplementation(*this).SetOrientation(angle, axis);
253 void Actor::SetOrientation(const Quaternion& orientation)
255 GetImplementation(*this).SetOrientation(orientation);
258 void Actor::RotateBy(const Radian& angle, const Vector3& axis)
260 GetImplementation(*this).RotateBy(angle, axis);
263 void Actor::RotateBy(const Quaternion& relativeRotation)
265 GetImplementation(*this).RotateBy(relativeRotation);
268 Quaternion Actor::GetCurrentOrientation() const
270 return GetImplementation(*this).GetCurrentOrientation();
273 void Actor::SetInheritOrientation(bool inherit)
275 GetImplementation(*this).SetInheritOrientation(inherit);
278 bool Actor::IsOrientationInherited() const
280 return GetImplementation(*this).IsOrientationInherited();
283 Quaternion Actor::GetCurrentWorldOrientation() const
285 return GetImplementation(*this).GetCurrentWorldOrientation();
288 void Actor::SetScale(float scale)
290 GetImplementation(*this).SetScale(scale);
293 void Actor::SetScale(float scaleX, float scaleY, float scaleZ)
295 GetImplementation(*this).SetScale(scaleX, scaleY, scaleZ);
298 void Actor::SetScale(const Vector3& scale)
300 GetImplementation(*this).SetScale(scale);
303 void Actor::ScaleBy(const Vector3& relativeScale)
305 GetImplementation(*this).ScaleBy(relativeScale);
308 Vector3 Actor::GetCurrentScale() const
310 return GetImplementation(*this).GetCurrentScale();
313 Vector3 Actor::GetCurrentWorldScale() const
315 return GetImplementation(*this).GetCurrentWorldScale();
318 void Actor::SetInheritScale( bool inherit )
320 GetImplementation(*this).SetInheritScale( inherit );
323 bool Actor::IsScaleInherited() const
325 return GetImplementation(*this).IsScaleInherited();
328 void Actor::SetSizeModeFactor(const Vector3& factor)
330 GetImplementation(*this).SetSizeModeFactor(factor);
333 Vector3 Actor::GetSizeModeFactor() const
335 return GetImplementation(*this).GetSizeModeFactor();
338 Matrix Actor::GetCurrentWorldMatrix() const
340 return GetImplementation(*this).GetCurrentWorldMatrix();
343 void Actor::SetVisible(bool visible)
345 GetImplementation(*this).SetVisible(visible);
348 bool Actor::IsVisible() const
350 return GetImplementation(*this).IsVisible();
353 void Actor::SetOpacity(float opacity)
355 GetImplementation(*this).SetOpacity(opacity);
358 float Actor::GetCurrentOpacity() const
360 return GetImplementation(*this).GetCurrentOpacity();
363 void Actor::SetColor(const Vector4& color)
365 GetImplementation(*this).SetColor(color);
368 Vector4 Actor::GetCurrentColor() const
370 return GetImplementation(*this).GetCurrentColor();
373 void Actor::SetColorMode( ColorMode colorMode )
375 GetImplementation(*this).SetColorMode(colorMode);
378 ColorMode Actor::GetColorMode() const
380 return GetImplementation(*this).GetColorMode();
383 Vector4 Actor::GetCurrentWorldColor() const
385 return GetImplementation(*this).GetCurrentWorldColor();
388 void Actor::SetDrawMode( DrawMode::Type drawMode )
390 GetImplementation(*this).SetDrawMode( drawMode );
393 DrawMode::Type Actor::GetDrawMode() const
395 return GetImplementation(*this).GetDrawMode();
398 void Actor::SetSensitive(bool sensitive)
400 GetImplementation(*this).SetSensitive(sensitive);
403 bool Actor::IsSensitive() const
405 return GetImplementation(*this).IsSensitive();
408 bool Actor::ScreenToLocal(float& localX, float& localY, float screenX, float screenY) const
410 return GetImplementation(*this).ScreenToLocal(localX, localY, screenX, screenY);
413 void Actor::SetLeaveRequired(bool required)
415 GetImplementation(*this).SetLeaveRequired(required);
418 bool Actor::GetLeaveRequired() const
420 return GetImplementation(*this).GetLeaveRequired();
423 void Actor::SetKeyboardFocusable( bool focusable )
425 GetImplementation(*this).SetKeyboardFocusable(focusable);
428 bool Actor::IsKeyboardFocusable() const
430 return GetImplementation(*this).IsKeyboardFocusable();
435 GetImplementation( *this ).Raise();
440 GetImplementation( *this ).Lower();
443 void Actor::RaiseToTop()
445 GetImplementation( *this ).RaiseToTop();
448 void Actor::LowerToBottom()
450 GetImplementation( *this ).LowerToBottom();
453 void Actor::RaiseAbove( Actor target )
455 GetImplementation( *this ).RaiseAbove( GetImplementation( target ) );
458 void Actor::LowerBelow( Actor target )
460 GetImplementation( *this ).LowerBelow( GetImplementation( target ) );
463 void Actor::SetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension )
465 GetImplementation(*this).SetResizePolicy( policy, dimension );
468 ResizePolicy::Type Actor::GetResizePolicy( Dimension::Type dimension ) const
470 return GetImplementation(*this).GetResizePolicy( dimension );
473 void Actor::SetSizeScalePolicy( SizeScalePolicy::Type policy )
475 GetImplementation(*this).SetSizeScalePolicy( policy );
478 SizeScalePolicy::Type Actor::GetSizeScalePolicy() const
480 return GetImplementation(*this).GetSizeScalePolicy();
483 float Actor::GetHeightForWidth( float width )
485 return GetImplementation(*this).GetHeightForWidth( width );
488 float Actor::GetWidthForHeight( float height )
490 return GetImplementation(*this).GetWidthForHeight( height );
493 float Actor::GetRelayoutSize( Dimension::Type dimension ) const
495 return GetImplementation(*this).GetRelayoutSize( dimension );
498 void Actor::SetPadding( const Padding& padding )
500 Internal::Actor& impl = GetImplementation(*this);
502 Vector2 widthPadding( padding.left, padding.right );
503 impl.SetPadding( widthPadding, Dimension::WIDTH );
505 Vector2 heightPadding( padding.bottom, padding.top );
506 impl.SetPadding( heightPadding, Dimension::HEIGHT );
509 void Actor::GetPadding( Padding& paddingOut ) const
511 const Internal::Actor& impl = GetImplementation(*this);
513 Vector2 widthPadding = impl.GetPadding( Dimension::WIDTH );
514 Vector2 heightPadding = impl.GetPadding( Dimension::HEIGHT );
516 paddingOut.left = widthPadding.x;
517 paddingOut.right = widthPadding.y;
518 paddingOut.bottom = heightPadding.x;
519 paddingOut.top = heightPadding.y;
522 void Actor::SetMinimumSize( const Vector2& size )
524 Internal::Actor& impl = GetImplementation(*this);
526 impl.SetMinimumSize( size.x, Dimension::WIDTH );
527 impl.SetMinimumSize( size.y, Dimension::HEIGHT );
530 Vector2 Actor::GetMinimumSize()
532 Internal::Actor& impl = GetImplementation(*this);
534 return Vector2( impl.GetMinimumSize( Dimension::WIDTH ), impl.GetMinimumSize( Dimension::HEIGHT ) );
537 void Actor::SetMaximumSize( const Vector2& size )
539 Internal::Actor& impl = GetImplementation(*this);
541 impl.SetMaximumSize( size.x, Dimension::WIDTH );
542 impl.SetMaximumSize( size.y, Dimension::HEIGHT );
545 Vector2 Actor::GetMaximumSize()
547 Internal::Actor& impl = GetImplementation(*this);
549 return Vector2( impl.GetMaximumSize( Dimension::WIDTH ), impl.GetMaximumSize( Dimension::HEIGHT ) );
552 int32_t Actor::GetHierarchyDepth()
554 return GetImplementation(*this).GetHierarchyDepth();
557 Actor::TouchSignalType& Actor::TouchedSignal()
559 DALI_LOG_WARNING_NOFN("DEPRECATION WARNING: TouchedSignal() is deprecated and will be removed from next release. Use TouchSignal() instead.\n" );
561 return GetImplementation(*this).TouchedSignal();
564 Actor::TouchDataSignalType& Actor::TouchSignal()
566 return GetImplementation( *this ).TouchSignal();
569 Actor::HoverSignalType& Actor::HoveredSignal()
571 return GetImplementation(*this).HoveredSignal();
574 Actor::WheelEventSignalType& Actor::WheelEventSignal()
576 return GetImplementation(*this).WheelEventSignal();
579 Actor::OnStageSignalType& Actor::OnStageSignal()
581 return GetImplementation(*this).OnStageSignal();
584 Actor::OffStageSignalType& Actor::OffStageSignal()
586 return GetImplementation(*this).OffStageSignal();
589 uint32_t Actor::AddRenderer( Renderer& renderer )
591 return GetImplementation(*this).AddRenderer( GetImplementation( renderer ) );
594 uint32_t Actor::GetRendererCount() const
596 return GetImplementation(*this).GetRendererCount();
599 Renderer Actor::GetRendererAt( uint32_t index )
601 Internal::RendererPtr renderer = GetImplementation(*this).GetRendererAt( index );
602 return Renderer( renderer.Get() );
605 void Actor::RemoveRenderer( Renderer& renderer )
607 GetImplementation(*this).RemoveRenderer( GetImplementation( renderer ) );
610 void Actor::RemoveRenderer( uint32_t index )
612 GetImplementation(*this).RemoveRenderer( index );
615 Actor::OnRelayoutSignalType& Actor::OnRelayoutSignal()
617 return GetImplementation(*this).OnRelayoutSignal();
620 Actor::LayoutDirectionChangedSignalType& Actor::LayoutDirectionChangedSignal()
622 return GetImplementation( *this ).LayoutDirectionChangedSignal();
625 Actor::Actor(Internal::Actor* internal)