xiiMaterialDragDropHandler Class Reference

Copyright (c) Theophilus Eriata. All Rights Reserved. More...

#include <MaterialDragDropHandler.h>

Inheritance diagram for xiiMaterialDragDropHandler:

Protected Member Functions
virtual void	RequestConfiguration (xiiDragDropConfig *pConfigToFillOut) override
	Potentially called by the drag drop target to request information about how to determine the xiiDragDropInfo data.
virtual float	CanHandle (const xiiDragDropInfo *pInfo) const override
virtual void	OnDragBegin (const xiiDragDropInfo *pInfo) override
	Called shortly after CanHandle returned true to begin handling a drag operation.
virtual void	OnDragUpdate (const xiiDragDropInfo *pInfo) override
	Called to update the drag operation with the latest state.
virtual void	OnDragCancel () override
virtual void	OnDrop (const xiiDragDropInfo *pInfo) override
	Final call to finish the drag & drop operation. Handler is destroyed after this.
Protected Member Functions inherited from xiiAssetDragDropHandler
bool	IsAssetType (const xiiDragDropInfo *pInfo) const
xiiString	GetAssetGuidString (const xiiDragDropInfo *pInfo) const
xiiUuid	GetAssetGuid (const xiiDragDropInfo *pInfo) const
xiiString	GetAssetsDocumentTypeName (const xiiUuid &assetTypeGuid) const
bool	IsSpecificAssetType (const xiiDragDropInfo *pInfo, const char *szType) const

Protected Attributes
xiiUuid	m_AppliedToComponent
xiiInt32	m_iAppliedToSlot = -1
Protected Attributes inherited from xiiAssetDragDropHandler
xiiDocument *	m_pDocument = nullptr

Additional Inherited Members
Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTI *	GetDynamicRTTI () const
bool	IsInstanceOf (const xiiRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.
template<typename T>
XII_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.
Static Public Member Functions inherited from xiiDragDropHandler
static bool	IsHandlerActive ()
	Returns whether the last call to BeginDragDropOperation() was successful and a handler is now in effect.
static bool	BeginDragDropOperation (const xiiDragDropInfo *pInfo, xiiDragDropConfig *pConfigToFillOut=nullptr)
static void	UpdateDragDropOperation (const xiiDragDropInfo *pInfo)
	Call this when a drag event occurs. Ignored if BeginDragDropOperation() was not successful.
static void	FinishDragDrop (const xiiDragDropInfo *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 xiiDragDropInfo *pInfo)
static bool	DropOnly (const xiiDragDropInfo *pInfo)
	Executes a complete drop action on a target that does not support continuous dragging. See also CanDropOnly().
Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI *	GetStaticRTTI ()

Detailed Description

Copyright (c) Theophilus Eriata. All Rights Reserved.

Member Function Documentation

CanHandle()

float xiiMaterialDragDropHandler::CanHandle ( const xiiDragDropInfo * pInfo ) const

overrideprotectedvirtual

Used to ask a handler whether it knows how to handle a certain drag & drop situation.

The return value is a priority. By default CanHandle should return 0 or 1. To override an existing handler, values larger than 1 may be returned to take precedence.

Implements xiiDragDropHandler.

OnDragBegin()

void xiiMaterialDragDropHandler::OnDragBegin ( const xiiDragDropInfo * pInfo )

overrideprotectedvirtual

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

Implements xiiDragDropHandler.

OnDragCancel()

void xiiMaterialDragDropHandler::OnDragCancel ( )

overrideprotectedvirtual

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 xiiDragDropHandler.

OnDragUpdate()

void xiiMaterialDragDropHandler::OnDragUpdate ( const xiiDragDropInfo * pInfo )

overrideprotectedvirtual

Called to update the drag operation with the latest state.

Implements xiiDragDropHandler.

OnDrop()

void xiiMaterialDragDropHandler::OnDrop ( const xiiDragDropInfo * pInfo )

overrideprotectedvirtual

Final call to finish the drag & drop operation. Handler is destroyed after this.

Implements xiiDragDropHandler.

RequestConfiguration()

void xiiMaterialDragDropHandler::RequestConfiguration ( xiiDragDropConfig * pConfigToFillOut )

overrideprotectedvirtual

Potentially called by the drag drop target to request information about how to determine the xiiDragDropInfo data.

Reimplemented from xiiDragDropHandler.

---

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

• /home/runner/work/XII/XII/Source/EditorPlugins/Scene/EditorPluginScene/DragDropHandlers/MaterialDragDropHandler.h
• /home/runner/work/XII/XII/Source/EditorPlugins/Scene/EditorPluginScene/DragDropHandlers/MaterialDragDropHandler.cpp