Open 3D Engine GraphCanvas Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | Static Public Attributes | List of all members
GraphCanvas::SceneMimeDelegateHandlerRequests Class Referenceabstract

#include <MimeDataHandlerBus.h>

Inherits AZ::EBusTraits.

Public Types

using BusIdType = AZ::EntityId
 

Public Member Functions

virtual bool IsInterestedInMimeData (const AZ::EntityId &sceneId, const QMimeData *mimeData)=0
 
virtual void HandleMove (const AZ::EntityId &sceneId, const QPointF &dropPoint, const QMimeData *mimeData)=0
 
virtual void HandleDrop (const AZ::EntityId &sceneId, const QPointF &dropPoint, const QMimeData *mimeData)=0
 
virtual void HandleLeave (const AZ::EntityId &sceneId, const QMimeData *mimeData)=0
 

Static Public Attributes

static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 

Detailed Description

MimeDelegateHandlerRequests This interface provides a means for pluggable MIME data handlers to provide capabilities to the default implementation (DefaultMimeDataHandler).

This allows custom handlers to be easily added to a scene for whatever use-cases a user has.

Member Function Documentation

◆ HandleDrop()

virtual void GraphCanvas::SceneMimeDelegateHandlerRequests::HandleDrop ( const AZ::EntityId &  sceneId,
const QPointF &  dropPoint,
const QMimeData *  mimeData 
)
pure virtual

When a drop takes place, the first capable handler will receive the data to process.

Parameters

  1. The scene the view is displaying.
  2. The QPoint where the drop occured.
  3. The Mime data of the drop

◆ HandleLeave()

virtual void GraphCanvas::SceneMimeDelegateHandlerRequests::HandleLeave ( const AZ::EntityId &  sceneId,
const QMimeData *  mimeData 
)
pure virtual

When a leave occurs, all interested handlers will receive the data to process

Parameters

  1. The scene the view is displaying.
  2. The Mime data of the drop

◆ HandleMove()

virtual void GraphCanvas::SceneMimeDelegateHandlerRequests::HandleMove ( const AZ::EntityId &  sceneId,
const QPointF &  dropPoint,
const QMimeData *  mimeData 
)
pure virtual

When a dragged element is moved, all interested delegates will be notified.

Parameters

  1. The scene that is receiving the event.
  2. The QMimeData associated with the drag.

◆ IsInterestedInMimeData()

virtual bool GraphCanvas::SceneMimeDelegateHandlerRequests::IsInterestedInMimeData ( const AZ::EntityId &  sceneId,
const QMimeData *  mimeData 
)
pure virtual

Is the delegate interested in the data? If no delegates are, then the drag will be refused.

Parameters

  1. The scene that is receiving the event.
  2. The QMimeData associated with the drag.
The documentation for this class was generated from the following file: