Plasma Engine  2.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
plClickGizmo Class Reference

The click gizmo displays a simple shape that can be clicked. More...

#include <ClickGizmo.h>

Inheritance diagram for plClickGizmo:
Inheritance graph
[legend]

Public Member Functions

void SetColor (const plColor &color)
 
- Public Member Functions inherited from plGizmo
void SetVisible (bool bVisible)
 
bool IsVisible () const
 
void SetTransformation (const plTransform &transform)
 
const plTransform & GetTransformation () const
 
void ConfigureInteraction (plGizmoHandle *pHandle, const plCamera *pCamera, const plVec3 &vInteractionPivot, const plVec2I32 &vViewport)
 
- Public Member Functions inherited from plEditorInputContext
void FocusLost (bool bCancel)
 
plEditorInput KeyPressEvent (QKeyEvent *e)
 
plEditorInput KeyReleaseEvent (QKeyEvent *e)
 
plEditorInput MousePressEvent (QMouseEvent *e)
 
plEditorInput MouseReleaseEvent (QMouseEvent *e)
 
plEditorInput MouseMoveEvent (QMouseEvent *e)
 
plEditorInput WheelEvent (QWheelEvent *e)
 
void MakeActiveInputContext (bool bActive=true)
 
bool IsActiveInputContext () const
 
void SetOwner (plQtEngineDocumentWindow *pOwnerWindow, plQtEngineViewWidget *pOwnerView)
 
plQtEngineDocumentWindow * GetOwnerWindow () const
 
plQtEngineViewWidget * GetOwnerView () const
 
bool GetShortcutsDisabled () const
 
void SetShortcutsDisabled (bool bDisabled)
 If set to true, the surrounding window will ensure to block all shortcuts and instead send keypress events to the input context.
 
virtual bool IsPickingSelectedAllowed () const
 
plVec2I32 SetMouseMode (MouseMode mode)
 Sets how the mouse will act when it reaches the screen border. UpdateMouseMode() must be called on every mouseMoveEvent to update the state.
 
plVec2I32 UpdateMouseMode (QMouseEvent *e)
 Updates the mouse position. Can always be called but will only have an effect if SetMouseMode() was called with one of the wrap modes.
 
virtual void UpdateStatusBarText (plQtEngineDocumentWindow *pWindow)
 
- 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

virtual plEditorInput DoMousePressEvent (QMouseEvent *e) override
 
virtual plEditorInput DoMouseReleaseEvent (QMouseEvent *e) override
 
virtual void DoFocusLost (bool bCancel) override
 
virtual void OnSetOwner (plQtEngineDocumentWindow *pOwnerWindow, plQtEngineViewWidget *pOwnerView) override
 
virtual void OnVisibleChanged (bool bVisible) override
 
virtual void OnTransformationChanged (const plTransform &transform) override
 
- Protected Member Functions inherited from plEditorInputContext
virtual plEditorInput DoKeyPressEvent (QKeyEvent *e)
 
virtual plEditorInput DoKeyReleaseEvent (QKeyEvent *e)
 
virtual plEditorInput DoMouseMoveEvent (QMouseEvent *e)
 
virtual plEditorInput DoWheelEvent (QWheelEvent *e)
 

Additional Inherited Members

- Public Types inherited from plEditorInputContext
enum class  MouseMode { Normal , WrapAtScreenBorders , HideAndWrapAtScreenBorders }
 How the mouse position is updated when the mouse cursor reaches the screen borders. More...
 
- Static Public Member Functions inherited from plEditorInputContext
static void SetActiveInputContext (plEditorInputContext *pContext)
 
static bool IsAnyInputContextActive ()
 
static plEditorInputContext * GetActiveInputContext ()
 
static void UpdateActiveInputContext ()
 
- Static Public Member Functions inherited from plNoBase
static const plRTTI * GetStaticRTTI ()
 
- Public Attributes inherited from plGizmo
plEvent< const plGizmoEvent & > m_GizmoEvents
 
- Protected Attributes inherited from plGizmo
const plCamera * m_pCamera
 
plGizmoHandle * m_pInteractionGizmoHandle
 
plVec3 m_vInteractionPivot
 
plVec2I32 m_vViewport
 

Detailed Description

The click gizmo displays a simple shape that can be clicked.

This can be used to provide the user with a way to select which part to edit further.

Member Function Documentation

◆ DoFocusLost()

void plClickGizmo::DoFocusLost ( bool bCancel)
overrideprotectedvirtual

Reimplemented from plEditorInputContext.

◆ DoMousePressEvent()

plEditorInput plClickGizmo::DoMousePressEvent ( QMouseEvent * e)
overrideprotectedvirtual

Reimplemented from plEditorInputContext.

◆ DoMouseReleaseEvent()

plEditorInput plClickGizmo::DoMouseReleaseEvent ( QMouseEvent * e)
overrideprotectedvirtual

Reimplemented from plEditorInputContext.

◆ OnSetOwner()

void plClickGizmo::OnSetOwner ( plQtEngineDocumentWindow * pOwnerWindow,
plQtEngineViewWidget * pOwnerView )
overrideprotectedvirtual

Implements plEditorInputContext.

◆ OnTransformationChanged()

void plClickGizmo::OnTransformationChanged ( const plTransform & transform)
overrideprotectedvirtual

Implements plGizmo.

◆ OnVisibleChanged()

void plClickGizmo::OnVisibleChanged ( bool bVisible)
overrideprotectedvirtual

Implements plGizmo.

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