Dali 3D User Interface Engine
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Attributes
Dali::Internal::Actor Class Reference

Actor is the primary object which Dali applications interact with. More...

#include <actor-impl.h>

Inheritance diagram for Dali::Internal::Actor:
Inheritance graph
[legend]
Collaboration diagram for Dali::Internal::Actor:
Collaboration graph
[legend]

Classes

struct  ActorDimensionPair
 Struct to hold an actor and a dimension. More...
 
struct  RelayoutData
 Struct to collect relayout variables. More...
 

Public Types

typedef std::vector
< ActorDimensionPair
ActorDimensionStack
 
- Public Types inherited from Dali::Internal::Object
typedef Dali::Handle::Capability Capability
 

Public Member Functions

const std::string & GetName () const
 Retrieve the name of the actor. More...
 
void SetName (const std::string &name)
 Set the name of the actor. More...
 
unsigned int GetId () const
 Retrieve the unique ID of the actor. More...
 
void Attach (ActorAttachment &attachment)
 Attach an object to an actor. More...
 
ActorAttachmentPtr GetAttachment ()
 Retreive the object attached to an actor. More...
 
bool IsRoot () const
 Query whether an actor is the root actor, which is owned by the Stage. More...
 
bool OnStage () const
 Query whether the actor is connected to the Stage. More...
 
bool IsRenderable () const
 Query whether the actor has any renderers. More...
 
bool IsLayer () const
 Query whether the actor is of class Dali::Layer. More...
 
Dali::Layer GetLayer ()
 Gets the layer in which the actor is present. More...
 
void Add (Actor &child)
 Adds a child Actor to this Actor. More...
 
void Remove (Actor &child)
 Removes a child Actor from this Actor. More...
 
void Unparent ()
 Removes an actor from its parent. More...
 
unsigned int GetChildCount () const
 Retrieve the number of children held by the actor. More...
 
ActorPtr GetChildAt (unsigned int index) const
 Retrieve and child actor by index. More...
 
ActorContainerGetChildrenInternal ()
 Retrieve a reference to Actor's children. More...
 
ActorPtr FindChildByName (const std::string &actorName)
 Search through this actor's hierarchy for an actor with the given name. More...
 
ActorPtr FindChildById (const unsigned int id)
 Search through this actor's hierarchy for an actor with the given unique ID. More...
 
ActorGetParent () const
 Retrieve the parent of an Actor. More...
 
void SetSize (float width, float height)
 Sets the size of an actor. More...
 
void SetSize (float width, float height, float depth)
 Sets the size of an actor. More...
 
void SetSize (const Vector2 &size)
 Sets the size of an actor. More...
 
void SetSizeInternal (const Vector2 &size)
 Sets the update size for an actor. More...
 
void SetSize (const Vector3 &size)
 Sets the size of an actor. More...
 
void SetSizeInternal (const Vector3 &size)
 Sets the update size for an actor. More...
 
void SetWidth (float width)
 Set the width component of the Actor's size. More...
 
void SetHeight (float height)
 Set the height component of the Actor's size. More...
 
void SetDepth (float depth)
 Set the depth component of the Actor's size. More...
 
const Vector3GetTargetSize () const
 Retrieve the Actor's size from event side. More...
 
const Vector3GetCurrentSize () const
 Retrieve the Actor's size from update side. More...
 
virtual Vector3 GetNaturalSize () const
 Return the natural size of the actor. More...
 
void SetParentOrigin (const Vector3 &origin)
 Set the origin of an actor, within its parent's area. More...
 
void SetParentOriginX (float x)
 Set the x component of the parent-origin. More...
 
void SetParentOriginY (float y)
 Set the y component of the parent-origin. More...
 
void SetParentOriginZ (float z)
 Set the z component of the parent-origin. More...
 
const Vector3GetCurrentParentOrigin () const
 Retrieve the parent-origin of an actor. More...
 
void SetAnchorPoint (const Vector3 &anchorPoint)
 Set the anchor-point of an actor. More...
 
void SetAnchorPointX (float x)
 Set the x component of the anchor-point. More...
 
void SetAnchorPointY (float y)
 Set the y component of the anchor-point. More...
 
void SetAnchorPointZ (float z)
 Set the z component of the anchor-point. More...
 
const Vector3GetCurrentAnchorPoint () const
 Retrieve the anchor-point of an actor. More...
 
void SetPosition (float x, float y)
 Sets the position of the Actor. More...
 
void SetPosition (float x, float y, float z)
 Sets the position of the Actor. More...
 
void SetPosition (const Vector3 &position)
 Sets the position of the Actor. More...
 
void SetX (float x)
 Set the position of an actor along the X-axis. More...
 
void SetY (float y)
 Set the position of an actor along the Y-axis. More...
 
void SetZ (float z)
 Set the position of an actor along the Z-axis. More...
 
void TranslateBy (const Vector3 &distance)
 Translate an actor relative to its existing position. More...
 
const Vector3GetCurrentPosition () const
 Retrieve the position of the Actor. More...
 
const Vector3GetTargetPosition () const
 Retrieve the target position of the Actor. More...
 
const Vector3GetCurrentWorldPosition () const
 Retrieve the world-position of the Actor. More...
 
void SetPositionInheritanceMode (PositionInheritanceMode mode)
 Set the actors position inheritance mode. More...
 
PositionInheritanceMode GetPositionInheritanceMode () const
 Returns the actors position inheritance mode. More...
 
void SetOrientation (const Radian &angleRadians, const Vector3 &axis)
 Sets the orientation of the Actor. More...
 
void SetOrientation (const Quaternion &orientation)
 Sets the orientation of the Actor. More...
 
void RotateBy (const Radian &angleRadians, const Vector3 &axis)
 Rotate an actor around its existing rotation axis. More...
 
void RotateBy (const Quaternion &relativeRotation)
 Apply a relative rotation to an actor. More...
 
const QuaternionGetCurrentOrientation () const
 Retreive the Actor's orientation. More...
 
void SetInheritOrientation (bool inherit)
 Set whether a child actor inherits it's parent's orientation. More...
 
bool IsOrientationInherited () const
 Returns whether the actor inherit's it's parent's orientation. More...
 
void SetSizeModeFactor (const Vector3 &factor)
 Sets the factor of the parents size used for the child actor. More...
 
const Vector3GetSizeModeFactor () const
 Gets the factor of the parents size used for the child actor. More...
 
const QuaternionGetCurrentWorldOrientation () const
 Retrieve the world-orientation of the Actor. More...
 
void SetScale (float scale)
 Sets a scale factor applied to an actor. More...
 
void SetScale (float scaleX, float scaleY, float scaleZ)
 Sets a scale factor applied to an actor. More...
 
void SetScale (const Vector3 &scale)
 Sets a scale factor applied to an actor. More...
 
void SetScaleX (float x)
 Set the x component of the scale factor. More...
 
void SetScaleY (float y)
 Set the y component of the scale factor. More...
 
void SetScaleZ (float z)
 Set the z component of the scale factor. More...
 
void ScaleBy (const Vector3 &relativeScale)
 Apply a relative scale to an actor. More...
 
const Vector3GetCurrentScale () const
 Retrieve the scale factor applied to an actor. More...
 
const Vector3GetCurrentWorldScale () const
 Retrieve the world-scale of the Actor. More...
 
void SetInheritScale (bool inherit)
 Set whether a child actor inherits it's parent's scale. More...
 
bool IsScaleInherited () const
 Returns whether the actor inherits its parent's scale. More...
 
Matrix GetCurrentWorldMatrix () const
 Retrieves the world-matrix of the actor. More...
 
void SetVisible (bool visible)
 Sets the visibility flag of an actor. More...
 
bool IsVisible () const
 Retrieve the visibility flag of an actor. More...
 
void SetOpacity (float opacity)
 Sets the opacity of an actor. More...
 
float GetCurrentOpacity () const
 Retrieve the actor's opacity. More...
 
void SetSensitive (bool sensitive)
 Sets whether an actor should emit touch or hover signals; see SignalTouch() and SignalHover(). More...
 
bool IsSensitive () const
 Query whether an actor emits touch or hover event signals. More...
 
void SetDrawMode (DrawMode::Type drawMode)
 Set how the actor and its children should be drawn. More...
 
DrawMode::Type GetDrawMode () const
 Query how the actor and its children will be drawn. More...
 
void SetOverlay (bool enable)
  More...
 
bool IsOverlay () const
  More...
 
void SetColor (const Vector4 &color)
 Sets the actor's color. More...
 
void SetColorRed (float red)
 Set the red component of the color. More...
 
void SetColorGreen (float green)
 Set the green component of the color. More...
 
void SetColorBlue (float blue)
 Set the blue component of the scale factor. More...
 
const Vector4GetCurrentColor () const
 Retrieve the actor's color. More...
 
void SetColorMode (ColorMode colorMode)
 Sets the actor's color mode. More...
 
ColorMode GetColorMode () const
 Returns the actor's color mode. More...
 
const Vector4GetCurrentWorldColor () const
 Retrieve the world-color of the Actor, where each component is clamped within the 0->1 range. More...
 
int GetHierarchyDepth () const
 Get depth in the hierarchy for the actor. More...
 
virtual void OnRelayout (const Vector2 &size, RelayoutContainer &container)
 Called after the size negotiation has been finished for this control. More...
 
virtual void OnSetResizePolicy (ResizePolicy::Type policy, Dimension::Type dimension)
 Notification for deriving classes when the resize policy is set. More...
 
virtual void OnCalculateRelayoutSize (Dimension::Type dimension)
 Virtual method to notify deriving classes that relayout dependencies have been met and the size for this object is about to be calculated for the given dimension. More...
 
virtual void OnLayoutNegotiated (float size, Dimension::Type dimension)
 Virtual method to notify deriving classes that the size for a dimension has just been negotiated. More...
 
virtual bool RelayoutDependentOnChildren (Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Determine if this actor is dependent on it's children for relayout. More...
 
virtual bool RelayoutDependentOnChildrenBase (Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Determine if this actor is dependent on it's children for relayout. More...
 
virtual float CalculateChildSize (const Dali::Actor &child, Dimension::Type dimension)
 Calculate the size for a child. More...
 
virtual float GetHeightForWidth (float width)
 This method is called during size negotiation when a height is required for a given width. More...
 
virtual float GetWidthForHeight (float height)
 This method is called during size negotiation when a width is required for a given height. More...
 
void NegotiateSize (const Vector2 &size, RelayoutContainer &container)
 Called by the RelayoutController to negotiate the size of an actor. More...
 
void SetResizePolicy (ResizePolicy::Type policy, Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Set the resize policy to be used for the given dimension(s). More...
 
ResizePolicy::Type GetResizePolicy (Dimension::Type dimension) const
 Return the resize policy used for a single dimension. More...
 
void SetSizeScalePolicy (SizeScalePolicy::Type policy)
 Set the policy to use when setting size with size negotiation. More...
 
SizeScalePolicy::Type GetSizeScalePolicy () const
 Return the size scale policy in use. More...
 
void SetDimensionDependency (Dimension::Type dimension, Dimension::Type dependency)
  More...
 
Dimension::Type GetDimensionDependency (Dimension::Type dimension) const
  More...
 
void SetRelayoutEnabled (bool relayoutEnabled)
 Set the size negotiation relayout enabled on this actor. More...
 
bool IsRelayoutEnabled () const
 Return if relayout is enabled. More...
 
void SetLayoutDirty (bool dirty, Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Mark an actor as having it's layout dirty. More...
 
bool IsLayoutDirty (Dimension::Type dimension=Dimension::ALL_DIMENSIONS) const
 Return if any of an actor's dimensions are marked as dirty. More...
 
bool RelayoutPossible (Dimension::Type dimension=Dimension::ALL_DIMENSIONS) const
 Returns if relayout is enabled and the actor is not dirty. More...
 
bool RelayoutRequired (Dimension::Type dimension=Dimension::ALL_DIMENSIONS) const
 Returns if relayout is enabled and the actor is dirty. More...
 
void RelayoutRequest (Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Request a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene) More...
 
bool RelayoutDependentOnParent (Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Determine if this actor is dependent on it's parent for relayout. More...
 
bool RelayoutDependentOnDimension (Dimension::Type dimension, Dimension::Type dependentDimension)
 Determine if this actor has another dimension depedent on the specified one. More...
 
void NegotiateDimensions (const Vector2 &allocatedSize)
 Negotiate sizes for a control in all dimensions. More...
 
void NegotiateDimension (Dimension::Type dimension, const Vector2 &allocatedSize, ActorDimensionStack &recursionStack)
 Negotiate size for a specific dimension. More...
 
float CalculateSize (Dimension::Type dimension, const Vector2 &maximumSize)
 Calculate the size of a dimension. More...
 
float ClampDimension (float size, Dimension::Type dimension)
 Clamp a dimension given the relayout constraints on this actor. More...
 
float NegotiateFromParent (Dimension::Type dimension)
 Negotiate a dimension based on the size of the parent. More...
 
float NegotiateFromParentFit (Dimension::Type dimension)
 Negotiate a dimension based on the size of the parent. More...
 
float NegotiateFromParentFlood (Dimension::Type dimension)
 Negotiate a dimension based on the size of the parent. More...
 
float NegotiateFromChildren (Dimension::Type dimension)
 Negotiate a dimension based on the size of the children. More...
 
void SetNegotiatedDimension (float negotiatedDimension, Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Set the negotiated dimension value for the given dimension(s) More...
 
float GetNegotiatedDimension (Dimension::Type dimension) const
 Return the value of negotiated dimension for the given dimension. More...
 
void SetPadding (const Vector2 &padding, Dimension::Type dimension)
 Set the padding for a dimension. More...
 
Vector2 GetPadding (Dimension::Type dimension) const
 Return the value of padding for the given dimension. More...
 
float GetSize (Dimension::Type dimension) const
 Return the actor size for a given dimension. More...
 
float GetNaturalSize (Dimension::Type dimension) const
 Return the natural size of the actor for a given dimension. More...
 
float GetRelayoutSize (Dimension::Type dimension) const
 Return the amount of size allocated for relayout. More...
 
float GetLatestSize (Dimension::Type dimension) const
 If the size has been negotiated return that else return normal size. More...
 
void SetNegotiatedSize (RelayoutContainer &container)
 Apply the negotiated size to the actor. More...
 
void SetLayoutNegotiated (bool negotiated, Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Flag the actor as having it's layout dimension negotiated. More...
 
bool IsLayoutNegotiated (Dimension::Type dimension=Dimension::ALL_DIMENSIONS) const
 Test whether the layout dimension for this actor has been negotiated or not. More...
 
float GetHeightForWidthBase (float width)
 provides the Actor implementation of GetHeightForWidth More...
 
float GetWidthForHeightBase (float height)
 provides the Actor implementation of GetWidthForHeight More...
 
float CalculateChildSizeBase (const Dali::Actor &child, Dimension::Type dimension)
 Calculate the size for a child. More...
 
void SetPreferredSize (const Vector2 &size)
 Set the preferred size for size negotiation. More...
 
Vector2 GetPreferredSize () const
 Return the preferred size used for size negotiation. More...
 
void SetMinimumSize (float size, Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Set the minimum size an actor can be assigned in size negotiation. More...
 
float GetMinimumSize (Dimension::Type dimension) const
 Return the minimum relayout size. More...
 
void SetMaximumSize (float size, Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Set the maximum size an actor can be assigned in size negotiation. More...
 
float GetMaximumSize (Dimension::Type dimension) const
 Return the maximum relayout size. More...
 
unsigned int AddRenderer (Renderer &renderer)
 Add a renderer to this actor. More...
 
unsigned int GetRendererCount () const
 Get the number of renderers on this actor. More...
 
RendererPtr GetRendererAt (unsigned int index)
 Get a Renderer by index. More...
 
void RemoveRenderer (Renderer &renderer)
 Remove an renderer from the actor. More...
 
void RemoveRenderer (unsigned int index)
 Remove an renderer from the actor. More...
 
bool ScreenToLocal (float &localX, float &localY, float screenX, float screenY) const
 Converts screen coordinates into the actor's coordinate system. More...
 
bool ScreenToLocal (const RenderTask &renderTask, float &localX, float &localY, float screenX, float screenY) const
 Converts screen coordinates into the actor's coordinate system. More...
 
bool ScreenToLocal (const Matrix &viewMatrix, const Matrix &projectionMatrix, const Viewport &viewport, float &localX, float &localY, float screenX, float screenY) const
 Converts from the actor's coordinate system to screen coordinates. More...
 
bool RaySphereTest (const Vector4 &rayOrigin, const Vector4 &rayDir) const
 Performs a ray-sphere test with the given pick-ray and the actor's bounding sphere. More...
 
bool RayActorTest (const Vector4 &rayOrigin, const Vector4 &rayDir, Vector4 &hitPointLocal, float &distance) const
 Performs a ray-actor test with the given pick-ray and the actor's geometry. More...
 
void SetLeaveRequired (bool required)
 Sets whether the actor should receive a notification when touch or hover motion events leave the boundary of the actor. More...
 
bool GetLeaveRequired () const
 This returns whether the actor requires touch or hover events whenever touch or hover motion events leave the boundary of the actor. More...
 
void SetKeyboardFocusable (bool focusable)
 Sets whether the actor should be focusable by keyboard navigation. More...
 
bool IsKeyboardFocusable () const
 Returns whether the actor is focusable by keyboard navigation. More...
 
bool GetTouchRequired () const
 Query whether the application or derived actor type requires touch events. More...
 
bool GetHoverRequired () const
 Query whether the application or derived actor type requires hover events. More...
 
bool GetWheelEventRequired () const
 Query whether the application or derived actor type requires wheel events. More...
 
bool IsHittable () const
 Query whether the actor is actually hittable. More...
 
ActorGestureDataGetGestureData ()
 Retrieve the gesture data associated with this actor. More...
 
bool IsGestureRequred (Gesture::Type type) const
 Queries whether the actor requires the gesture type. More...
 
bool EmitTouchEventSignal (const TouchEvent &event)
 Used by the EventProcessor to emit touch event signals. More...
 
bool EmitHoverEventSignal (const HoverEvent &event)
 Used by the EventProcessor to emit hover event signals. More...
 
bool EmitWheelEventSignal (const WheelEvent &event)
 Used by the EventProcessor to emit wheel event signals. More...
 
Dali::Actor::TouchSignalTypeTouchedSignal ()
 This signal is emitted when touch input is received. More...
 
Dali::Actor::HoverSignalTypeHoveredSignal ()
 This signal is emitted when hover input is received. More...
 
Dali::Actor::WheelEventSignalTypeWheelEventSignal ()
 This signal is emitted when wheel event is received. More...
 
Dali::Actor::OnStageSignalTypeOnStageSignal ()
 This signal is emitted after the actor has been connected to the stage. More...
 
Dali::Actor::OffStageSignalTypeOffStageSignal ()
 This signal is emitted after the actor has been disconnected from the stage. More...
 
Dali::Actor::OnRelayoutSignalTypeOnRelayoutSignal ()
 This signal is emitted after the size has been set on the actor during relayout. More...
 
void NotifySizeAnimation (Animation &animation, const Vector3 &targetSize)
 This should only be called by Animation, when the actors SIZE property is animated. More...
 
void NotifySizeAnimation (Animation &animation, float targetSize, Property::Index property)
 This should only be called by Animation, when the actors SIZE_WIDTH or SIZE_HEIGHT or SIZE_DEPTH property is animated. More...
 
virtual void OnSizeAnimation (Animation &animation, const Vector3 &targetSize)
 For use in derived classes. More...
 
void NotifyPositionAnimation (Animation &animation, const Vector3 &targetPosition)
 This should only be called by Animation, when the actors POSITION property is animated. More...
 
void NotifyPositionAnimation (Animation &animation, float targetPosition, Property::Index property)
 This should only be called by Animation, when the actors POSITION_X or POSITION_Y or POSITION_Z property is animated. More...
 
virtual unsigned int GetDefaultPropertyCount () const
 Query how many default properties the derived class supports. More...
 
virtual void GetDefaultPropertyIndices (Property::IndexContainer &indices) const
 Retrieve all the indices that are associated with the default properties supported by the derived class. More...
 
virtual const char * GetDefaultPropertyName (Property::Index index) const
 Query how many default properties the derived class supports. More...
 
virtual Property::Index GetDefaultPropertyIndex (const std::string &name) const
 Query the index of a default property. More...
 
virtual bool IsDefaultPropertyWritable (Property::Index index) const
 Query whether a default property is writable. More...
 
virtual bool IsDefaultPropertyAnimatable (Property::Index index) const
 Query whether a default property is animatable. More...
 
virtual bool IsDefaultPropertyAConstraintInput (Property::Index index) const
 Query whether a default property can be used as an input to a constraint. More...
 
virtual Property::Type GetDefaultPropertyType (Property::Index index) const
 Query the type of a default property. More...
 
virtual void SetDefaultProperty (Property::Index index, const Property::Value &propertyValue)
 Set the value of a default property. More...
 
virtual void SetSceneGraphProperty (Property::Index index, const PropertyMetadata &entry, const Property::Value &value)
 Set the value of scene graph property. More...
 
virtual Property::Value GetDefaultProperty (Property::Index index) const
 Retrieve a default property value. More...
 
virtual const
SceneGraph::PropertyOwner
GetPropertyOwner () const
  More...
 
virtual const
SceneGraph::PropertyOwner
GetSceneObject () const
 Retrieve the scene-graph object added by this object. More...
 
virtual const
SceneGraph::PropertyBase
GetSceneObjectAnimatableProperty (Property::Index index) const
 Retrieve an animatable property owned by the scene-graph object. More...
 
virtual const PropertyInputImplGetSceneObjectInputProperty (Property::Index index) const
 Retrieve a constraint input-property owned by the scene-graph object. More...
 
virtual int GetPropertyComponentIndex (Property::Index index) const
 Query whether the property is a component of a scene-graph property. More...
 
- Public Member Functions inherited from Dali::Internal::Object
 Object ()
 Constructor. More...
 
virtual void AddObserver (Observer &observer)
 Add an observer to the object. More...
 
virtual void RemoveObserver (Observer &observer)
 Remove an observer from the object. More...
 
virtual bool Supports (Capability capability) const
 Query whether an handle supports a given capability. More...
 
virtual unsigned int GetPropertyCount () const
 Query how many properties are provided by an handle. More...
 
virtual std::string GetPropertyName (Property::Index index) const
 Query the name of a property. More...
 
virtual Property::Index GetPropertyIndex (const std::string &name) const
 Query the index of a property. More...
 
virtual bool IsPropertyWritable (Property::Index index) const
 Query whether a property can be set using SetProperty(). More...
 
virtual bool IsPropertyAnimatable (Property::Index index) const
 Query whether a writable property can be the target of an animation or constraint. More...
 
virtual bool IsPropertyAConstraintInput (Property::Index index) const
 Query whether a property can be used as in input to a constraint. More...
 
virtual Property::Type GetPropertyType (Property::Index index) const
 Query the type of a property. More...
 
virtual void SetProperty (Property::Index index, const Property::Value &propertyValue)
 Set the value of an existing property. More...
 
virtual Property::Value GetProperty (Property::Index index) const
 Retrieve a property value. More...
 
virtual void GetPropertyIndices (Property::IndexContainer &indices) const
 Retrieve all the property indices for this object (including custom properties). More...
 
virtual Property::Index RegisterProperty (const std::string &name, const Property::Value &propertyValue)
 Register a new animatable property. More...
 
virtual Property::Index RegisterProperty (const std::string &name, const Property::Value &propertyValue, Property::AccessMode accessMode)
  More...
 
virtual Dali::PropertyNotification AddPropertyNotification (Property::Index index, int componentIndex, const Dali::PropertyCondition &condition)
 Add a property notification to this object. More...
 
virtual void RemovePropertyNotification (Dali::PropertyNotification propertyNotification)
 Remove a property notification from this object. More...
 
virtual void RemovePropertyNotifications ()
 Remove all property notifications from this object. More...
 
void AddUniformMapping (Property::Index propertyIndex, const std::string &uniformName) const
  More...
 
void RemoveUniformMapping (const std::string &uniformName)
  More...
 
void ApplyConstraint (ConstraintBase &constraint)
 Apply a constraint to an Object. More...
 
void RemoveConstraint (ConstraintBase &constraint)
 Remove one constraint from an Object. More...
 
void RemoveConstraints ()
 Remove all constraints from a Object. More...
 
void RemoveConstraints (unsigned int tag)
 Remove all constraints from a Object with a matching tag. More...
 
void SetTypeInfo (const TypeInfo *typeInfo)
 Called by TypeInfo to set the type-info that this object-impl is created by. More...
 
unsigned int CustomPropertyStartIndex ()
 
- Public Member Functions inherited from Dali::BaseObject
template<class T >
bool ConnectSignal (ConnectionTrackerInterface *connectionTracker, const std::string &signalName, const T &functor)
 Connects a void() functor to a specified signal. More...
 
bool DoAction (const std::string &actionName, const Property::Map &attributes)
 Perform action on this object with the given action name and attributes. More...
 
const std::string & GetTypeName () const
 Returns the type name for the Handle. More...
 
bool GetTypeInfo (Dali::TypeInfo &info) const
 Returns the type info for the Handle. More...
 
bool DoConnectSignal (ConnectionTrackerInterface *connectionTracker, const std::string &signalName, FunctorDelegate *functorDelegate)
 Not intended for application developers. More...
 
- Public Member Functions inherited from Dali::RefObject
void Reference ()
 Increment the object's reference count. More...
 
void Unreference ()
 Decrement the object's reference count. More...
 
int ReferenceCount ()
 Retrieve the object's reference count. More...
 

Static Public Member Functions

static ActorPtr New ()
 Create a new actor. More...
 
static bool DoConnectSignal (BaseObject *object, ConnectionTrackerInterface *tracker, const std::string &signalName, FunctorDelegate *functor)
 Connects a callback function with the object's signals. More...
 
static bool DoAction (BaseObject *object, const std::string &actionName, const Property::Map &attributes)
 Performs actions as requested using the action name. More...
 

Protected Types

enum  DerivedType { BASIC, LAYER, ROOT_LAYER }
 

Protected Member Functions

 Actor (DerivedType derivedType)
 Protected Constructor. More...
 
void Initialize (void)
 Second-phase constructor. More...
 
virtual ~Actor ()
 A reference counted object may only be deleted by calling Unreference() More...
 
void ConnectToStage (unsigned int parentDepth)
 Called on a child during Add() when the parent actor is connected to the Stage. More...
 
void RecursiveConnectToStage (ActorContainer &connectionList, unsigned int depth)
 Helper for ConnectToStage, to recursively connect a tree of actors. More...
 
void ConnectToSceneGraph ()
 Connect the Node associated with this Actor to the scene-graph. More...
 
void NotifyStageConnection ()
 Helper for ConnectToStage, to notify a connected actor through the public API. More...
 
void DisconnectFromStage ()
 Called on a child during Remove() when the actor was previously on the Stage. More...
 
void RecursiveDisconnectFromStage (ActorContainer &disconnectionList)
 Helper for DisconnectFromStage, to recursively disconnect a tree of actors. More...
 
void DisconnectFromSceneGraph ()
 Disconnect the Node associated with this Actor from the scene-graph. More...
 
void NotifyStageDisconnection ()
 Helper for DisconnectFromStage, to notify a disconnected actor through the public API. More...
 
bool IsNodeConnected () const
 When the Actor is OnStage, checks whether the corresponding Node is connected to the scene graph. More...
 
- Protected Member Functions inherited from Dali::Internal::Object
virtual ~Object ()
 A reference counted object may only be deleted by calling Unreference() More...
 
void OnSceneObjectAdd ()
 Called immediately by derived classes, after the scene-object has been created & passed to the scene-graph. More...
 
void OnSceneObjectRemove ()
 Called by derived classes, shortly before send a message to remove the scene-object. More...
 
virtual void OnPropertySet (Property::Index index, Property::Value propertyValue)
 For use in derived classes. More...
 
const TypeInfoGetTypeInfo () const
 Retrieves the TypeInfo for this object. More...
 
CustomPropertyMetadataFindCustomProperty (Property::Index index) const
 Helper to find custom property. More...
 
AnimatablePropertyMetadataFindAnimatableProperty (Property::Index index) const
 Helper to find animatable property. More...
 
Property::Index RegisterSceneGraphProperty (const std::string &name, Property::Index index, const Property::Value &propertyValue) const
 Helper to register a scene-graph property. More...
 
AnimatablePropertyMetadataRegisterAnimatableProperty (Property::Index index) const
 Check whether the animatable property is registered already, if not then register one. More...
 
EventThreadServicesGetEventThreadServices ()
 Get the event thread services object - used for sending messages to the scene graph Assert if called from the wrong thread. More...
 
const EventThreadServicesGetEventThreadServices () const
 Get the event thread services object - used for sending messages to the scene graph Assert if called from the wrong thread This is intentionally inline for performance reasons. More...
 
- Protected Member Functions inherited from Dali::BaseObject
 BaseObject ()
 Default constructor. More...
 
virtual ~BaseObject ()
 A reference counted object may only be deleted by calling Unreference(). More...
 
void RegisterObject ()
 Registers the object as created with the Object registry. More...
 
void UnregisterObject ()
 Unregisters the object from Object registry. More...
 
- Protected Member Functions inherited from Dali::RefObject
 RefObject ()
 Default constructor. More...
 
virtual ~RefObject ()
 RefObject is intended as a base class. More...
 
 RefObject (const RefObject &rhs)
 Copy constructor. More...
 
RefObjectoperator= (const RefObject &rhs)
 Assignment operator. More...
 

Protected Attributes

ActormParent
 Each actor (except the root) can have one parent. More...
 
ActorContainermChildren
 Container of referenced actors. More...
 
RendererContainermRenderers
 Renderer container. More...
 
const SceneGraph::NodemNode
 Not owned. More...
 
Vector3mParentOrigin
 NULL means ParentOrigin::DEFAULT. ParentOrigin is non-animatable. More...
 
Vector3mAnchorPoint
 NULL means AnchorPoint::DEFAULT. AnchorPoint is non-animatable. More...
 
RelayoutDatamRelayoutData
 Struct to hold optional collection of relayout variables. More...
 
ActorGestureDatamGestureData
 Optional Gesture data. Only created when actor requires gestures. More...
 
ActorAttachmentPtr mAttachment
 Optional referenced attachment. More...
 
Dali::Actor::TouchSignalType mTouchedSignal
 
Dali::Actor::HoverSignalType mHoveredSignal
 
Dali::Actor::WheelEventSignalType mWheelEventSignal
 
Dali::Actor::OnStageSignalType mOnStageSignal
 
Dali::Actor::OffStageSignalType mOffStageSignal
 
Dali::Actor::OnRelayoutSignalType mOnRelayoutSignal
 
Vector3 mTargetSize
 Event-side storage for size (not a pointer as most actors will have a size) More...
 
Vector3 mTargetPosition
 Event-side storage for position (not a pointer as most actors will have a position) More...
 
std::string mName
 Name of the actor. More...
 
unsigned int mId
 A unique ID to identify the actor starting from 1, and 0 is reserved. More...
 
unsigned short mDepth:12
 Cached: The depth in the hierarchy of the actor. Only 4096 levels of depth are supported. More...
 
const bool mIsRoot: 1
 Flag to identify the root actor. More...
 
const bool mIsLayer: 1
 Flag to identify that this is a layer. More...
 
bool mIsOnStage: 1
 Flag to identify whether the actor is on-stage. More...
 
bool mSensitive: 1
 Whether the actor emits touch event signals. More...
 
bool mLeaveRequired: 1
 Whether a touch event signal is emitted when the a touch leaves the actor's bounds. More...
 
bool mKeyboardFocusable: 1
 Whether the actor should be focusable by keyboard navigation. More...
 
bool mDerivedRequiresTouch: 1
 Whether the derived actor type requires touch event signals. More...
 
bool mDerivedRequiresHover: 1
 Whether the derived actor type requires hover event signals. More...
 
bool mDerivedRequiresWheelEvent: 1
 Whether the derived actor type requires wheel event signals. More...
 
bool mOnStageSignalled: 1
 Set to true before OnStageConnection signal is emitted, and false before OnStageDisconnection. More...
 
bool mInsideOnSizeSet: 1
 Whether we are inside OnSizeSet. More...
 
bool mInheritOrientation: 1
 Cached: Whether the parent's orientation should be inherited. More...
 
bool mInheritScale: 1
 Cached: Whether the parent's scale should be inherited. More...
 
DrawMode::Type mDrawMode: 2
 Cached: How the actor and its children should be drawn. More...
 
PositionInheritanceMode mPositionInheritanceMode: 2
 Cached: Determines how position is inherited. More...
 
ColorMode mColorMode: 2
 Cached: Determines whether mWorldColor is inherited. More...
 

Private Member Functions

 Actor ()
 
 Actor (const Actor &)
 
Actoroperator= (const Actor &rhs)
 
void SetParent (Actor *parent)
 Set the actors parent. More...
 
virtual SceneGraph::NodeCreateNode () const
 Helper to create a Node for this Actor. More...
 
virtual void OnInitialize ()
 For use in derived classes, called after Initialize() More...
 
virtual void OnStageConnectionInternal ()
 For use in internal derived classes. More...
 
virtual void OnStageDisconnectionInternal ()
 For use in internal derived classes. More...
 
virtual void OnStageConnectionExternal (int depth)
 For use in external (CustomActor) derived classes. More...
 
virtual void OnStageDisconnectionExternal ()
 For use in external (CustomActor) derived classes. More...
 
virtual void OnChildAdd (Actor &child)
 For use in derived classes; this is called after Add() has added a child. More...
 
virtual void OnChildRemove (Actor &child)
 For use in derived classes; this is called after Remove() has removed a child. More...
 
virtual void OnSizeSet (const Vector3 &targetSize)
 For use in derived classes. More...
 
virtual bool OnTouchEvent (const TouchEvent &event)
 For use in derived classes. More...
 
virtual bool OnHoverEvent (const HoverEvent &event)
 For use in derived classes. More...
 
virtual bool OnWheelEvent (const WheelEvent &event)
 For use in derived classes. More...
 
void EnsureRelayoutData ()
 Ensure the relayout data is allocated. More...
 
Vector2 ApplySizeSetPolicy (const Vector2 size)
 Apply the size set policy to the input size. More...
 

Static Private Attributes

static ActorContainer mNullChildren
 Empty container (shared by all actors, returned by GetChildren() const) More...
 
static unsigned int mActorCounter = 0
 A counter to track the actor instance creation. More...
 

Detailed Description

Actor is the primary object which Dali applications interact with.

UI controls can be built by combining multiple actors. Multi-Touch events are received through signals emitted by the actor tree.

An Actor is a proxy for a Node in the scene graph. When an Actor is added to the Stage, it creates a node and attaches it to the scene graph. The scene-graph can be updated in a separate thread, so the attachment is done using an asynchronous message. When a tree of Actors is detached from the Stage, a message is sent to destroy the associated nodes.

Definition at line 73 of file actor-impl.h.

Member Typedef Documentation

Definition at line 109 of file actor-impl.h.

Member Enumeration Documentation

Enumerator
BASIC 
LAYER 
ROOT_LAYER 

Definition at line 1492 of file actor-impl.h.

Constructor & Destructor Documentation

Actor::Actor ( DerivedType  derivedType)
protected

Protected Constructor.

See Actor::New(). The second-phase construction Initialize() member should be called immediately after this.

Parameters
[in]derivedTypeThe derived type of actor (if any).

Definition at line 1905 of file actor-impl.cpp.

Actor::~Actor ( )
protectedvirtual
Dali::Internal::Actor::Actor ( )
private

Referenced by New().

Here is the caller graph for this function:

Dali::Internal::Actor::Actor ( const Actor )
private

Member Function Documentation

void Actor::Add ( Actor child)

Adds a child Actor to this Actor.

Precondition
The child actor is not the same as the parent actor.
The child actor does not already have a parent.
Parameters
[in]childThe child.
Postcondition
The child will be referenced by its parent.

Definition at line 382 of file actor-impl.cpp.

References DALI_ASSERT_ALWAYS, IsRoot(), mChildren, mParent, OnChildAdd(), RelayoutDependentOnChildren(), RelayoutRequest(), Remove(), and SetParent().

Referenced by Dali::KeyFrames::Add(), Dali::Stage::Add(), and Dali::Actor::Add().

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned int Actor::AddRenderer ( Renderer renderer)

Add a renderer to this actor.

.0

Parameters
[in]rendererRenderer to add to the actor
Returns
The index of the Renderer that was added
Precondition
The renderer must be initialized.

Definition at line 1389 of file actor-impl.cpp.

References Dali::Internal::SceneGraph::AddRendererMessage(), Dali::Internal::Object::GetEventThreadServices(), Dali::Internal::Renderer::GetRendererSceneObject(), mIsOnStage, mNode, and mRenderers.

Referenced by Dali::Actor::AddRenderer(), and Dali::Internal::ImageActor::SetImage().

Here is the call graph for this function:

Here is the caller graph for this function:

Vector2 Actor::ApplySizeSetPolicy ( const Vector2  size)
private

Apply the size set policy to the input size.

Parameters
[in]sizeThe size to apply the policy to
Returns
Return the adjusted size

Definition at line 3953 of file actor-impl.cpp.

References Dali::SizeScalePolicy::FILL_WITH_ASPECT_RATIO, Dali::SizeScalePolicy::FIT_WITH_ASPECT_RATIO, GetNaturalSize(), Dali::Vector2::height, Dali::Vector3::height, mRelayoutData, Dali::Internal::Actor::RelayoutData::sizeSetPolicy, Dali::SizeScalePolicy::USE_SIZE_SET, Dali::Vector2::width, and Dali::Vector3::width.

Referenced by SetNegotiatedSize().

Here is the call graph for this function:

Here is the caller graph for this function:

void Actor::Attach ( ActorAttachment attachment)

Attach an object to an actor.

Precondition
The actor does not already have an attachment.
Parameters
[in]attachmentThe object to attach.

Definition at line 338 of file actor-impl.cpp.

References Dali::Internal::ActorAttachment::Connect(), DALI_ASSERT_DEBUG, mAttachment, and OnStage().

Referenced by Dali::GestureDetector::Attach().

Here is the call graph for this function:

Here is the caller graph for this function:

float Actor::CalculateChildSize ( const Dali::Actor child,
Dimension::Type  dimension 
)
virtual

Calculate the size for a child.

Parameters
[in]childThe child actor to calculate the size for
[in]dimensionThe dimension to calculate the size for. E.g. width or height.
Returns
Return the calculated size for the given dimension

Reimplemented in Dali::Internal::CustomActor.

Definition at line 3722 of file actor-impl.cpp.

References CalculateChildSizeBase().

Referenced by NegotiateFromParent().

Here is the call graph for this function:

Here is the caller graph for this function:

float Actor::CalculateChildSizeBase ( const Dali::Actor child,
Dimension::Type  dimension 
)

Calculate the size for a child.

Parameters
[in]childThe child actor to calculate the size for
[in]dimensionThe dimension to calculate the size for. E.g. width or height.
Returns
Return the calculated size for the given dimension

Definition at line 3695 of file actor-impl.cpp.

References Dali::ResizePolicy::FILL_TO_PARENT, Dali::Internal::anonymous_namespace{actor-impl.cpp}::GetDimensionValue(), GetLatestSize(), Dali::Actor::GetResizePolicy(), Dali::Actor::GetSizeModeFactor(), Dali::ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT, and Dali::ResizePolicy::SIZE_RELATIVE_TO_PARENT.

Referenced by CalculateChildSize(), and Dali::CustomActorImpl::CalculateChildSizeBase().

Here is the call graph for this function:

Here is the caller graph for this function:

float Actor::CalculateSize ( Dimension::Type  dimension,
const Vector2 maximumSize 
)
float Actor::ClampDimension ( float  size,
Dimension::Type  dimension 
)

Clamp a dimension given the relayout constraints on this actor.

Parameters
[in]sizeThe size to constrain
[in]dimensionThe dimension the size exists in
Returns
Return the clamped size

Definition at line 3853 of file actor-impl.cpp.

References GetMaximumSize(), GetMinimumSize(), and Dali::Toolkit::Text::min().

Referenced by NegotiateDimension().

Here is the call graph for this function:

Here is the caller graph for this function:

void Actor::ConnectToSceneGraph ( )
protected

Connect the Node associated with this Actor to the scene-graph.

This method is called when the Actor is connected to the Stage.

The parent must have added its Node to the scene-graph. The child must connect its Node to the parent's Node. This is recursive; the child calls ConnectToStage() for its children.

Definition at line 2043 of file actor-impl.cpp.

References Dali::Internal::SceneGraph::ConnectNodeMessage(), DALI_ASSERT_DEBUG, Dali::Internal::Object::GetEventThreadServices(), GetRendererAt(), GetRendererCount(), mAttachment, mNode, mParent, Dali::Internal::Object::OnSceneObjectAdd(), and RelayoutRequest().

Referenced by RecursiveConnectToStage().

Here is the call graph for this function:

Here is the caller graph for this function:

void Actor::ConnectToStage ( unsigned int  parentDepth)
protected

Called on a child during Add() when the parent actor is connected to the Stage.

Parameters
[in]parentDepthThe depth of the parent in the hierarchy.

Definition at line 1992 of file actor-impl.cpp.

References RecursiveConnectToStage(), and RelayoutRequest().

Referenced by SetParent().

Here is the call graph for this function:

Here is the caller graph for this function:

SceneGraph::Node * Actor::CreateNode ( ) const
privatevirtual

Helper to create a Node for this Actor.

To be overriden in derived classes.

Returns
A newly allocated node.

Reimplemented in Dali::Internal::Layer.

Definition at line 3477 of file actor-impl.cpp.

References Dali::WeightObject::New().

Referenced by Initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

void Actor::DisconnectFromSceneGraph ( )
protected

Disconnect the Node associated with this Actor from the scene-graph.

This method is called by an actor or its parent, before a node removal message is sent.

This is recursive; the child calls DisconnectFromStage() for its children.

Definition at line 2141 of file actor-impl.cpp.

References GetRendererAt(), GetRendererCount(), mAttachment, and Dali::Internal::Object::OnSceneObjectRemove().

Referenced by RecursiveDisconnectFromStage().

Here is the call graph for this function:

Here is the caller graph for this function:

void Actor::DisconnectFromStage ( )
protected

Called on a child during Remove() when the actor was previously on the Stage.

Definition at line 2095 of file actor-impl.cpp.

References RecursiveDisconnectFromStage().

Referenced by SetParent().

Here is the call graph for this function:

Here is the caller graph for this function:

bool Actor::DoAction ( BaseObject object,
const std::string &  actionName,
const Property::Map attributes 
)
static

Performs actions as requested using the action name.

Parameters
[in]objectThe object on which to perform the action.
[in]actionNameThe action to perform.
[in]attributesThe attributes with which to perfrom this action.
Returns
true if the action was done.

Definition at line 3482 of file actor-impl.cpp.

References Dali::Internal::anonymous_namespace{actor-impl.cpp}::ACTION_HIDE, Dali::Internal::anonymous_namespace{actor-impl.cpp}::ACTION_SHOW, and SetVisible().

Referenced by Dali::BaseHandle::DoAction().

Here is the call graph for this function:

Here is the caller graph for this function:

bool Actor::DoConnectSignal ( BaseObject object,
ConnectionTrackerInterface tracker,
const std::string &  signalName,
FunctorDelegate functor 
)
static

Connects a callback function with the object's signals.

Parameters
[in]objectThe object providing the signal.
[in]trackerUsed to disconnect the signal.
[in]signalNameThe signal to connect to.
[in]functorA newly allocated FunctorDelegate.
Returns
True if the signal was connected.
Postcondition
If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.

Definition at line 1867 of file actor-impl.cpp.

References HoveredSignal(), OffStageSignal(), OnRelayoutSignal(), OnStageSignal(), Dali::Internal::anonymous_namespace{actor-impl.cpp}::SIGNAL_HOVERED, Dali::Internal::anonymous_namespace{actor-impl.cpp}::SIGNAL_OFF_STAGE, Dali::Internal::anonymous_namespace{actor-impl.cpp}::SIGNAL_ON_RELAYOUT, Dali::Internal::anonymous_namespace{actor-impl.cpp}::SIGNAL_ON_STAGE, Dali::Internal::anonymous_namespace{actor-impl.cpp}::SIGNAL_TOUCHED, Dali::Internal::anonymous_namespace{actor-impl.cpp}::SIGNAL_WHEEL_EVENT, TouchedSignal(), and WheelEventSignal().

Referenced by Dali::BaseHandle::DoConnectSignal().

Here is the call graph for this function:

Here is the caller graph for this function:

bool Actor::EmitHoverEventSignal ( const HoverEvent event)

Used by the EventProcessor to emit hover event signals.

Parameters
[in]eventThe hover event.
Returns
True if the event was consumed.

Definition at line 1799 of file actor-impl.cpp.

References mHoveredSignal, and OnHoverEvent().

Here is the call graph for this function:

bool Actor::EmitTouchEventSignal ( const TouchEvent event)

Used by the EventProcessor to emit touch event signals.

Parameters
[in]eventThe touch event.
Returns
True if the event was consumed.

Definition at line 1780 of file actor-impl.cpp.

References mTouchedSignal, and OnTouchEvent().

Here is the call graph for this function:

bool Actor::EmitWheelEventSignal ( const WheelEvent event)

Used by the EventProcessor to emit wheel event signals.

Parameters
[in]eventThe wheel event.
Returns
True if the event was consumed.

Definition at line 1818 of file actor-impl.cpp.

References mWheelEventSignal, and OnWheelEvent().

Here is the call graph for this function:

void Actor::EnsureRelayoutData ( )
private

Ensure the relayout data is allocated.

Definition at line 3504 of file actor-impl.cpp.

References mRelayoutData.

Referenced by SetDimensionDependency(), SetLayoutDirty(), SetLayoutNegotiated(), SetMaximumSize(), SetMinimumSize(), SetPadding(), SetPreferredSize(), SetRelayoutEnabled(), SetResizePolicy(), SetSizeModeFactor(), and SetSizeScalePolicy().

Here is the caller graph for this function:

ActorPtr Actor::FindChildById ( const unsigned int  id)

Search through this actor's hierarchy for an actor with the given unique ID.

The actor itself is also considered in the search. .0

Parameters
[in]idthe ID of the actor to find
Returns
A handle to the actor if found, or an empty handle if not.
Precondition
The Actor has been initialized.

Definition at line 520 of file actor-impl.cpp.

References mChildren, and mId.

Referenced by Dali::Actor::FindChildById().

Here is the caller graph for this function:

ActorPtr Actor::FindChildByName ( const std::string &  actorName)

Search through this actor's hierarchy for an actor with the given name.

The actor itself is also considered in the search. .0

Parameters
[in]actorNamethe name of the actor to find
Returns
A handle to the actor if found, or an empty handle if not.
Precondition
The Actor has been initialized.

Definition at line 497 of file actor-impl.cpp.

References mChildren, and mName.

Referenced by Dali::Actor::FindChildByName().

Here is the caller graph for this function:

ActorAttachmentPtr Actor::GetAttachment ( )

Retreive the object attached to an actor.

Returns
The attachment.

Definition at line 350 of file actor-impl.cpp.

References mAttachment.

ActorPtr Actor::GetChildAt ( unsigned int  index) const

Retrieve and child actor by index.

.0

Parameters
[in]indexThe index of the child to retrieve
Returns
The actor for the given index or empty handle if children not initialised
Precondition
The Actor has been initialized.

Definition at line 490 of file actor-impl.cpp.

References DALI_ASSERT_ALWAYS, GetChildCount(), and mChildren.

Referenced by Dali::Actor::GetChildAt(), NegotiateDimension(), NegotiateFromChildren(), and NegotiateSize().

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned int Actor::GetChildCount ( ) const

Retrieve the number of children held by the actor.

Returns
The number of children

Definition at line 485 of file actor-impl.cpp.

References mChildren.

Referenced by GetChildAt(), Dali::Actor::GetChildCount(), Dali::Internal::HitTestAlgorithm::anonymous_namespace{hit-test-algorithm-impl.cpp}::HitTestWithinLayer(), NegotiateDimension(), NegotiateFromChildren(), and NegotiateSize().

Here is the caller graph for this function:

ActorContainer& Dali::Internal::Actor::GetChildrenInternal ( )
inline

Retrieve a reference to Actor's children.

Note
Not for public use.
Returns
A reference to the container of children.

Definition at line 230 of file actor-impl.h.

References mChildren.

Referenced by Dali::Internal::HitTestAlgorithm::anonymous_namespace{hit-test-algorithm-impl.cpp}::HitTestWithinLayer().

Here is the caller graph for this function:

ColorMode Actor::GetColorMode ( ) const

Returns the actor's color mode.

Returns
currently used colorMode.

Definition at line 1064 of file actor-impl.cpp.

References mColorMode.

Referenced by Dali::Actor::GetColorMode(), and GetDefaultProperty().

Here is the caller graph for this function:

const Vector3 & Actor::GetCurrentAnchorPoint ( ) const

Retrieve the anchor-point of an actor.

Returns
The anchor-point.

Definition at line 639 of file actor-impl.cpp.

References Dali::AnchorPoint::DEFAULT, and mAnchorPoint.

Referenced by Dali::Actor::GetCurrentAnchorPoint(), GetDefaultProperty(), SetAnchorPointX(), SetAnchorPointY(), and SetAnchorPointZ().

Here is the caller graph for this function:

const Vector4 & Actor::GetCurrentColor ( ) const

Retrieve the actor's color.

Returns
The color.

Definition at line 1009 of file actor-impl.cpp.

References Dali::Internal::SceneGraph::Node::GetColor(), Dali::Internal::Object::GetEventThreadServices(), mNode, and Dali::Color::WHITE.

Referenced by Dali::Actor::GetCurrentColor(), and GetDefaultProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

float Actor::GetCurrentOpacity ( ) const

Retrieve the actor's opacity.

Returns
The actor's opacity.

Definition at line 952 of file actor-impl.cpp.

References Dali::Internal::Object::GetEventThreadServices(), Dali::Internal::SceneGraph::Node::GetOpacity(), and mNode.

Referenced by Dali::Actor::GetCurrentOpacity().

Here is the call graph for this function:

Here is the caller graph for this function:

const Quaternion & Actor::GetCurrentOrientation ( ) const

Retreive the Actor's orientation.

Returns
the orientation.

Definition at line 791 of file actor-impl.cpp.

References Dali::Internal::Object::GetEventThreadServices(), Dali::Internal::SceneGraph::Node::GetOrientation(), Dali::Quaternion::IDENTITY, and mNode.

Referenced by Dali::Actor::GetCurrentOrientation(), and GetDefaultProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

const Vector3 & Actor::GetCurrentParentOrigin ( ) const

Retrieve the parent-origin of an actor.

Returns
The parent-origin.

Definition at line 588 of file actor-impl.cpp.

References Dali::ParentOrigin::DEFAULT, and mParentOrigin.

Referenced by Dali::Actor::GetCurrentParentOrigin(), GetDefaultProperty(), SetParentOriginX(), SetParentOriginY(), and SetParentOriginZ().

Here is the caller graph for this function:

const Vector3 & Actor::GetCurrentPosition ( ) const

Retrieve the position of the Actor.

The coordinates are relative to the Actor's parent.

Returns
the Actor's position.

Definition at line 710 of file actor-impl.cpp.

References Dali::Internal::Object::GetEventThreadServices(), Dali::Internal::SceneGraph::Node::GetPosition(), mNode, and Dali::Vector3::ZERO.

Referenced by Dali::Actor::GetCurrentPosition().

Here is the call graph for this function:

Here is the caller graph for this function:

const Vector3 & Actor::GetCurrentScale ( ) const

Retrieve the scale factor applied to an actor.

Returns
A vector representing the scale factor for each axis.

Definition at line 868 of file actor-impl.cpp.

References Dali::Internal::Object::GetEventThreadServices(), Dali::Internal::SceneGraph::Node::GetScale(), mNode, and Dali::Vector3::ONE.

Referenced by Dali::Actor::GetCurrentScale(), and GetDefaultProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

const Vector3 & Actor::GetCurrentSize ( ) const

Retrieve the Actor's size from update side.

This size will be the size set or animating but will be a frame behind.

Returns
The Actor's size.

Definition at line 1216 of file actor-impl.cpp.

References Dali::Internal::Object::GetEventThreadServices(), Dali::Internal::SceneGraph::Node::GetSize(), mNode, and Dali::Vector3::ZERO.

Referenced by Dali::Actor::GetCurrentSize(), Dali::Internal::HitTestAlgorithm::anonymous_namespace{hit-test-algorithm-impl.cpp}::HitTestWithinLayer(), Dali::Internal::GestureProcessor::ProcessAndEmit(), ScreenToLocal(), and Dali::Internal::RenderTask::TranslateCoordinates().

Here is the call graph for this function:

Here is the caller graph for this function:

const Vector4 & Actor::GetCurrentWorldColor ( ) const

Retrieve the world-color of the Actor, where each component is clamped within the 0->1 range.

.0

Returns
The Actor's current color in the world.
Precondition
The Actor has been initialized.
Note
The actor will not have a world-color, unless it has previously been added to the stage.

Definition at line 963 of file actor-impl.cpp.

References Dali::Internal::Object::GetEventThreadServices(), Dali::Internal::SceneGraph::Node::GetWorldColor(), mNode, and Dali::Color::WHITE.

Referenced by Dali::Actor::GetCurrentWorldColor(), GetDefaultProperty(), and IsHittable().

Here is the call graph for this function:

Here is the caller graph for this function:

Matrix Actor::GetCurrentWorldMatrix ( ) const

Retrieves the world-matrix of the actor.

.0

Returns
The Actor's current world matrix
Precondition
The Actor has been initialized.
Note
The actor will not have a world-matrix, unless it has previously been added to the stage.

Definition at line 906 of file actor-impl.cpp.

References Dali::Internal::EventThreadServices::GetEventBufferIndex(), Dali::Internal::Object::GetEventThreadServices(), Dali::Internal::SceneGraph::Node::GetWorldOrientation(), Dali::Internal::SceneGraph::Node::GetWorldPosition(), Dali::Internal::SceneGraph::Node::GetWorldScale(), Dali::Matrix::IDENTITY, mNode, and Dali::Matrix::SetTransformComponents().

Referenced by Dali::Actor::GetCurrentWorldMatrix(), and GetDefaultProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

const Quaternion & Actor::GetCurrentWorldOrientation ( ) const

Retrieve the world-orientation of the Actor.

.0

Returns
The Actor's current orientation in the world.
Precondition
The Actor has been initialized.
Note
The actor will not have a world-orientation, unless it has previously been added to the stage.

Definition at line 802 of file actor-impl.cpp.

References Dali::Internal::Object::GetEventThreadServices(), Dali::Internal::SceneGraph::Node::GetWorldOrientation(), Dali::Quaternion::IDENTITY, and mNode.

Referenced by Dali::Actor::GetCurrentWorldOrientation(), and GetDefaultProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

const Vector3 & Actor::GetCurrentWorldPosition ( ) const

Retrieve the world-position of the Actor.

.0

Returns
The Actor's current position in world coordinates.
Precondition
The Actor has been initialized.
Note
The actor will not have a world-position, unless it has previously been added to the stage.

Definition at line 726 of file actor-impl.cpp.

References Dali::Internal::Object::GetEventThreadServices(), Dali::Internal::SceneGraph::Node::GetWorldPosition(), mNode, and Dali::Vector3::ZERO.

Referenced by Dali::Actor::GetCurrentWorldPosition(), and GetDefaultProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

const Vector3 & Actor::GetCurrentWorldScale ( ) const

Retrieve the world-scale of the Actor.

.0

Returns
The Actor's current scale in the world.
Precondition
The Actor has been initialized.
Note
The actor will not have a world-scale, unless it has previously been added to the stage.

Definition at line 879 of file actor-impl.cpp.

References Dali::Internal::Object::GetEventThreadServices(), Dali::Internal::SceneGraph::Node::GetWorldScale(), mNode, and Dali::Vector3::ONE.

Referenced by Dali::Actor::GetCurrentWorldScale(), and GetDefaultProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

Property::Value Actor::GetDefaultProperty ( Property::Index  index) const
virtual

Retrieve a default property value.

Parameters
[in]indexThe index of the property.
Returns
The property value.

Implements Dali::Internal::Object.

Reimplemented in Dali::Internal::ImageActor, Dali::Internal::Layer, and Dali::Internal::CameraActor.

Definition at line 2739 of file actor-impl.cpp.

References Dali::Vector4::a, Dali::Actor::Property::ANCHOR_POINT, Dali::Actor::Property::ANCHOR_POINT_X, Dali::Actor::Property::ANCHOR_POINT_Y, Dali::Actor::Property::ANCHOR_POINT_Z, Dali::Vector4::b, Dali::Actor::Property::COLOR, Dali::Actor::Property::COLOR_ALPHA, Dali::Actor::Property::COLOR_BLUE, Dali::Actor::Property::COLOR_GREEN, Dali::Actor::Property::COLOR_MODE, Dali::Actor::Property::COLOR_RED, DALI_ASSERT_ALWAYS, Dali::Vector3::depth, Dali::ResizePolicy::DIMENSION_DEPENDENCY, Dali::Actor::Property::DRAW_MODE, Dali::Vector4::g, Dali::Scripting::GetColorMode(), GetColorMode(), GetCurrentAnchorPoint(), GetCurrentColor(), GetCurrentOrientation(), GetCurrentParentOrigin(), GetCurrentScale(), GetCurrentWorldColor(), GetCurrentWorldMatrix(), GetCurrentWorldOrientation(), GetCurrentWorldPosition(), GetCurrentWorldScale(), GetDimensionDependency(), Dali::Scripting::GetDrawMode(), GetDrawMode(), GetLeaveRequired(), GetMaximumSize(), GetMinimumSize(), GetName(), GetPadding(), Dali::Scripting::GetPositionInheritanceMode(), GetPositionInheritanceMode(), GetResizePolicy(), GetSizeModeFactor(), GetSizeScalePolicy(), GetTargetPosition(), GetTargetSize(), Dali::Dimension::HEIGHT, Dali::Vector3::height, Dali::Actor::Property::HEIGHT_FOR_WIDTH, Dali::Actor::Property::HEIGHT_RESIZE_POLICY, Dali::Actor::Property::INHERIT_ORIENTATION, Dali::Actor::Property::INHERIT_SCALE, IsOrientationInherited(), IsScaleInherited(), IsSensitive(), IsVisible(), Dali::Actor::Property::LEAVE_REQUIRED, Dali::Actor::Property::MAXIMUM_SIZE, Dali::Actor::Property::MINIMUM_SIZE, Dali::Actor::Property::NAME, Dali::Actor::Property::ORIENTATION, Dali::Actor::Property::PADDING, Dali::Actor::Property::PARENT_ORIGIN, Dali::Actor::Property::PARENT_ORIGIN_X, Dali::Actor::Property::PARENT_ORIGIN_Y, Dali::Actor::Property::PARENT_ORIGIN_Z, Dali::Actor::Property::POSITION, Dali::Actor::Property::POSITION_INHERITANCE, Dali::Actor::Property::POSITION_X, Dali::Actor::Property::POSITION_Y, Dali::Actor::Property::POSITION_Z, Dali::Vector4::r, Dali::Actor::Property::SCALE, Dali::Actor::Property::SCALE_X, Dali::Actor::Property::SCALE_Y, Dali::Actor::Property::SCALE_Z, Dali::Actor::Property::SENSITIVE, Dali::Actor::Property::SIZE, Dali::Actor::Property::SIZE_DEPTH, Dali::Actor::Property::SIZE_HEIGHT, Dali::Actor::Property::SIZE_MODE_FACTOR, Dali::Actor::Property::SIZE_SCALE_POLICY, Dali::Actor::Property::SIZE_WIDTH, Dali::Property::Value(), Dali::Actor::Property::VISIBLE, Dali::Dimension::WIDTH, Dali::Vector3::width, Dali::Actor::Property::WIDTH_FOR_HEIGHT, Dali::Actor::Property::WIDTH_RESIZE_POLICY, Dali::Actor::Property::WORLD_COLOR, Dali::Actor::Property::WORLD_MATRIX, Dali::Actor::Property::WORLD_ORIENTATION, Dali::Actor::Property::WORLD_POSITION, Dali::Actor::Property::WORLD_POSITION_X, Dali::Actor::Property::WORLD_POSITION_Y, Dali::Actor::Property::WORLD_POSITION_Z, Dali::Actor::Property::WORLD_SCALE, Dali::Vector2::x, Dali::Vector3::x, Dali::Vector2::y, Dali::Vector3::y, and Dali::Vector3::z.

Referenced by Dali::Internal::CameraActor::GetDefaultProperty(), Dali::Internal::Layer::GetDefaultProperty(), and Dali::Internal::ImageActor::GetDefaultProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned int Actor::GetDefaultPropertyCount ( ) const
virtual

Query how many default properties the derived class supports.

Returns
The number of default properties.

Implements Dali::Internal::Object.

Reimplemented in Dali::Internal::ImageActor, Dali::Internal::Layer, and Dali::Internal::CameraActor.

Definition at line 2198 of file actor-impl.cpp.

Referenced by Dali::Internal::CameraActor::GetDefaultPropertyCount(), Dali::Internal::Layer::GetDefaultPropertyCount(), and Dali::Internal::ImageActor::GetDefaultPropertyCount().

Here is the caller graph for this function:

Property::Index Actor::GetDefaultPropertyIndex ( const std::string &  name) const
virtual

Query the index of a default property.

Parameters
[in]nameThe name of the property.
Returns
The index of the property, or Property::INVALID_INDEX if no default property exists with the given name.

Implements Dali::Internal::Object.

Reimplemented in Dali::Internal::ImageActor, Dali::Internal::Layer, and Dali::Internal::CameraActor.

Definition at line 2223 of file actor-impl.cpp.

References Dali::Property::INVALID_INDEX.

Referenced by Dali::Internal::CameraActor::GetDefaultPropertyIndex(), Dali::Internal::Layer::GetDefaultPropertyIndex(), and Dali::Internal::ImageActor::GetDefaultPropertyIndex().

Here is the caller graph for this function:

void Actor::GetDefaultPropertyIndices ( Property::IndexContainer indices) const
virtual

Retrieve all the indices that are associated with the default properties supported by the derived class.

Returns
A container of default property indices.
Note
The deriving class must not modify the existing elements in the container.

Implements Dali::Internal::Object.

Reimplemented in Dali::Internal::ImageActor, Dali::Internal::Layer, and Dali::Internal::CameraActor.

Definition at line 2203 of file actor-impl.cpp.

References Dali::Vector< T, IsTrivialType >::PushBack(), and Dali::Vector< T, IsTrivialType >::Reserve().

Referenced by Dali::Internal::CameraActor::GetDefaultPropertyIndices(), Dali::Internal::Layer::GetDefaultPropertyIndices(), and Dali::Internal::ImageActor::GetDefaultPropertyIndices().

Here is the call graph for this function:

Here is the caller graph for this function:

const char * Actor::GetDefaultPropertyName ( Property::Index  index) const
virtual

Query how many default properties the derived class supports.

Returns
The number of default properties.

Implements Dali::Internal::Object.

Reimplemented in Dali::Internal::ImageActor, Dali::Internal::Layer, and Dali::Internal::CameraActor.

Definition at line 2213 of file actor-impl.cpp.

Referenced by Dali::Internal::CameraActor::GetDefaultPropertyName(), Dali::Internal::Layer::GetDefaultPropertyName(), and Dali::Internal::ImageActor::GetDefaultPropertyName().

Here is the caller graph for this function:

Property::Type Actor::GetDefaultPropertyType ( Property::Index  index) const
virtual

Query the type of a default property.

Parameters
[in]indexThe index of the property.
Returns
The type of the property.

Implements Dali::Internal::Object.

Reimplemented in Dali::Internal::ImageActor, Dali::Internal::Layer, and Dali::Internal::CameraActor.

Definition at line 2271 of file actor-impl.cpp.

References Dali::Property::NONE.

Referenced by Dali::Internal::CameraActor::GetDefaultPropertyType(), Dali::Internal::Layer::GetDefaultPropertyType(), and Dali::Internal::ImageActor::GetDefaultPropertyType().

Here is the caller graph for this function:

Dimension::Type Actor::GetDimensionDependency ( Dimension::Type  dimension) const
DrawMode::Type Actor::GetDrawMode ( ) const

Query how the actor and its children will be drawn.

.0

Returns
Return the draw mode type.

Definition at line 1483 of file actor-impl.cpp.

References mDrawMode.

Referenced by GetDefaultProperty(), Dali::Actor::GetDrawMode(), and Dali::Internal::HitTestAlgorithm::anonymous_namespace{hit-test-algorithm-impl.cpp}::HitTestWithinLayer().

Here is the caller graph for this function:

ActorGestureData & Actor::GetGestureData ( )

Retrieve the gesture data associated with this actor.

The first call to this method will allocate space for the ActorGestureData so this should only be called if an actor really does require gestures.

Returns
Reference to the ActorGestureData for this actor.
Note
Once the gesture-data is created for an actor it is likely that gestures are required throughout the actor's lifetime so it will only be deleted when the actor is destroyed.

Definition at line 1764 of file actor-impl.cpp.

References mGestureData.

Referenced by Dali::Internal::GestureDetector::Attach(), Dali::Internal::GestureDetector::Detach(), Dali::Internal::GestureDetector::DetachAll(), Dali::Internal::GestureProcessor::GetGesturedActor(), and Dali::Internal::GestureDetector::~GestureDetector().

Here is the caller graph for this function:

float Actor::GetHeightForWidth ( float  width)
virtual

This method is called during size negotiation when a height is required for a given width.

Derived classes should override this if they wish to customize the height returned.

Parameters
widthto use.
Returns
the height based on the width.

Reimplemented in Dali::Internal::CustomActor.

Definition at line 3728 of file actor-impl.cpp.

References GetHeightForWidthBase().

Referenced by CalculateSize(), and Dali::Actor::GetHeightForWidth().

Here is the call graph for this function:

Here is the caller graph for this function:

float Actor::GetHeightForWidthBase ( float  width)

provides the Actor implementation of GetHeightForWidth

Parameters
widthto use.
Returns
the height based on the width.

Definition at line 3661 of file actor-impl.cpp.

References GetNaturalSize(), height, Dali::Vector3::height, width, and Dali::Vector3::width.

Referenced by GetHeightForWidth(), and Dali::CustomActorImpl::GetHeightForWidthBase().

Here is the call graph for this function:

Here is the caller graph for this function:

int Dali::Internal::Actor::GetHierarchyDepth ( ) const
inline

Get depth in the hierarchy for the actor.

.0

Returns
The current depth in the hierarchy of the actor, or -1 if actor is not in the hierarchy

Definition at line 755 of file actor-impl.h.

References mDepth, and mIsOnStage.

Referenced by Dali::Actor::GetHierarchyDepth(), Dali::Internal::HitTestAlgorithm::anonymous_namespace{hit-test-algorithm-impl.cpp}::HitTestWithinLayer(), and SetParent().

Here is the caller graph for this function:

bool Actor::GetHoverRequired ( ) const

Query whether the application or derived actor type requires hover events.

Returns
True if hover events are required.

Definition at line 1749 of file actor-impl.cpp.

References mDerivedRequiresHover, and mHoveredSignal.

Referenced by Dali::Internal::anonymous_namespace{hover-event-processor.cpp}::ActorHoverableCheck::IsActorHittable().

Here is the caller graph for this function:

unsigned int Actor::GetId ( ) const

Retrieve the unique ID of the actor.

.0

Returns
The ID.
Precondition
The Actor has been initialized.

Definition at line 333 of file actor-impl.cpp.

References mId.

Referenced by Dali::Actor::GetId().

Here is the caller graph for this function:

float Actor::GetLatestSize ( Dimension::Type  dimension) const

If the size has been negotiated return that else return normal size.

Parameters
[in]dimensionThe dimension to retrieve
Returns
Return the size

Definition at line 3740 of file actor-impl.cpp.

References GetNegotiatedDimension(), GetSize(), and IsLayoutNegotiated().

Referenced by CalculateChildSizeBase(), GetRelayoutSize(), and SetNegotiatedSize().

Here is the call graph for this function:

Here is the caller graph for this function:

Dali::Layer Actor::GetLayer ( )

Gets the layer in which the actor is present.

Returns
The layer, which will be uninitialized if the actor is off-stage.

Definition at line 360 of file actor-impl.cpp.

References Dali::Actor::GetParent(), mIsLayer, and mParent.

Referenced by Dali::Stage::GetLayer(), and Dali::Actor::GetLayer().

Here is the call graph for this function:

Here is the caller graph for this function:

bool Actor::GetLeaveRequired ( ) const

This returns whether the actor requires touch or hover events whenever touch or hover motion events leave the boundary of the actor.

Returns
true if a Leave event is required, false otherwise.

Definition at line 1729 of file actor-impl.cpp.

References mLeaveRequired.

Referenced by GetDefaultProperty(), and Dali::Actor::GetLeaveRequired().

Here is the caller graph for this function:

float Actor::GetMaximumSize ( Dimension::Type  dimension) const

Return the maximum relayout size.

.0

Returns
Return the maximum size.

Definition at line 4163 of file actor-impl.cpp.

References Dali::Dimension::DIMENSION_COUNT, Dali::Internal::Actor::RelayoutData::maximumSize, and mRelayoutData.

Referenced by ClampDimension(), GetDefaultProperty(), and Dali::Actor::GetMaximumSize().

Here is the caller graph for this function:

float Actor::GetMinimumSize ( Dimension::Type  dimension) const

Return the minimum relayout size.

.0

Returns
Return the mininmum size.

Definition at line 4132 of file actor-impl.cpp.

References Dali::Dimension::DIMENSION_COUNT, Dali::Internal::Actor::RelayoutData::minimumSize, and mRelayoutData.

Referenced by ClampDimension(), GetDefaultProperty(), and Dali::Actor::GetMinimumSize().

Here is the caller graph for this function:

const std::string & Actor::GetName ( ) const

Retrieve the name of the actor.

Returns
The name.

Definition at line 317 of file actor-impl.cpp.

References mName.

Referenced by GetDefaultProperty(), Dali::TypeInfo::GetName(), and Dali::Actor::GetName().

Here is the caller graph for this function:

Vector3 Actor::GetNaturalSize ( ) const
virtual

Return the natural size of the actor.

Returns
The actor's natural size

Reimplemented in Dali::Internal::ImageActor, and Dali::Internal::CustomActor.

Definition at line 1227 of file actor-impl.cpp.

Referenced by ApplySizeSetPolicy(), CalculateSize(), GetHeightForWidthBase(), Dali::Actor::GetNaturalSize(), GetNaturalSize(), and GetWidthForHeightBase().

Here is the caller graph for this function:

float Actor::GetNaturalSize ( Dimension::Type  dimension) const

Return the natural size of the actor for a given dimension.

Parameters
[in]dimensionThe dimension to retrieve the size for
Returns
Return the natural size for the given dimension

Definition at line 3790 of file actor-impl.cpp.

References Dali::Internal::anonymous_namespace{actor-impl.cpp}::GetDimensionValue(), and GetNaturalSize().

Here is the call graph for this function:

float Actor::GetNegotiatedDimension ( Dimension::Type  dimension) const

Return the value of negotiated dimension for the given dimension.

Parameters
dimensionThe dimension to retrieve
Returns
Return the value of the negotiated dimension

Definition at line 3588 of file actor-impl.cpp.

References Dali::Dimension::DIMENSION_COUNT, mRelayoutData, and Dali::Internal::Actor::RelayoutData::negotiatedDimensions.

Referenced by CalculateSize(), and GetLatestSize().

Here is the caller graph for this function:

Vector2 Actor::GetPadding ( Dimension::Type  dimension) const

Return the value of padding for the given dimension.

Parameters
dimensionThe dimension to retrieve
Returns
Return the value of padding for the dimension

Definition at line 3615 of file actor-impl.cpp.

References Dali::Dimension::DIMENSION_COUNT, Dali::Internal::Actor::RelayoutData::dimensionPadding, Dali::Internal::anonymous_namespace{actor-impl.cpp}::GetDefaultDimensionPadding(), and mRelayoutData.

Referenced by GetDefaultProperty(), Dali::Actor::GetPadding(), GetRelayoutSize(), and NegotiateFromParent().

Here is the call graph for this function:

Here is the caller graph for this function:

Actor* Dali::Internal::Actor::GetParent ( ) const
inline
PositionInheritanceMode Actor::GetPositionInheritanceMode ( ) const

Returns the actors position inheritance mode.

.0

Returns
Return the position inheritance mode.
Precondition
The Actor has been initialized.

Definition at line 748 of file actor-impl.cpp.

References mPositionInheritanceMode.

Referenced by GetDefaultProperty(), and Dali::Actor::GetPositionInheritanceMode().

Here is the caller graph for this function:

Vector2 Actor::GetPreferredSize ( ) const

Return the preferred size used for size negotiation.

Returns
Return the preferred size

Definition at line 4107 of file actor-impl.cpp.

References Dali::Internal::anonymous_namespace{actor-impl.cpp}::GetDefaultPreferredSize(), mRelayoutData, and Dali::Internal::Actor::RelayoutData::preferredSize.

Referenced by CalculateSize().

Here is the call graph for this function:

Here is the caller graph for this function:

int Actor::GetPropertyComponentIndex ( Property::Index  index) const
virtual
const SceneGraph::PropertyOwner * Actor::GetPropertyOwner ( ) const
virtual

Todo:
this is virtual so that for now actor can override it, it needs to be removed and only have GetSceneObject but that requires changing actor and constraint logic Retrieve the scene-graph object added by this object.
Returns
A pointer to the object, or NULL if no object has been added to the scene-graph.

Reimplemented from Dali::Internal::Object.

Definition at line 3069 of file actor-impl.cpp.

References mNode.

float Actor::GetRelayoutSize ( Dimension::Type  dimension) const

Return the amount of size allocated for relayout.

May include padding

Parameters
[in]dimensionThe dimension to retrieve
Returns
Return the size

Definition at line 3745 of file actor-impl.cpp.

References GetLatestSize(), GetPadding(), Dali::Vector2::x, and Dali::Vector2::y.

Referenced by Dali::Actor::GetRelayoutSize().

Here is the call graph for this function:

Here is the caller graph for this function:

RendererPtr Actor::GetRendererAt ( unsigned int  index)

Get a Renderer by index.

.0

Parameters
[in]indexThe index of the renderer to fetch
Returns
The renderer at the specified index
Precondition
The index must be between 0 and GetRendererCount()-1

Definition at line 1420 of file actor-impl.cpp.

References GetRendererCount().

Referenced by ConnectToSceneGraph(), DisconnectFromSceneGraph(), Dali::Actor::GetRendererAt(), and Dali::Internal::HitTestAlgorithm::anonymous_namespace{hit-test-algorithm-impl.cpp}::HitTestWithinLayer().

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned int Actor::GetRendererCount ( ) const

Get the number of renderers on this actor.

.0

Returns
the number of renderers on this actor

Definition at line 1409 of file actor-impl.cpp.

References mRenderers.

Referenced by ConnectToSceneGraph(), DisconnectFromSceneGraph(), GetRendererAt(), Dali::Actor::GetRendererCount(), Dali::Internal::HitTestAlgorithm::anonymous_namespace{hit-test-algorithm-impl.cpp}::HitTestWithinLayer(), and RemoveRenderer().

Here is the caller graph for this function:

ResizePolicy::Type Actor::GetResizePolicy ( Dimension::Type  dimension) const

Return the resize policy used for a single dimension.

.0

Parameters
[in]dimensionThe dimension to get policy for
Returns
Return the dimension resize policy. If more than one dimension is requested, just return the first one found.

Definition at line 1267 of file actor-impl.cpp.

References Dali::ResizePolicy::DEFAULT, Dali::Dimension::DIMENSION_COUNT, mRelayoutData, and Dali::Internal::Actor::RelayoutData::resizePolicies.

Referenced by CalculateSize(), GetDefaultProperty(), Dali::Actor::GetResizePolicy(), RelayoutDependentOnChildren(), and RelayoutDependentOnParent().

Here is the caller graph for this function:

const SceneGraph::PropertyOwner * Actor::GetSceneObject ( ) const
virtual

Retrieve the scene-graph object added by this object.

Returns
A pointer to the object, or NULL if no object has been added to the scene-graph.

Implements Dali::Internal::Object.

Definition at line 3074 of file actor-impl.cpp.

References mNode, and OnStage().

Here is the call graph for this function:

const PropertyBase * Actor::GetSceneObjectAnimatableProperty ( Property::Index  index) const
virtual

Retrieve an animatable property owned by the scene-graph object.

Precondition
-1 < index < GetPropertyCount().
Parameters
[in]indexThe index of the property.
Returns
A dereferenceable pointer to a property, or NULL if a scene-object does not exist with this property.

Implements Dali::Internal::Object.

Reimplemented in Dali::Internal::CameraActor.

Definition at line 3080 of file actor-impl.cpp.

References Dali::ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX, Dali::ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX, Dali::Actor::Property::COLOR, Dali::Actor::Property::COLOR_ALPHA, Dali::Actor::Property::COLOR_BLUE, Dali::Actor::Property::COLOR_GREEN, Dali::Actor::Property::COLOR_RED, DALI_ASSERT_ALWAYS, Dali::DEFAULT_PROPERTY_MAX_COUNT, Dali::Internal::Object::FindCustomProperty(), Dali::Internal::PropertyMetadata::GetSceneGraphProperty(), Dali::Internal::Object::IsPropertyAnimatable(), Dali::Internal::SceneGraph::Node::mColor, mNode, Dali::Internal::SceneGraph::Node::mOrientation, Dali::Internal::SceneGraph::Node::mPosition, Dali::Internal::SceneGraph::Node::mScale, Dali::Internal::SceneGraph::Node::mSize, Dali::Internal::SceneGraph::Node::mVisible, OnStage(), Dali::Actor::Property::ORIENTATION, Dali::Actor::Property::POSITION, Dali::Actor::Property::POSITION_X, Dali::Actor::Property::POSITION_Y, Dali::Actor::Property::POSITION_Z, Dali::Internal::Object::RegisterAnimatableProperty(), Dali::Actor::Property::SCALE, Dali::Actor::Property::SCALE_X, Dali::Actor::Property::SCALE_Y, Dali::Actor::Property::SCALE_Z, Dali::Actor::Property::SIZE, Dali::Actor::Property::SIZE_DEPTH, Dali::Actor::Property::SIZE_HEIGHT, Dali::Actor::Property::SIZE_WIDTH, and Dali::Actor::Property::VISIBLE.

Referenced by Dali::Internal::CameraActor::GetSceneObjectAnimatableProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

const PropertyInputImpl * Actor::GetSceneObjectInputProperty ( Property::Index  index) const
virtual

Retrieve a constraint input-property owned by the scene-graph object.

Precondition
-1 < index < GetPropertyCount().
Parameters
[in]indexThe index of the property.
Returns
A dereferenceable pointer to an input property, or NULL if a scene-object does not exist with this property.

Implements Dali::Internal::Object.

Reimplemented in Dali::Internal::CameraActor.

Definition at line 3194 of file actor-impl.cpp.

References Dali::Actor::Property::ANCHOR_POINT, Dali::Actor::Property::ANCHOR_POINT_X, Dali::Actor::Property::ANCHOR_POINT_Y, Dali::Actor::Property::ANCHOR_POINT_Z, Dali::ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX, Dali::ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX, Dali::Actor::Property::COLOR, Dali::Actor::Property::COLOR_ALPHA, Dali::Actor::Property::COLOR_BLUE, Dali::Actor::Property::COLOR_GREEN, Dali::Actor::Property::COLOR_RED, DALI_ASSERT_ALWAYS, Dali::DEFAULT_PROPERTY_MAX_COUNT, Dali::Internal::Object::FindCustomProperty(), Dali::Internal::PropertyMetadata::GetSceneGraphProperty(), Dali::Internal::SceneGraph::Node::mAnchorPoint, Dali::Internal::SceneGraph::Node::mColor, mNode, Dali::Internal::SceneGraph::Node::mOrientation, Dali::Internal::SceneGraph::Node::mParentOrigin, Dali::Internal::SceneGraph::Node::mPosition, Dali::Internal::SceneGraph::Node::mScale, Dali::Internal::SceneGraph::Node::mSize, Dali::Internal::SceneGraph::Node::mVisible, Dali::Internal::SceneGraph::Node::mWorldColor, Dali::Internal::SceneGraph::Node::mWorldMatrix, Dali::Internal::SceneGraph::Node::mWorldOrientation, Dali::Internal::SceneGraph::Node::mWorldPosition, Dali::Internal::SceneGraph::Node::mWorldScale, OnStage(), Dali::Actor::Property::ORIENTATION, Dali::Actor::Property::PARENT_ORIGIN, Dali::Actor::Property::PARENT_ORIGIN_X, Dali::Actor::Property::PARENT_ORIGIN_Y, Dali::Actor::Property::PARENT_ORIGIN_Z, Dali::Actor::Property::POSITION, Dali::Actor::Property::POSITION_X, Dali::Actor::Property::POSITION_Y, Dali::Actor::Property::POSITION_Z, Dali::Internal::Object::RegisterAnimatableProperty(), Dali::Actor::Property::SCALE, Dali::Actor::Property::SCALE_X, Dali::Actor::Property::SCALE_Y, Dali::Actor::Property::SCALE_Z, Dali::Actor::Property::SIZE, Dali::Actor::Property::SIZE_DEPTH, Dali::Actor::Property::SIZE_HEIGHT, Dali::Actor::Property::SIZE_WIDTH, Dali::Actor::Property::VISIBLE, Dali::Actor::Property::WORLD_COLOR, Dali::Actor::Property::WORLD_MATRIX, Dali::Actor::Property::WORLD_ORIENTATION, Dali::Actor::Property::WORLD_POSITION, Dali::Actor::Property::WORLD_POSITION_X, Dali::Actor::Property::WORLD_POSITION_Y, Dali::Actor::Property::WORLD_POSITION_Z, and Dali::Actor::Property::WORLD_SCALE.

Referenced by Dali::Internal::CameraActor::GetSceneObjectInputProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

float Actor::GetSize ( Dimension::Type  dimension) const

Return the actor size for a given dimension.

Parameters
[in]dimensionThe dimension to retrieve the size for
Returns
Return the size for the given dimension

Definition at line 3785 of file actor-impl.cpp.

References Dali::Internal::anonymous_namespace{actor-impl.cpp}::GetDimensionValue(), and GetTargetSize().

Referenced by GetLatestSize(), Dali::PropertyBuffer::GetSize(), and Dali::Stage::GetSize().

Here is the call graph for this function:

Here is the caller graph for this function:

const Vector3 & Actor::GetSizeModeFactor ( ) const

Gets the factor of the parents size used for the child actor.

Note: Only used if ResizePolicy is ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.

Returns
The vector being used to multiply the parents size by to get the childs size.

Definition at line 1043 of file actor-impl.cpp.

References Dali::Internal::anonymous_namespace{actor-impl.cpp}::GetDefaultSizeModeFactor(), mRelayoutData, and Dali::Internal::Actor::RelayoutData::sizeModeFactor.

Referenced by GetDefaultProperty(), and Dali::Actor::GetSizeModeFactor().

Here is the call graph for this function:

Here is the caller graph for this function:

SizeScalePolicy::Type Actor::GetSizeScalePolicy ( ) const

Return the size scale policy in use.

.0

Returns
Return the size scale policy.

Definition at line 1291 of file actor-impl.cpp.

References Dali::Internal::anonymous_namespace{actor-impl.cpp}::DEFAULT_SIZE_SCALE_POLICY, mRelayoutData, and Dali::Internal::Actor::RelayoutData::sizeSetPolicy.

Referenced by GetDefaultProperty(), and Dali::Actor::GetSizeScalePolicy().

Here is the caller graph for this function:

const Vector3 & Actor::GetTargetPosition ( ) const

Retrieve the target position of the Actor.

The coordinates are relative to the Actor's parent.

Returns
the Actor's position.

Definition at line 721 of file actor-impl.cpp.

References mTargetPosition.

Referenced by GetDefaultProperty(), and Dali::CameraActor::GetTargetPosition().

Here is the caller graph for this function:

const Vector3 & Actor::GetTargetSize ( ) const

Retrieve the Actor's size from event side.

This size will be the size set or if animating then the target size.

Returns
The Actor's size.

Definition at line 1211 of file actor-impl.cpp.

References mTargetSize.

Referenced by GetDefaultProperty(), GetSize(), Dali::Actor::GetTargetSize(), and NegotiateSize().

Here is the caller graph for this function:

bool Actor::GetTouchRequired ( ) const

Query whether the application or derived actor type requires touch events.

Returns
True if touch events are required.

Definition at line 1744 of file actor-impl.cpp.

References mDerivedRequiresTouch, and mTouchedSignal.

Referenced by Dali::Internal::HitTestAlgorithm::anonymous_namespace{hit-test-algorithm-impl.cpp}::ActorTouchableCheck::IsActorHittable().

Here is the caller graph for this function:

bool Actor::GetWheelEventRequired ( ) const

Query whether the application or derived actor type requires wheel events.

Returns
True if wheel events are required.

Definition at line 1754 of file actor-impl.cpp.

References mDerivedRequiresWheelEvent, and mWheelEventSignal.

float Actor::GetWidthForHeight ( float  height)
virtual

This method is called during size negotiation when a width is required for a given height.

Derived classes should override this if they wish to customize the width returned.

Parameters
heightto use.
Returns
the width based on the width.

Reimplemented in Dali::Internal::CustomActor.

Definition at line 3734 of file actor-impl.cpp.

References GetWidthForHeightBase().

Referenced by CalculateSize(), and Dali::Actor::GetWidthForHeight().

Here is the call graph for this function:

Here is the caller graph for this function:

float Actor::GetWidthForHeightBase ( float  height)

provides the Actor implementation of GetWidthForHeight

Parameters
heightto use.
Returns
the width based on the height.

Definition at line 3678 of file actor-impl.cpp.

References GetNaturalSize(), height, Dali::Vector3::height, width, and Dali::Vector3::width.

Referenced by GetWidthForHeight(), and Dali::CustomActorImpl::GetWidthForHeightBase().

Here is the call graph for this function:

Here is the caller graph for this function: