plLayerDragDropHandler Class Reference

Base class for drag and drop handler that drop on a plSceneLayer. More...

#include <LayerDragDropHandler.h>

Inheritance diagram for plLayerDragDropHandler:

Public Member Functions
virtual void	OnDragBegin (const plDragDropInfo *pInfo) override
	Called shortly after CanHandle returned true to begin handling a drag operation.
virtual void	OnDragUpdate (const plDragDropInfo *pInfo) override
	Called to update the drag operation with the latest state.
virtual void	OnDragCancel () override
	Called when the drag operation leaves the designated area. The handler will be destroyed after this. It should clean up all temporary objects that it created before.
Public Member Functions inherited from plReflectedClass
virtual const plRTTI *	GetDynamicRTTI () const
bool	IsInstanceOf (const plRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.
template<typename T >
PL_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Protected Member Functions
const plRTTI *	GetCommonBaseType (const plDragDropInfo *pInfo) const
Protected Member Functions inherited from plDragDropHandler
virtual float	CanHandle (const plDragDropInfo *pInfo) const =0
	Used to ask a handler whether it knows how to handle a certain drag & drop situation.
virtual void	RequestConfiguration (plDragDropConfig *pConfigToFillOut)
	Potentially called by the drag drop target to request information about how to determine the plDragDropInfo data.
virtual void	OnDrop (const plDragDropInfo *pInfo)=0
	Final call to finish the drag & drop operation. Handler is destroyed after this.

Additional Inherited Members
Static Public Member Functions inherited from plDragDropHandler
static bool	IsHandlerActive ()
	Returns whether the last call to BeginDragDropOperation() was successful and a handler is now in effect.
static bool	BeginDragDropOperation (const plDragDropInfo *pInfo, plDragDropConfig *pConfigToFillOut=nullptr)
	Call this when a drag enter event occurs. Return value indicates whether a plDragDropHandler was found to handle the operation. If not, subsequent drag & drop updates are ignored.
static void	UpdateDragDropOperation (const plDragDropInfo *pInfo)
	Call this when a drag event occurs. Ignored if BeginDragDropOperation() was not successful.
static void	FinishDragDrop (const plDragDropInfo *pInfo)
	Call this when a drop event occurs. Ignored if BeginDragDropOperation() was not successful.
static void	CancelDragDrop ()
	Call this when a drag leave event occurs. Ignored if BeginDragDropOperation() was not successful.
static bool	CanDropOnly (const plDragDropInfo *pInfo)
	For targets that do not support full dragging, but only dropping on a single target, this allows to query whether there is a handler for the given target. See also DropOnly().
static bool	DropOnly (const plDragDropInfo *pInfo)
	Executes a complete drop action on a target that does not support continuous dragging. See also CanDropOnly().
Static Public Member Functions inherited from plNoBase
static const plRTTI *	GetStaticRTTI ()

Detailed Description

Base class for drag and drop handler that drop on a plSceneLayer.

Member Function Documentation

OnDragBegin()

virtual void plLayerDragDropHandler::OnDragBegin ( const plDragDropInfo * pInfo )

inlineoverridevirtual

Called shortly after CanHandle returned true to begin handling a drag operation.

Implements plDragDropHandler.

OnDragCancel()

virtual void plLayerDragDropHandler::OnDragCancel ( )

inlineoverridevirtual

Called when the drag operation leaves the designated area. The handler will be destroyed after this. It should clean up all temporary objects that it created before.

Implements plDragDropHandler.

OnDragUpdate()

virtual void plLayerDragDropHandler::OnDragUpdate ( const plDragDropInfo * pInfo )

inlineoverridevirtual

Called to update the drag operation with the latest state.

Implements plDragDropHandler.

---

The documentation for this class was generated from the following files:

• Code/EditorPlugins/Scene/EditorPluginScene/DragDropHandlers/LayerDragDropHandler.h
• Code/EditorPlugins/Scene/EditorPluginScene/DragDropHandlers/LayerDragDropHandler.cpp