XII Release 0.1.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
xiiSkeletonComponentDragDropHandler Class Reference
Inheritance diagram for xiiSkeletonComponentDragDropHandler:
[legend]

Public Member Functions

virtual float CanHandle (const xiiDragDropInfo *pInfo) const override
 Used to ask a handler whether it knows how to handle a certain drag & drop situation.
 
virtual void OnDragBegin (const xiiDragDropInfo *pInfo) override
 Called shortly after CanHandle returned true to begin handling a drag operation.
 
- 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.
 

Additional Inherited Members

- 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)
 Call this when a drag enter event occurs. Return value indicates whether a xiiDragDropHandler was found to handle the operation. If not, subsequent drag & drop updates are ignored.
 
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)
 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 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 ()
 
- Protected Member Functions inherited from xiiComponentDragDropHandler
void CreateDropObject (const xiiVec3 &vPosition, const char *szType, const char *szProperty, const xiiVariant &value, xiiUuid parent, xiiInt32 iInsertChildIndex)
 
void AttachComponentToObject (const char *szType, const char *szProperty, const xiiVariant &value, xiiUuid ObjectGuid)
 
void MoveObjectToPosition (const xiiUuid &guid, const xiiVec3 &vPosition, const xiiQuat &qRotation)
 
void MoveDraggedObjectsToPosition (xiiVec3 vPosition, bool bAllowSnap, const xiiVec3 &normal)
 
void SelectCreatedObjects ()
 
void BeginTemporaryCommands ()
 
void EndTemporaryCommands ()
 
void CancelTemporaryCommands ()
 
virtual void OnDragUpdate (const xiiDragDropInfo *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.
 
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 Member Functions inherited from xiiDragDropHandler
virtual void RequestConfiguration (xiiDragDropConfig *pConfigToFillOut)
 Potentially called by the drag drop target to request information about how to determine the xiiDragDropInfo data.
 
- Protected Attributes inherited from xiiComponentDragDropHandler
xiiDocument * m_pDocument
 
xiiHybridArray< xiiUuid, 16 > m_DraggedObjects
 
xiiVec3 m_vAlignAxisWithNormal = xiiVec3::MakeZero()
 
bool m_bSelectionAsRuntimeOverride = true
 
- Protected Attributes inherited from xiiAssetDragDropHandler
xiiDocument * m_pDocument
 

Member Function Documentation

◆ CanHandle()

float xiiSkeletonComponentDragDropHandler::CanHandle ( const xiiDragDropInfo * pInfo) const
overridevirtual

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.

Reimplemented from xiiComponentDragDropHandler.

◆ OnDragBegin()

void xiiSkeletonComponentDragDropHandler::OnDragBegin ( const xiiDragDropInfo * pInfo)
overridevirtual

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

Reimplemented from xiiComponentDragDropHandler.

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