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 unsigned int 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 unsigned int Actor::GetChildCount() const
120 return GetImplementation(*this).GetChildCount();
123 Actor Actor::GetChildAt(unsigned int 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 unsigned int 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::SetPositionInheritanceMode( PositionInheritanceMode mode )
250 DALI_LOG_WARNING_NOFN("DEPRECATION WARNING: SetPositionInheritanceMode() is deprecated and will be removed from next release. Use SetInheritPosition() instead.\n" );
252 GetImplementation(*this).SetPositionInheritanceMode( mode );
255 PositionInheritanceMode Actor::GetPositionInheritanceMode() const
257 DALI_LOG_WARNING_NOFN("DEPRECATION WARNING: GetPositionInheritanceMode() is deprecated and will be removed from next release. Use IsPositionInherited() instead.\n" );
259 return GetImplementation(*this).GetPositionInheritanceMode();
262 void Actor::SetOrientation(const Radian& angle, const Vector3& axis)
264 GetImplementation(*this).SetOrientation(angle, axis);
267 void Actor::SetOrientation(const Quaternion& orientation)
269 GetImplementation(*this).SetOrientation(orientation);
272 void Actor::RotateBy(const Radian& angle, const Vector3& axis)
274 GetImplementation(*this).RotateBy(angle, axis);
277 void Actor::RotateBy(const Quaternion& relativeRotation)
279 GetImplementation(*this).RotateBy(relativeRotation);
282 Quaternion Actor::GetCurrentOrientation() const
284 return GetImplementation(*this).GetCurrentOrientation();
287 void Actor::SetInheritOrientation(bool inherit)
289 GetImplementation(*this).SetInheritOrientation(inherit);
292 bool Actor::IsOrientationInherited() const
294 return GetImplementation(*this).IsOrientationInherited();
297 Quaternion Actor::GetCurrentWorldOrientation() const
299 return GetImplementation(*this).GetCurrentWorldOrientation();
302 void Actor::SetScale(float scale)
304 GetImplementation(*this).SetScale(scale);
307 void Actor::SetScale(float scaleX, float scaleY, float scaleZ)
309 GetImplementation(*this).SetScale(scaleX, scaleY, scaleZ);
312 void Actor::SetScale(const Vector3& scale)
314 GetImplementation(*this).SetScale(scale);
317 void Actor::ScaleBy(const Vector3& relativeScale)
319 GetImplementation(*this).ScaleBy(relativeScale);
322 Vector3 Actor::GetCurrentScale() const
324 return GetImplementation(*this).GetCurrentScale();
327 Vector3 Actor::GetCurrentWorldScale() const
329 return GetImplementation(*this).GetCurrentWorldScale();
332 void Actor::SetInheritScale( bool inherit )
334 GetImplementation(*this).SetInheritScale( inherit );
337 bool Actor::IsScaleInherited() const
339 return GetImplementation(*this).IsScaleInherited();
342 void Actor::SetSizeModeFactor(const Vector3& factor)
344 GetImplementation(*this).SetSizeModeFactor(factor);
347 Vector3 Actor::GetSizeModeFactor() const
349 return GetImplementation(*this).GetSizeModeFactor();
352 Matrix Actor::GetCurrentWorldMatrix() const
354 return GetImplementation(*this).GetCurrentWorldMatrix();
357 void Actor::SetVisible(bool visible)
359 GetImplementation(*this).SetVisible(visible);
362 bool Actor::IsVisible() const
364 return GetImplementation(*this).IsVisible();
367 void Actor::SetOpacity(float opacity)
369 GetImplementation(*this).SetOpacity(opacity);
372 float Actor::GetCurrentOpacity() const
374 return GetImplementation(*this).GetCurrentOpacity();
377 void Actor::SetColor(const Vector4& color)
379 GetImplementation(*this).SetColor(color);
382 Vector4 Actor::GetCurrentColor() const
384 return GetImplementation(*this).GetCurrentColor();
387 void Actor::SetColorMode( ColorMode colorMode )
389 GetImplementation(*this).SetColorMode(colorMode);
392 ColorMode Actor::GetColorMode() const
394 return GetImplementation(*this).GetColorMode();
397 Vector4 Actor::GetCurrentWorldColor() const
399 return GetImplementation(*this).GetCurrentWorldColor();
402 void Actor::SetDrawMode( DrawMode::Type drawMode )
404 GetImplementation(*this).SetDrawMode( drawMode );
407 DrawMode::Type Actor::GetDrawMode() const
409 return GetImplementation(*this).GetDrawMode();
412 void Actor::SetSensitive(bool sensitive)
414 GetImplementation(*this).SetSensitive(sensitive);
417 bool Actor::IsSensitive() const
419 return GetImplementation(*this).IsSensitive();
422 bool Actor::ScreenToLocal(float& localX, float& localY, float screenX, float screenY) const
424 return GetImplementation(*this).ScreenToLocal(localX, localY, screenX, screenY);
427 void Actor::SetLeaveRequired(bool required)
429 GetImplementation(*this).SetLeaveRequired(required);
432 bool Actor::GetLeaveRequired() const
434 return GetImplementation(*this).GetLeaveRequired();
437 void Actor::SetKeyboardFocusable( bool focusable )
439 GetImplementation(*this).SetKeyboardFocusable(focusable);
442 bool Actor::IsKeyboardFocusable() const
444 return GetImplementation(*this).IsKeyboardFocusable();
449 GetImplementation( *this ).Raise();
454 GetImplementation( *this ).Lower();
457 void Actor::RaiseToTop()
459 GetImplementation( *this ).RaiseToTop();
462 void Actor::LowerToBottom()
464 GetImplementation( *this ).LowerToBottom();
467 void Actor::RaiseAbove( Actor target )
469 GetImplementation( *this ).RaiseAbove( GetImplementation( target ) );
472 void Actor::LowerBelow( Actor target )
474 GetImplementation( *this ).LowerBelow( GetImplementation( target ) );
477 void Actor::SetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension )
479 GetImplementation(*this).SetResizePolicy( policy, dimension );
482 ResizePolicy::Type Actor::GetResizePolicy( Dimension::Type dimension ) const
484 return GetImplementation(*this).GetResizePolicy( dimension );
487 void Actor::SetSizeScalePolicy( SizeScalePolicy::Type policy )
489 GetImplementation(*this).SetSizeScalePolicy( policy );
492 SizeScalePolicy::Type Actor::GetSizeScalePolicy() const
494 return GetImplementation(*this).GetSizeScalePolicy();
497 float Actor::GetHeightForWidth( float width )
499 return GetImplementation(*this).GetHeightForWidth( width );
502 float Actor::GetWidthForHeight( float height )
504 return GetImplementation(*this).GetWidthForHeight( height );
507 float Actor::GetRelayoutSize( Dimension::Type dimension ) const
509 return GetImplementation(*this).GetRelayoutSize( dimension );
512 void Actor::SetPadding( const Padding& padding )
514 Internal::Actor& impl = GetImplementation(*this);
516 Vector2 widthPadding( padding.left, padding.right );
517 impl.SetPadding( widthPadding, Dimension::WIDTH );
519 Vector2 heightPadding( padding.bottom, padding.top );
520 impl.SetPadding( heightPadding, Dimension::HEIGHT );
523 void Actor::GetPadding( Padding& paddingOut ) const
525 const Internal::Actor& impl = GetImplementation(*this);
527 Vector2 widthPadding = impl.GetPadding( Dimension::WIDTH );
528 Vector2 heightPadding = impl.GetPadding( Dimension::HEIGHT );
530 paddingOut.left = widthPadding.x;
531 paddingOut.right = widthPadding.y;
532 paddingOut.bottom = heightPadding.x;
533 paddingOut.top = heightPadding.y;
536 void Actor::SetMinimumSize( const Vector2& size )
538 Internal::Actor& impl = GetImplementation(*this);
540 impl.SetMinimumSize( size.x, Dimension::WIDTH );
541 impl.SetMinimumSize( size.y, Dimension::HEIGHT );
544 Vector2 Actor::GetMinimumSize()
546 Internal::Actor& impl = GetImplementation(*this);
548 return Vector2( impl.GetMinimumSize( Dimension::WIDTH ), impl.GetMinimumSize( Dimension::HEIGHT ) );
551 void Actor::SetMaximumSize( const Vector2& size )
553 Internal::Actor& impl = GetImplementation(*this);
555 impl.SetMaximumSize( size.x, Dimension::WIDTH );
556 impl.SetMaximumSize( size.y, Dimension::HEIGHT );
559 Vector2 Actor::GetMaximumSize()
561 Internal::Actor& impl = GetImplementation(*this);
563 return Vector2( impl.GetMaximumSize( Dimension::WIDTH ), impl.GetMaximumSize( Dimension::HEIGHT ) );
566 int Actor::GetHierarchyDepth()
568 return GetImplementation(*this).GetHierarchyDepth();
571 Actor::TouchSignalType& Actor::TouchedSignal()
573 DALI_LOG_WARNING_NOFN("DEPRECATION WARNING: TouchedSignal() is deprecated and will be removed from next release. Use TouchSignal() instead.\n" );
575 return GetImplementation(*this).TouchedSignal();
578 Actor::TouchDataSignalType& Actor::TouchSignal()
580 return GetImplementation( *this ).TouchSignal();
583 Actor::HoverSignalType& Actor::HoveredSignal()
585 return GetImplementation(*this).HoveredSignal();
588 Actor::WheelEventSignalType& Actor::WheelEventSignal()
590 return GetImplementation(*this).WheelEventSignal();
593 Actor::OnStageSignalType& Actor::OnStageSignal()
595 return GetImplementation(*this).OnStageSignal();
598 Actor::OffStageSignalType& Actor::OffStageSignal()
600 return GetImplementation(*this).OffStageSignal();
603 unsigned int Actor::AddRenderer( Renderer& renderer )
605 return GetImplementation(*this).AddRenderer( GetImplementation( renderer ) );
608 unsigned int Actor::GetRendererCount() const
610 return GetImplementation(*this).GetRendererCount();
613 Renderer Actor::GetRendererAt( unsigned int index )
615 Internal::RendererPtr renderer = GetImplementation(*this).GetRendererAt( index );
616 return Renderer( renderer.Get() );
619 void Actor::RemoveRenderer( Renderer& renderer )
621 GetImplementation(*this).RemoveRenderer( GetImplementation( renderer ) );
624 void Actor::RemoveRenderer( unsigned int index )
626 GetImplementation(*this).RemoveRenderer( index );
629 Actor::OnRelayoutSignalType& Actor::OnRelayoutSignal()
631 return GetImplementation(*this).OnRelayoutSignal();
634 Actor::LayoutDirectionChangedSignalType& Actor::LayoutDirectionChangedSignal()
636 return GetImplementation( *this ).LayoutDirectionChangedSignal();
639 Actor::Actor(Internal::Actor* internal)