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

#include <custom-object-internal.h>

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

Public Member Functions

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 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 Property::Value GetDefaultProperty (Property::Index index) const
 Retrieve a default property value. 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 ()
 
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::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 CustomObjectNew ()
 Create a new custom object. More...
 

Protected Member Functions

virtual ~CustomObject ()
 A reference counted object may only be deleted by calling Unreference() More...
 
 CustomObject ()
 Private constructor; see also CustomObject::New() More...
 
 CustomObject (const CustomObject &)
 
CustomObjectoperator= (const CustomObject &rhs)
 
- 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

SceneGraph::PropertyOwnermUpdateObject
 

Additional Inherited Members

- Public Types inherited from Dali::Internal::Object
typedef Dali::Handle::Capability Capability
 

Detailed Description

Definition at line 35 of file custom-object-internal.h.

Constructor & Destructor Documentation

Dali::Internal::CustomObject::~CustomObject ( )
protectedvirtual

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

Definition at line 110 of file custom-object-internal.cpp.

References Dali::Internal::Object::GetEventThreadServices(), Dali::Internal::Stage::IsInstalled(), mUpdateObject, and Dali::Internal::SceneGraph::RemoveObjectMessage().

Here is the call graph for this function:

Dali::Internal::CustomObject::CustomObject ( )
protected

Private constructor; see also CustomObject::New()

Definition at line 123 of file custom-object-internal.cpp.

References Dali::Internal::SceneGraph::AddObjectMessage(), Dali::Internal::Object::GetEventThreadServices(), mUpdateObject, and Dali::WeightObject::New().

Referenced by New().

Here is the call graph for this function:

Here is the caller graph for this function:

Dali::Internal::CustomObject::CustomObject ( const CustomObject )
protected

Member Function Documentation

Property::Value Dali::Internal::CustomObject::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.

Definition at line 105 of file custom-object-internal.cpp.

References Dali::Property::Value().

Here is the call graph for this function:

unsigned int Dali::Internal::CustomObject::GetDefaultPropertyCount ( ) const
virtual

Query how many default properties the derived class supports.

Returns
The number of default properties.

Implements Dali::Internal::Object.

Definition at line 61 of file custom-object-internal.cpp.

Property::Index Dali::Internal::CustomObject::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.

Definition at line 75 of file custom-object-internal.cpp.

References Dali::Property::INVALID_INDEX.

void Dali::Internal::CustomObject::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.

Definition at line 66 of file custom-object-internal.cpp.

const char * Dali::Internal::CustomObject::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.

Definition at line 70 of file custom-object-internal.cpp.

Property::Type Dali::Internal::CustomObject::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.

Definition at line 95 of file custom-object-internal.cpp.

References Dali::Property::NONE.

const SceneGraph::PropertyOwner * Dali::Internal::CustomObject::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 44 of file custom-object-internal.cpp.

References mUpdateObject.

const PropertyBase * Dali::Internal::CustomObject::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.

Definition at line 49 of file custom-object-internal.cpp.

References DALI_ASSERT_ALWAYS, Dali::Internal::Object::FindCustomProperty(), and Dali::Internal::PropertyMetadata::GetSceneGraphProperty().

Referenced by GetSceneObjectInputProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

const PropertyInputImpl * Dali::Internal::CustomObject::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.

Definition at line 56 of file custom-object-internal.cpp.

References GetSceneObjectAnimatableProperty().

Here is the call graph for this function:

bool Dali::Internal::CustomObject::IsDefaultPropertyAConstraintInput ( Property::Index  index) const
virtual

Query whether a default property can be used as an input to a constraint.

Parameters
[in]indexThe index of the property.
Returns
True if the property can be used as an input to a constraint.

Implements Dali::Internal::Object.

Definition at line 90 of file custom-object-internal.cpp.

bool Dali::Internal::CustomObject::IsDefaultPropertyAnimatable ( Property::Index  index) const
virtual

Query whether a default property is animatable.

This determines whether the property can be the target of an animation or constraint.

Parameters
[in]indexThe index of the property.
Returns
True if the property is animatable.

Implements Dali::Internal::Object.

Definition at line 85 of file custom-object-internal.cpp.

bool Dali::Internal::CustomObject::IsDefaultPropertyWritable ( Property::Index  index) const
virtual

Query whether a default property is writable.

Parameters
[in]indexThe index of the property.
Returns
True if the property is animatable.

Implements Dali::Internal::Object.

Definition at line 80 of file custom-object-internal.cpp.

CustomObject * Dali::Internal::CustomObject::New ( )
static

Create a new custom object.

Returns
A pointer to the newly allocated object.

Definition at line 39 of file custom-object-internal.cpp.

References CustomObject().

Referenced by Dali::Handle::New().

Here is the call graph for this function:

Here is the caller graph for this function:

CustomObject& Dali::Internal::CustomObject::operator= ( const CustomObject rhs)
protected
void Dali::Internal::CustomObject::SetDefaultProperty ( Property::Index  index,
const Property::Value propertyValue 
)
virtual

Set the value of a default property.

Precondition
The property types match i.e. propertyValue.GetType() is equal to GetPropertyType(index).
Parameters
[in]indexThe index of the property.
[in]propertyValueThe new value of the property.

Implements Dali::Internal::Object.

Definition at line 100 of file custom-object-internal.cpp.

Member Data Documentation

SceneGraph::PropertyOwner* Dali::Internal::CustomObject::mUpdateObject
protected

Definition at line 130 of file custom-object-internal.h.

Referenced by CustomObject(), GetSceneObject(), and ~CustomObject().


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