DIWNE::Pin
#include "DIWNE/Pin.h"
Inherits from DIWNE::DiwneObject, std::enable_shared_from_this< DiwneObject >
Inherited by Workspace::CorePin
Public Functions
| Name | |
|---|---|
| Pin(DIWNE::Diwne & diwne, DIWNE::ID id, std::string const labelDiwne ="DiwnePin")<br>Default constructor. | |
| virtual | ~Pin()<br>Default destructor. |
| virtual bool | allowProcessPin_Pre_ConnectLink() |
| virtual void | begin() override |
| virtual bool | bypassPinLinkConnectionPreparedAction() |
| virtual bool | content() |
| virtual void | end() override |
| virtual DIWNE::DiwneAction | getDragActionType() const |
| virtual DIWNE::DiwneAction | getHoldActionType() const |
| DIWNE::ID const | getId() const |
| virtual const ImVec2 & | getLinkConnectionPointDiwne() |
| virtual ImRect | getRectDiwne() const override |
| virtual DIWNE::DiwneAction | getTouchActionType() const |
| virtual bool | processConnectionPrepared() |
| virtual bool | processDrag() override |
| virtual bool | processInteractionsAlways() override |
| virtual bool | processPin_Pre_ConnectLinkDiwne()<br>Wrapper is run when new link is created and goal pin is hovered but action not released yet. |
| virtual void | setConnectionPointDiwne(const ImVec2 value) |
| virtual void | updateSizes() override |
Protected Functions
| Name | |
|---|---|
| virtual void | updateConnectionPointDiwne() |
Protected Attributes
| Name | |
|---|---|
| ImVec2 | m_connectionPointDiwne |
| ImRect | m_pinRectDiwne <br>PIN bounding rectangle. |
Additional inherited members
Public Functions inherited from DIWNE::DiwneObject
| Name | |
|---|---|
| DiwneObject(DIWNE::Diwne & diwne, DIWNE::ID id, std::string const labelDiwne)<br>Constructor. | |
| virtual | ~DiwneObject() =default |
| virtual bool | afterContent() |
| virtual bool | afterContentDiwne() |
| virtual bool | afterEnd() |
| virtual bool | afterEndDiwne() |
| virtual bool | allowDrawing()<br>Decision maker whether object should be drawn (not outside of window for example) |
| virtual bool | allowInteraction()<br>Decision maker whether object can interact (not include content elements) |
| virtual bool | allowProcessDrag() |
| virtual bool | allowProcessFocused() |
| virtual bool | allowProcessFocusedForInteraction() |
| virtual bool | allowProcessHold() |
| virtual bool | allowProcessRaisePopup() |
| virtual bool | allowProcessSelect() |
| virtual bool | allowProcessUnhold() |
| virtual bool | allowProcessUnselect() |
| virtual bool | beforeBegin() |
| virtual bool | beforeBeginDiwne() |
| virtual bool | beforeContent() |
| virtual bool | beforeContentDiwne() |
| virtual bool | bypassDragAction() |
| virtual bool | bypassFocusAction() |
| virtual bool | bypassFocusForInteractionAction() |
| virtual bool | bypassHoldAction() |
| virtual bool | bypassRaisePopupAction() |
| virtual bool | bypassSelectAction() |
| virtual bool | bypassTouchAction() |
| virtual bool | bypassUnholdAction() |
| virtual bool | bypassUnselectAction() |
| virtual bool | contentDiwne() |
| virtual bool | drawDiwne(DrawMode drawMode =DrawMode::Interacting)<br>Main function for drawing object and deal with interactions. |
| virtual bool | finalize() |
| virtual bool | finalizeDiwne() |
| DIWNE::ID const | getIdDiwne() const |
| virtual bool | getSelectable() |
| virtual bool | getSelected() const<br>Getter of selection state. |
| virtual bool | initialize() |
| virtual bool | initializeDiwne() |
| virtual bool | interactionBeginInLastDraw() |
| virtual bool | interactionEndInLastDraw() |
| virtual void | popupContent()<br>Content of popup menu raise on this object. |
| bool | processDragDiwne() |
| virtual bool | processFocused() |
| bool | processFocusedDiwne() |
| virtual bool | processFocusedForInteraction() |
| bool | processFocusedForInteractionDiwne() |
| virtual bool | processHold() |
| bool | processHoldDiwne() |
| virtual bool | processInteractions() |
| virtual bool | processInteractionsDiwne() |
| virtual bool | processRaisePopupDiwne() |
| virtual bool | processSelect() |
| bool | processSelectDiwne() |
| virtual bool | processShowPopupDiwne() |
| virtual bool | processUnhold() |
| bool | processUnholdDiwne() |
| virtual bool | processUnselect() |
| bool | processUnselectDiwne() |
| virtual void | setSelectable(bool const selectable) |
| virtual bool | setSelected(bool const selected) |
| void | showTooltipLabel(std::string const & label, ImColor const && color)<br>Show a colored text for example for immediate hints. |
Public Attributes inherited from DIWNE::DiwneObject
| Name | |
|---|---|
| DIWNE::Diwne & | diwne |
| DrawMode | m_drawMode |
| bool | m_focused |
| bool | m_focusedForInteraction |
| DIWNE::ID const | m_idDiwne |
| bool | m_inner_interaction_happen |
| bool | m_inner_interaction_happen_previous_draw |
| bool | m_isActive |
| bool | m_isDragged |
| bool | m_isHeld |
| std::string const | m_labelDiwne |
| std::string const | m_popupIDDiwne |
| bool | m_selectable |
| bool | m_selected |
Public Functions Documentation
function Pin
Pin(
DIWNE::Diwne & diwne,
DIWNE::ID id,
std::string const labelDiwne ="DiwnePin"
)Pin(
DIWNE::Diwne & diwne,
DIWNE::ID id,
std::string const labelDiwne ="DiwnePin"
)Default constructor.
function ~Pin
inline virtual ~Pin()inline virtual ~Pin()Default destructor.
function allowProcessPin_Pre_ConnectLink
virtual bool allowProcessPin_Pre_ConnectLink()virtual bool allowProcessPin_Pre_ConnectLink()function begin
virtual void begin() overridevirtual void begin() overrideReimplements: DIWNE::DiwneObject::begin
begin of object
function bypassPinLinkConnectionPreparedAction
virtual bool bypassPinLinkConnectionPreparedAction()virtual bool bypassPinLinkConnectionPreparedAction()function content
inline virtual bool content()inline virtual bool content()Reimplements: DIWNE::DiwneObject::content
Reimplemented by: Workspace::CorePin::content, Workspace::CoreInPin::content, Workspace::CoreOutPin::content, Workspace::DataOutPin::content
content of object
function end
virtual void end() overridevirtual void end() overrideReimplements: DIWNE::DiwneObject::end
closing object
function getDragActionType
inline virtual DIWNE::DiwneAction getDragActionType() constinline virtual DIWNE::DiwneAction getDragActionType() constReimplements: DIWNE::DiwneObject::getDragActionType
return which type of object/action this object is
function getHoldActionType
inline virtual DIWNE::DiwneAction getHoldActionType() constinline virtual DIWNE::DiwneAction getHoldActionType() constReimplements: DIWNE::DiwneObject::getHoldActionType
return which type of object/action this object is
function getId
inline DIWNE::ID const getId() constinline DIWNE::ID const getId() constfunction getLinkConnectionPointDiwne
inline virtual const ImVec2 & getLinkConnectionPointDiwne()inline virtual const ImVec2 & getLinkConnectionPointDiwne()function getRectDiwne
inline virtual ImRect getRectDiwne() const overrideinline virtual ImRect getRectDiwne() const overrideReimplements: DIWNE::DiwneObject::getRectDiwne
return rectangle of object
function getTouchActionType
inline virtual DIWNE::DiwneAction getTouchActionType() constinline virtual DIWNE::DiwneAction getTouchActionType() constReimplements: DIWNE::DiwneObject::getTouchActionType
return which type of object/action this object is
function processConnectionPrepared
virtual bool processConnectionPrepared()virtual bool processConnectionPrepared()Reimplemented by: Workspace::CorePin::processConnectionPrepared
your content/actions when new link hovered goal pin but not released yet
function processDrag
virtual bool processDrag() overridevirtual bool processDrag() overrideReimplements: DIWNE::DiwneObject::processDrag
function processInteractionsAlways
virtual bool processInteractionsAlways() overridevirtual bool processInteractionsAlways() overrideReimplements: DIWNE::DiwneObject::processInteractionsAlways
processes that happen even in allowInteraction() return false, but object still has to be in DrawMode::Interaction
function processPin_Pre_ConnectLinkDiwne
virtual bool processPin_Pre_ConnectLinkDiwne()virtual bool processPin_Pre_ConnectLinkDiwne()Wrapper is run when new link is created and goal pin is hovered but action not released yet.
Return: virtual bool
function setConnectionPointDiwne
inline virtual void setConnectionPointDiwne(
const ImVec2 value
)inline virtual void setConnectionPointDiwne(
const ImVec2 value
)function updateSizes
virtual void updateSizes() overridevirtual void updateSizes() overrideReimplements: DIWNE::DiwneObject::updateSizes
store object size and position after this frame
Protected Functions Documentation
function updateConnectionPointDiwne
inline virtual void updateConnectionPointDiwne()inline virtual void updateConnectionPointDiwne()Reimplemented by: Workspace::CoreInPin::updateConnectionPointDiwne, Workspace::CoreOutPin::updateConnectionPointDiwne
intended to use when Pin is drawn (use properties dependent on drawing)
- setConnectionPointDiwne is "hard" setting
Protected Attributes Documentation
variable m_connectionPointDiwne
ImVec2 m_connectionPointDiwne;ImVec2 m_connectionPointDiwne;point of link connection to this pin (wire start or end)
variable m_pinRectDiwne
ImRect m_pinRectDiwne;ImRect m_pinRectDiwne;PIN bounding rectangle.
Updated on 2025-01-07 at 13:40:44 +0000