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

#include <custom-actor-internal.h>

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

Public Member Functions

CustomActorImplGetImplementation ()
 Retrieve the custom actor implementation. More...
 
const CustomActorImplGetImplementation () const
 Retrieve the custom actor implementation. More...
 
- Public Member Functions inherited from Dali::Internal::Actor
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...
 
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 bool RelayoutDependentOnChildrenBase (Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Determine if this actor is dependent on it's children for relayout. 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...
 
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 CustomActorPtr New (CustomActorImpl &extension)
 Create a new custom actor. More...
 
- Static Public Member Functions inherited from Dali::Internal::Actor
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 Member Functions

virtual ~CustomActor ()
 A reference counted object may only be deleted by calling Unreference() More...
 
- Protected Member Functions inherited from Dali::Internal::Actor
 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...
 
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

CustomActorImplPtr mImpl
 
- Protected Attributes inherited from Dali::Internal::Actor
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

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 OnPropertySet (Property::Index index, Property::Value propertyValue)
 For use in derived classes. More...
 
virtual void OnSizeSet (const Vector3 &targetSize)
 For use in derived classes. More...
 
virtual void OnSizeAnimation (Animation &animation, 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 OnKeyEvent (const KeyEvent &event)
  More...
 
virtual bool OnWheelEvent (const WheelEvent &event)
 For use in derived classes. 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 Vector3 GetNaturalSize () const
 Return the natural size of the actor. 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...
 
virtual bool RelayoutDependentOnChildren (Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Determine if this actor is dependent on it's children for relayout. 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...
 
 CustomActor (CustomActorImpl &extension)
 Private constructor; see also CustomActor::New() More...
 
 CustomActor (const CustomActor &)
 
CustomActoroperator= (const CustomActor &rhs)
 

Additional Inherited Members

- Public Types inherited from Dali::Internal::Actor
typedef std::vector
< ActorDimensionPair
ActorDimensionStack
 
- Protected Types inherited from Dali::Internal::Actor
enum  DerivedType { BASIC, LAYER, ROOT_LAYER }
 

Detailed Description

Definition at line 33 of file custom-actor-internal.h.

Constructor & Destructor Documentation

Dali::Internal::CustomActor::~CustomActor ( )
protectedvirtual

A reference counted object may only be deleted by calling Unreference()

Definition at line 48 of file custom-actor-internal.cpp.

Dali::Internal::CustomActor::CustomActor ( CustomActorImpl extension)
private
Dali::Internal::CustomActor::CustomActor ( const CustomActor )
private

Member Function Documentation

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

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 from Dali::Internal::Actor.

Definition at line 188 of file custom-actor-internal.h.

References Dali::CustomActorImpl::CalculateChildSize(), and mImpl.

Here is the call graph for this function:

virtual float Dali::Internal::CustomActor::GetHeightForWidth ( float  width)
inlineprivatevirtual

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 from Dali::Internal::Actor.

Definition at line 196 of file custom-actor-internal.h.

References Dali::CustomActorImpl::GetHeightForWidth(), and mImpl.

Here is the call graph for this function:

CustomActorImpl& Dali::Internal::CustomActor::GetImplementation ( )
inline

Retrieve the custom actor implementation.

Returns
The implementation, or an invalid pointer if no implementation was set.

Definition at line 47 of file custom-actor-internal.h.

References mImpl.

Referenced by Dali::Internal::TypeRegistry::GetTypeInfo().

Here is the caller graph for this function:

const CustomActorImpl& Dali::Internal::CustomActor::GetImplementation ( ) const
inline

Retrieve the custom actor implementation.

Returns
The implementation, or an invalid pointer if no implementation was set.

Definition at line 56 of file custom-actor-internal.h.

References mImpl.

virtual Vector3 Dali::Internal::CustomActor::GetNaturalSize ( ) const
inlineprivatevirtual

Return the natural size of the actor.

Returns
The actor's natural size

Reimplemented from Dali::Internal::Actor.

Definition at line 180 of file custom-actor-internal.h.

References Dali::CustomActorImpl::GetNaturalSize(), and mImpl.

Here is the call graph for this function:

virtual float Dali::Internal::CustomActor::GetWidthForHeight ( float  height)
inlineprivatevirtual

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 from Dali::Internal::Actor.

Definition at line 204 of file custom-actor-internal.h.

References Dali::CustomActorImpl::GetWidthForHeight(), and mImpl.

Here is the call graph for this function:

CustomActorPtr Dali::Internal::CustomActor::New ( CustomActorImpl extension)
static

Create a new custom actor.

Returns
A smart-pointer to the newly allocated Actor.

Definition at line 27 of file custom-actor-internal.cpp.

References CustomActor(), and Dali::CustomActorImpl::Initialize().

Here is the call graph for this function:

virtual void Dali::Internal::CustomActor::OnCalculateRelayoutSize ( Dimension::Type  dimension)
inlineprivatevirtual

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.

Parameters
dimensionThe dimension that is about to be calculated

Reimplemented from Dali::Internal::Actor.

Definition at line 220 of file custom-actor-internal.h.

References mImpl, and Dali::CustomActorImpl::OnCalculateRelayoutSize().

Here is the call graph for this function:

virtual void Dali::Internal::CustomActor::OnChildAdd ( Actor child)
inlineprivatevirtual

For use in derived classes; this is called after Add() has added a child.

Parameters
[in]childThe child that was added.

Reimplemented from Dali::Internal::Actor.

Definition at line 89 of file custom-actor-internal.h.

References mImpl, and Dali::CustomActorImpl::OnChildAdd().

Here is the call graph for this function:

virtual void Dali::Internal::CustomActor::OnChildRemove ( Actor child)
inlineprivatevirtual

For use in derived classes; this is called after Remove() has removed a child.

Parameters
[in]childThe child that was removed.

Reimplemented from Dali::Internal::Actor.

Definition at line 98 of file custom-actor-internal.h.

References mImpl, and Dali::CustomActorImpl::OnChildRemove().

Here is the call graph for this function:

virtual bool Dali::Internal::CustomActor::OnHoverEvent ( const HoverEvent event)
inlineprivatevirtual

For use in derived classes.

This is only called if mDerivedRequiresHover is true, and the hover-signal was not consumed.

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

Reimplemented from Dali::Internal::Actor.

Definition at line 140 of file custom-actor-internal.h.

References mImpl, and Dali::CustomActorImpl::OnHoverEvent().

Here is the call graph for this function:

virtual bool Dali::Internal::CustomActor::OnKeyEvent ( const KeyEvent event)
inlineprivatevirtual

Definition at line 148 of file custom-actor-internal.h.

References mImpl, and Dali::CustomActorImpl::OnKeyEvent().

Here is the call graph for this function:

virtual void Dali::Internal::CustomActor::OnLayoutNegotiated ( float  size,
Dimension::Type  dimension 
)
inlineprivatevirtual

Virtual method to notify deriving classes that the size for a dimension has just been negotiated.

Parameters
[in]sizeThe new size for the given dimension
[in]dimensionThe dimension that was just negotiated

Reimplemented from Dali::Internal::Actor.

Definition at line 228 of file custom-actor-internal.h.

References mImpl, and Dali::CustomActorImpl::OnLayoutNegotiated().

Here is the call graph for this function:

virtual void Dali::Internal::CustomActor::OnPropertySet ( Property::Index  index,
Property::Value  propertyValue 
)
inlineprivatevirtual

For use in derived classes.

This is called after a property is set.

Parameters
[in]indexThe index of the property.
[in]propertyValueThe value of the property.

Reimplemented from Dali::Internal::Object.

Definition at line 107 of file custom-actor-internal.h.

References mImpl, and Dali::CustomActorImpl::OnPropertySet().

Here is the call graph for this function:

virtual void Dali::Internal::CustomActor::OnRelayout ( const Vector2 size,
RelayoutContainer container 
)
inlineprivatevirtual

Called after the size negotiation has been finished for this control.

The control is expected to assign this given size to itself/its children.

Should be overridden by derived classes if they need to layout actors differently after certain operations like add or remove actors, resize or after changing specific properties.

Note! As this function is called from inside the size negotiation algorithm, you cannot call RequestRelayout (the call would just be ignored)

Parameters
[in]sizeThe allocated size.
[in,out]containerThe control should add actors to this container that it is not able to allocate a size for.

Reimplemented from Dali::Internal::Actor.

Definition at line 164 of file custom-actor-internal.h.

References mImpl, and Dali::CustomActorImpl::OnRelayout().

Here is the call graph for this function:

virtual void Dali::Internal::CustomActor::OnSetResizePolicy ( ResizePolicy::Type  policy,
Dimension::Type  dimension 
)
inlineprivatevirtual

Notification for deriving classes when the resize policy is set.

Parameters
[in]policyThe policy being set
[in]dimensionThe dimension the policy is being set for

Reimplemented from Dali::Internal::Actor.

Definition at line 172 of file custom-actor-internal.h.

References mImpl, and Dali::CustomActorImpl::OnSetResizePolicy().

Here is the call graph for this function:

virtual void Dali::Internal::CustomActor::OnSizeAnimation ( Animation animation,
const Vector3 targetSize 
)
inlineprivatevirtual

For use in derived classes.

This should only be called by Animation, when the actor is resized using Animation::Resize().

Reimplemented from Dali::Internal::Actor.

Definition at line 123 of file custom-actor-internal.h.

References mImpl, and Dali::CustomActorImpl::OnSizeAnimation().

Here is the call graph for this function:

virtual void Dali::Internal::CustomActor::OnSizeSet ( const Vector3 targetSize)
inlineprivatevirtual

For use in derived classes.

This is called after SizeSet() has been called.

Reimplemented from Dali::Internal::Actor.

Definition at line 115 of file custom-actor-internal.h.

References mImpl, and Dali::CustomActorImpl::OnSizeSet().

Here is the call graph for this function:

virtual void Dali::Internal::CustomActor::OnStageConnectionExternal ( int  depth)
inlineprivatevirtual

For use in external (CustomActor) derived classes.

This is called after the atomic ConnectToStage() traversal has been completed.

Reimplemented from Dali::Internal::Actor.

Definition at line 73 of file custom-actor-internal.h.

References mImpl, and Dali::CustomActorImpl::OnStageConnection().

Here is the call graph for this function:

virtual void Dali::Internal::CustomActor::OnStageDisconnectionExternal ( )
inlineprivatevirtual

For use in external (CustomActor) derived classes.

This is called after the atomic DisconnectFromStage() traversal has been completed.

Reimplemented from Dali::Internal::Actor.

Definition at line 81 of file custom-actor-internal.h.

References mImpl, and Dali::CustomActorImpl::OnStageDisconnection().

Here is the call graph for this function:

virtual bool Dali::Internal::CustomActor::OnTouchEvent ( const TouchEvent event)
inlineprivatevirtual

For use in derived classes.

This is only called if mDerivedRequiresTouch is true, and the touch-signal was not consumed.

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

Reimplemented from Dali::Internal::Actor.

Definition at line 132 of file custom-actor-internal.h.

References mImpl, and Dali::CustomActorImpl::OnTouchEvent().

Here is the call graph for this function:

virtual bool Dali::Internal::CustomActor::OnWheelEvent ( const WheelEvent event)
inlineprivatevirtual

For use in derived classes.

This is only called if the wheel signal was not consumed.

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

Reimplemented from Dali::Internal::Actor.

Definition at line 156 of file custom-actor-internal.h.

References mImpl, and Dali::CustomActorImpl::OnWheelEvent().

Here is the call graph for this function:

CustomActor& Dali::Internal::CustomActor::operator= ( const CustomActor rhs)
private
virtual bool Dali::Internal::CustomActor::RelayoutDependentOnChildren ( Dimension::Type  dimension = Dimension::ALL_DIMENSIONS)
inlineprivatevirtual

Determine if this actor is dependent on it's children for relayout.

Parameters
dimensionThe dimension(s) to check for
Returns
Return if the actor is dependent on it's children

Reimplemented from Dali::Internal::Actor.

Definition at line 212 of file custom-actor-internal.h.

References mImpl, and Dali::CustomActorImpl::RelayoutDependentOnChildren().

Here is the call graph for this function:

Member Data Documentation

CustomActorImplPtr Dali::Internal::CustomActor::mImpl
protected

The documentation for this class was generated from the following files:
Dali Docs Home
Read more about Dali