Dali 3D User Interface Engine
List of all members | Public Types | Public Member Functions | Static Public Member Functions
Dali::PinchGestureDetector Class Reference

This class looks for pinching gestures involving two touches. More...

#include <pinch-gesture-detector.h>

Inheritance diagram for Dali::PinchGestureDetector:
Inheritance graph
[legend]
Collaboration diagram for Dali::PinchGestureDetector:
Collaboration graph
[legend]

Public Types

typedef Signal< void(Actor,
const PinchGesture &) > 
DetectedSignalType
 Signal type. More...
 

Public Member Functions

 PinchGestureDetector ()
 Create an uninitialized PinchGestureDetector; this can be initialized with PinchGestureDetector::New(). More...
 
 ~PinchGestureDetector ()
 Destructor. More...
 
 PinchGestureDetector (const PinchGestureDetector &handle)
 This copy constructor is required for (smart) pointer semantics. More...
 
PinchGestureDetectoroperator= (const PinchGestureDetector &rhs)
 This assignment operator is required for (smart) pointer semantics. More...
 
DetectedSignalTypeDetectedSignal ()
 This signal is emitted when the pinch gesture is detected on the attached actor. More...
 
DALI_INTERNAL PinchGestureDetector (Internal::PinchGestureDetector *internal)
 This constructor is used by PinchGestureDetector::New() methods. More...
 
- Public Member Functions inherited from Dali::GestureDetector
 GestureDetector ()
 Create an uninitialized GestureDetector. More...
 
 ~GestureDetector ()
 Dali::GestureDetector is intended as a base class. More...
 
 GestureDetector (const GestureDetector &handle)
 This copy constructor is required for (smart) pointer semantics. More...
 
GestureDetectoroperator= (const GestureDetector &rhs)
 This assignment operator is required for (smart) pointer semantics. More...
 
void Attach (Actor actor)
 Attaches an actor to the gesture. More...
 
void Detach (Actor actor)
 Detaches the attached actor from the gesture detector. More...
 
void DetachAll ()
 Detaches all the actors that have been attached to the gesture detector. More...
 
size_t GetAttachedActorCount () const
 Returns the number of actors attached to the gesture detector. More...
 
Actor GetAttachedActor (size_t index) const
 Returns an actor by index. More...
 
- Public Member Functions inherited from Dali::Handle
 Handle (Dali::Internal::Object *handle)
 This constructor is used by Dali New() methods. More...
 
 Handle ()
 This constructor provides an uninitialized Dali::Handle. More...
 
 ~Handle ()
 Dali::Handle is intended as a base class. More...
 
 Handle (const Handle &handle)
 This copy constructor is required for (smart) pointer semantics. More...
 
Handleoperator= (const Handle &rhs)
 This assignment operator is required for (smart) pointer semantics. More...
 
bool Supports (Capability capability) const
 Query whether an handle supports a given capability. More...
 
unsigned int GetPropertyCount () const
 Query how many properties are provided by an handle. More...
 
std::string GetPropertyName (Property::Index index) const
 Query the name of a property. More...
 
Property::Index GetPropertyIndex (const std::string &name) const
 Query the index of a property. More...
 
bool IsPropertyWritable (Property::Index index) const
 Query whether a property can be set using SetProperty(). More...
 
bool IsPropertyAnimatable (Property::Index index) const
 Query whether a writable property can be the target of an animation or constraint. More...
 
bool IsPropertyAConstraintInput (Property::Index index) const
 Query whether a property can be used as in input to a constraint. More...
 
Property::Type GetPropertyType (Property::Index index) const
 Query the type of a property. More...
 
void SetProperty (Property::Index index, const Property::Value &propertyValue)
 Set the value of an existing property. More...
 
Property::Index RegisterProperty (const std::string &name, const Property::Value &propertyValue)
 Register a new animatable property. More...
 
Property::Index RegisterProperty (const std::string &name, const Property::Value &propertyValue, Property::AccessMode accessMode)
 Register a new property. More...
 
Property::Value GetProperty (Property::Index index) const
 Retrieve a property value. More...
 
template<typename T >
GetProperty (Property::Index index) const
 Convenience function for obtaining a property of a known type. More...
 
void GetPropertyIndices (Property::IndexContainer &indices) const
 Retrieve all the property indices for this object (including custom properties). More...
 
PropertyNotification AddPropertyNotification (Property::Index index, const PropertyCondition &condition)
 Add a property notification to this object. More...
 
PropertyNotification AddPropertyNotification (Property::Index index, int componentIndex, const PropertyCondition &condition)
 Add a property notification to this object. More...
 
void RemovePropertyNotification (Dali::PropertyNotification propertyNotification)
 Remove a property notification from this object. More...
 
void RemovePropertyNotifications ()
 Remove all property notifications from this object. More...
 
void RemoveConstraints ()
 Remove all constraints from an Object. More...
 
void RemoveConstraints (unsigned int tag)
 Remove all the constraint from the Object with a matching tag. More...
 
- Public Member Functions inherited from Dali::BaseHandle
 BaseHandle (Dali::BaseObject *handle)
 This constructor is used by Dali New() methods. More...
 
 BaseHandle ()
 This constructor provides an uninitialized Dali::BaseHandle. More...
 
 ~BaseHandle ()
 Dali::BaseHandle is intended as a base class. More...
 
 BaseHandle (const BaseHandle &handle)
 This copy constructor is required for (smart) pointer semantics. More...
 
BaseHandleoperator= (const BaseHandle &rhs)
 This assignment operator is required for (smart) pointer semantics. More...
 
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...
 
BaseObjectGetBaseObject ()
 Retrieve the internal Dali resource. More...
 
const BaseObjectGetBaseObject () const
 Retrieve the internal Dali resource. More...
 
void Reset ()
 Resets the handle. More...
 
 operator BooleanType () const
 Converts an handle to a BooleanType. More...
 
bool operator== (const BaseHandle &rhs) const
 Equality operator overload. More...
 
bool operator!= (const BaseHandle &rhs) const
 Inequality operator overload. More...
 
Dali::RefObjectGetObjectPtr () const
 Get the reference counted object pointer. More...
 

Static Public Member Functions

static PinchGestureDetector New ()
 Create an initialized PinchGestureDetector. More...
 
static PinchGestureDetector DownCast (BaseHandle handle)
 Downcast a handle to PinchGestureDetector handle. More...
 
- Static Public Member Functions inherited from Dali::GestureDetector
static GestureDetector DownCast (BaseHandle handle)
 Downcast a handle to GestureDetector handle. More...
 
- Static Public Member Functions inherited from Dali::Handle
static Handle New ()
 Create a new object. More...
 
static Handle DownCast (BaseHandle handle)
 Downcast to a handle. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Dali::GestureDetector
DALI_INTERNAL GestureDetector (Internal::GestureDetector *internal)
 This constructor is used by New() methods of derived classes (For example, PanGestureDetector::New()). More...
 

Detailed Description

This class looks for pinching gestures involving two touches.

It tries to detect when the user moves two touch points towards or away from each other. Please see PinchGesture for more information.

The application programmer can use this gesture detector as follows:

detector.Attach(myActor);
detector.DetectedSignal().Connect(this, &MyApplication::OnPinch);

.0

See Also
PinchGesture

Signals

Signal Name Method
pinchDetected DetectedSignal()

Definition at line 61 of file pinch-gesture-detector.h.

Member Typedef Documentation

Signal type.

.0

Definition at line 69 of file pinch-gesture-detector.h.

Constructor & Destructor Documentation

Dali::PinchGestureDetector::PinchGestureDetector ( )

Create an uninitialized PinchGestureDetector; this can be initialized with PinchGestureDetector::New().

Calling member functions with an uninitialized PinchGestureDetector handle is not allowed. .0

Definition at line 31 of file pinch-gesture-detector.cpp.

Referenced by DownCast(), and New().

Here is the caller graph for this function:

Dali::PinchGestureDetector::~PinchGestureDetector ( )

Destructor.

This is non-virtual since derived Handle types must not contain data or virtual methods. .0

Definition at line 47 of file pinch-gesture-detector.cpp.

Dali::PinchGestureDetector::PinchGestureDetector ( const PinchGestureDetector handle)

This copy constructor is required for (smart) pointer semantics.

.0

Parameters
[in]handleA reference to the copied handle

Definition at line 51 of file pinch-gesture-detector.cpp.

Dali::PinchGestureDetector::PinchGestureDetector ( Internal::PinchGestureDetector internal)
explicit

This constructor is used by PinchGestureDetector::New() methods.

.0

Parameters
[in]internalA pointer to a newly allocated Dali resource.

Definition at line 26 of file pinch-gesture-detector.cpp.

Member Function Documentation

PinchGestureDetector::DetectedSignalType & Dali::PinchGestureDetector::DetectedSignal ( )

This signal is emitted when the pinch gesture is detected on the attached actor.

A callback of the following type may be connected:

void YourCallbackName( Actor actor, const PinchGesture& gesture );

.0

Returns
The signal to connect to.
Precondition
The gesture detector has been initialized.

Definition at line 62 of file pinch-gesture-detector.cpp.

References Dali::GetImplementation().

Referenced by Dali::Toolkit::anonymous_namespace{control-impl.cpp}::DoConnectSignal(), UtcDaliPinchGestureActorStagedAndDestroyed(), UtcDaliPinchGestureActorUnstaged(), UtcDaliPinchGestureBehindTouchableSystemOverlay(), UtcDaliPinchGestureEmitIncorrectStateClear(), UtcDaliPinchGestureEmitIncorrectStatePossible(), UtcDaliPinchGestureLayerConsumesTouch(), UtcDaliPinchGestureSignalReceptionActorBecomesUntouchable(), UtcDaliPinchGestureSignalReceptionActorDestroyedWhilePinching(), UtcDaliPinchGestureSignalReceptionAttachDetachMany(), UtcDaliPinchGestureSignalReceptionCancelled(), UtcDaliPinchGestureSignalReceptionChildHit(), UtcDaliPinchGestureSignalReceptionDetach(), UtcDaliPinchGestureSignalReceptionDetachWhilePinching(), UtcDaliPinchGestureSignalReceptionDownMotionLeave(), UtcDaliPinchGestureSignalReceptionDownMotionUp(), UtcDaliPinchGestureSignalReceptionEnsureCorrectSignalling(), UtcDaliPinchGestureSignalReceptionMultipleDetectorsOnActor(), UtcDaliPinchGestureSignalReceptionMultipleStarted(), UtcDaliPinchGestureSignalReceptionNegative(), UtcDaliPinchGestureSignalReceptionRotatedActor(), UtcDaliPinchGestureSystemOverlay(), and UtcDaliPinchGestureTouchBehindGesturedSystemOverlay().

Here is the call graph for this function:

Here is the caller graph for this function:

PinchGestureDetector Dali::PinchGestureDetector::DownCast ( BaseHandle  handle)
static

Downcast a handle to PinchGestureDetector handle.

If handle points to a PinchGestureDetector object the downcast produces valid handle. If not the returned handle is left uninitialized. .0

Parameters
[in]handleHandle to an object
Returns
Handle to a PinchGestureDetector object or an uninitialized handle

Definition at line 42 of file pinch-gesture-detector.cpp.

References Dali::BaseHandle::GetObjectPtr(), and PinchGestureDetector().

Referenced by UtcDaliPinchGestureDetectorDownCast(), and UtcDaliPinchGestureDetectorTypeRegistry().

Here is the call graph for this function:

Here is the caller graph for this function:

PinchGestureDetector Dali::PinchGestureDetector::New ( )
static

Create an initialized PinchGestureDetector.

.0

Returns
A handle to a newly allocated Dali resource.

Definition at line 35 of file pinch-gesture-detector.cpp.

References Dali::PropertyTypes::Get(), Dali::Internal::PinchGestureDetector::New(), and PinchGestureDetector().

Referenced by Dali::Internal::anonymous_namespace{pinch-gesture-detector-impl.cpp}::Create(), Dali::Toolkit::Internal::Control::EnableGestureDetection(), UtcDaliPinchGestureActorStagedAndDestroyed(), UtcDaliPinchGestureActorUnstaged(), UtcDaliPinchGestureBehindTouchableSystemOverlay(), UtcDaliPinchGestureDetectorAssignmentOperatorP(), UtcDaliPinchGestureDetectorCopyConstructorP(), UtcDaliPinchGestureDetectorDownCast(), UtcDaliPinchGestureDetectorNew(), UtcDaliPinchGestureEmitIncorrectStateClear(), UtcDaliPinchGestureEmitIncorrectStatePossible(), UtcDaliPinchGestureLayerConsumesTouch(), UtcDaliPinchGestureSignalReceptionActorBecomesUntouchable(), UtcDaliPinchGestureSignalReceptionActorDestroyedWhilePinching(), UtcDaliPinchGestureSignalReceptionAttachDetachMany(), UtcDaliPinchGestureSignalReceptionCancelled(), UtcDaliPinchGestureSignalReceptionChildHit(), UtcDaliPinchGestureSignalReceptionDetach(), UtcDaliPinchGestureSignalReceptionDetachWhilePinching(), UtcDaliPinchGestureSignalReceptionDownMotionLeave(), UtcDaliPinchGestureSignalReceptionDownMotionUp(), UtcDaliPinchGestureSignalReceptionEnsureCorrectSignalling(), UtcDaliPinchGestureSignalReceptionMultipleDetectorsOnActor(), UtcDaliPinchGestureSignalReceptionMultipleStarted(), UtcDaliPinchGestureSignalReceptionNegative(), UtcDaliPinchGestureSignalReceptionRotatedActor(), UtcDaliPinchGestureSystemOverlay(), and UtcDaliPinchGestureTouchBehindGesturedSystemOverlay().

Here is the call graph for this function:

Here is the caller graph for this function:

PinchGestureDetector & Dali::PinchGestureDetector::operator= ( const PinchGestureDetector rhs)

This assignment operator is required for (smart) pointer semantics.

.0

Parameters
[in]rhsA reference to the copied handle
Returns
A reference to this

Definition at line 56 of file pinch-gesture-detector.cpp.

References Dali::BaseHandle::operator=().

Here is the call graph for this function:


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