1 #ifndef DALI_INTERNAL_OBJECT_IMPL_HELPER_H
2 #define DALI_INTERNAL_OBJECT_IMPL_HELPER_H
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/object/property.h> // Dali::Property
23 #include <dali/public-api/object/property-index-ranges.h> // DEFAULT_DERIVED_HANDLE_PROPERTY_START_INDEX
24 #include <dali/internal/event/common/property-helper.h> // Dali::Internal::PropertyDetails
25 #include <dali/internal/event/common/stage-impl.h>
26 #include <dali/internal/update/common/animatable-property.h>
27 #include <dali/internal/update/common/property-owner-messages.h>
28 #include <dali/internal/update/manager/update-manager.h>
34 class PropertyMetadata;
35 class AnimatablePropertyMetadata;
36 class CustomPropertyMetadata;
37 class PropertyInputImpl;
46 } // namespace SceneGraph
48 // Typedefs to allow object methods to be passed via parameter
49 typedef AnimatablePropertyMetadata* (Object::*FindAnimatablePropertyMethod)( Property::Index index ) const;
50 typedef CustomPropertyMetadata* (Object::*FindCustomPropertyMethod)( Property::Index index ) const;
54 * Helper template class to be used by class that implement Object
58 * typename ObjectImplHelper<DEFAULT_PROPERTY_COUNT, DEFAULT_PROPERTY_DETAILS> MyObjectImpl;
60 * MyObjectImpl::GetDefaultPropertyCount();
63 template<int DEFAULT_PROPERTY_COUNT>
64 struct ObjectImplHelper
66 const PropertyDetails* DEFAULT_PROPERTY_DETAILS;
68 unsigned int GetDefaultPropertyCount() const
70 return DEFAULT_PROPERTY_COUNT;
73 void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const
75 indices.reserve( DEFAULT_PROPERTY_COUNT );
77 for( unsigned int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
79 indices.push_back( DEFAULT_OBJECT_PROPERTY_START_INDEX + i );
83 const char* GetDefaultPropertyName( Property::Index index ) const
85 const char* name = NULL;
87 if( index >= DEFAULT_OBJECT_PROPERTY_START_INDEX && index < DEFAULT_PROPERTY_COUNT )
89 name = DEFAULT_PROPERTY_DETAILS[index].name;
95 Property::Index GetDefaultPropertyIndex( const std::string& name ) const
97 Property::Index index = Property::INVALID_INDEX;
99 //@todo MESH_REWORK - Are we assuming that the index into the array is the
100 // same as the enumerated property? if enumIndex in the table was no longer
101 // debug only, wouldn't need to make this assumption.
103 // Look for name in default properties
104 for( unsigned int i = 0; i < DEFAULT_PROPERTY_COUNT; ++i )
106 const Internal::PropertyDetails* property = &DEFAULT_PROPERTY_DETAILS[ i ];
107 if( 0 == strcmp( name.c_str(), property->name ) ) // dont want to convert rhs to string
117 bool IsDefaultPropertyWritable( Property::Index index ) const
119 bool isWritable = false;
121 if( index >= DEFAULT_OBJECT_PROPERTY_START_INDEX && index < DEFAULT_PROPERTY_COUNT )
123 isWritable = DEFAULT_PROPERTY_DETAILS[index].writable;
129 bool IsDefaultPropertyAnimatable( Property::Index index ) const
131 bool isAnimatable = false;
133 if( index >= DEFAULT_OBJECT_PROPERTY_START_INDEX && index < DEFAULT_PROPERTY_COUNT )
135 isAnimatable = DEFAULT_PROPERTY_DETAILS[index].animatable;
141 bool IsDefaultPropertyAConstraintInput( Property::Index index ) const
143 bool isConstraintInput = false;
145 if( index >= DEFAULT_OBJECT_PROPERTY_START_INDEX && index < DEFAULT_PROPERTY_COUNT )
147 isConstraintInput = DEFAULT_PROPERTY_DETAILS[index].constraintInput;
150 return isConstraintInput;
153 Property::Type GetDefaultPropertyType( Property::Index index ) const
155 Property::Type type = Property::NONE;
157 if( index >= DEFAULT_OBJECT_PROPERTY_START_INDEX && index < DEFAULT_PROPERTY_COUNT )
159 type = DEFAULT_PROPERTY_DETAILS[index].type;
165 // Get the (animatable) scene graph property. (All registered scene graph properties are animatable)
166 const SceneGraph::PropertyBase* GetRegisteredSceneGraphProperty(
167 const Object* object,
168 FindAnimatablePropertyMethod findAnimatablePropertyMethod,
169 FindCustomPropertyMethod findCustomPropertyMethod,
170 Property::Index index ) const
172 const SceneGraph::PropertyBase* property = NULL;
173 if ( index >= ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX && index <= ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX )
175 AnimatablePropertyMetadata* animatable = (object->*findAnimatablePropertyMethod)( index );
176 DALI_ASSERT_ALWAYS( animatable && "Property index is invalid" );
177 property = animatable->GetSceneGraphProperty();
179 else if ( index >= DEFAULT_PROPERTY_MAX_COUNT )
181 CustomPropertyMetadata* custom = (object->*findCustomPropertyMethod)( index );
182 DALI_ASSERT_ALWAYS( custom && "Property index is invalid" );
183 property = custom->GetSceneGraphProperty();
188 void SetSceneGraphProperty( EventThreadServices& eventThreadServices,
189 const Object* object,
190 Property::Index index,
191 const PropertyMetadata& entry,
192 const Property::Value& value ) const
194 const SceneGraph::PropertyOwner* sceneObject = object->GetSceneObject();
196 switch ( entry.type )
198 case Property::BOOLEAN:
200 const SceneGraph::AnimatableProperty<bool>* property = dynamic_cast< const SceneGraph::AnimatableProperty<bool>* >( entry.GetSceneGraphProperty() );
201 DALI_ASSERT_DEBUG( NULL != property );
203 // property is being used in a separate thread; queue a message to set the property
204 SceneGraph::AnimatablePropertyMessage<bool>::Send( eventThreadServices, sceneObject, property, &SceneGraph::AnimatableProperty<bool>::Bake, value.Get<bool>() );
209 case Property::FLOAT:
211 const SceneGraph::AnimatableProperty<float>* property = dynamic_cast< const SceneGraph::AnimatableProperty<float>* >( entry.GetSceneGraphProperty() );
212 DALI_ASSERT_DEBUG( NULL != property );
214 // property is being used in a separate thread; queue a message to set the property
215 SceneGraph::AnimatablePropertyMessage<float>::Send( eventThreadServices, sceneObject, property, &SceneGraph::AnimatableProperty<float>::Bake, value.Get<float>() );
220 case Property::INTEGER:
222 const SceneGraph::AnimatableProperty<int>* property = dynamic_cast< const SceneGraph::AnimatableProperty<int>* >( entry.GetSceneGraphProperty() );
223 DALI_ASSERT_DEBUG( NULL != property );
225 // property is being used in a separate thread; queue a message to set the property
226 SceneGraph::AnimatablePropertyMessage<int>::Send( eventThreadServices, sceneObject, property, &SceneGraph::AnimatableProperty<int>::Bake, value.Get<int>() );
231 case Property::VECTOR2:
233 const SceneGraph::AnimatableProperty<Vector2>* property = dynamic_cast< const SceneGraph::AnimatableProperty<Vector2>* >( entry.GetSceneGraphProperty() );
234 DALI_ASSERT_DEBUG( NULL != property );
236 // property is being used in a separate thread; queue a message to set the property
237 SceneGraph::AnimatablePropertyMessage<Vector2>::Send( eventThreadServices, sceneObject, property, &SceneGraph::AnimatableProperty<Vector2>::Bake, value.Get<Vector2>() );
242 case Property::VECTOR3:
244 const SceneGraph::AnimatableProperty<Vector3>* property = dynamic_cast< const SceneGraph::AnimatableProperty<Vector3>* >( entry.GetSceneGraphProperty() );
245 DALI_ASSERT_DEBUG( NULL != property );
247 // property is being used in a separate thread; queue a message to set the property
248 SceneGraph::AnimatablePropertyMessage<Vector3>::Send( eventThreadServices, sceneObject, property, &SceneGraph::AnimatableProperty<Vector3>::Bake, value.Get<Vector3>() );
253 case Property::VECTOR4:
255 const SceneGraph::AnimatableProperty<Vector4>* property = dynamic_cast< const SceneGraph::AnimatableProperty<Vector4>* >( entry.GetSceneGraphProperty() );
256 DALI_ASSERT_DEBUG( NULL != property );
258 // property is being used in a separate thread; queue a message to set the property
259 SceneGraph::AnimatablePropertyMessage<Vector4>::Send( eventThreadServices, sceneObject, property, &SceneGraph::AnimatableProperty<Vector4>::Bake, value.Get<Vector4>() );
264 case Property::ROTATION:
266 const SceneGraph::AnimatableProperty<Quaternion>* property = dynamic_cast< const SceneGraph::AnimatableProperty<Quaternion>* >( entry.GetSceneGraphProperty() );
267 DALI_ASSERT_DEBUG( NULL != property );
269 // property is being used in a separate thread; queue a message to set the property
270 SceneGraph::AnimatablePropertyMessage<Quaternion>::Send( eventThreadServices, sceneObject, property,&SceneGraph::AnimatableProperty<Quaternion>::Bake, value.Get<Quaternion>() );
275 case Property::MATRIX:
277 const SceneGraph::AnimatableProperty<Matrix>* property = dynamic_cast< const SceneGraph::AnimatableProperty<Matrix>* >( entry.GetSceneGraphProperty() );
278 DALI_ASSERT_DEBUG( NULL != property );
280 // property is being used in a separate thread; queue a message to set the property
281 SceneGraph::AnimatablePropertyMessage<Matrix>::Send( eventThreadServices, sceneObject, property,&SceneGraph::AnimatableProperty<Matrix>::Bake, value.Get<Matrix>() );
286 case Property::MATRIX3:
288 const SceneGraph::AnimatableProperty<Matrix3>* property = dynamic_cast< const SceneGraph::AnimatableProperty<Matrix3>* >( entry.GetSceneGraphProperty() );
289 DALI_ASSERT_DEBUG( NULL != property );
291 // property is being used in a separate thread; queue a message to set the property
292 SceneGraph::AnimatablePropertyMessage<Matrix3>::Send( eventThreadServices, sceneObject, property, &SceneGraph::AnimatableProperty<Matrix3>::Bake, value.Get<Matrix3>() );
299 DALI_ASSERT_ALWAYS( false && "Property type enumeration out of bounds" ); // should not come here
305 int GetPropertyComponentIndex( Property::Index index ) const
308 DALI_ASSERT_ALWAYS( false && "TODO: MESH_REWORK" );
315 } // namespace Internal
319 #endif // DALI_INTERNAL_OBJECT_IMPL_HELPER_H