DIWNE::Link
#include "DIWNE/Link.h"
Inherits from DIWNE::DiwneObject, std::enable_shared_from_this< DiwneObject >
Public Functions
| Name | |
|---|---|
| Link(DIWNE::Diwne & diwne, DIWNE::ID id, std::string const labelDiwne ="DiwneLink") | |
| virtual | ~Link()<br>Default destructor. |
| virtual void | begin() |
| virtual bool | bypassFocusAction() |
| virtual bool | bypassFocusForInteractionAction() |
| virtual bool | content() |
| virtual void | end() |
| virtual DIWNE::DiwneAction | getDragActionType() const |
| ImVec2 | getEndControlPoint() |
| ImVec2 | getEndpoint() |
| virtual DIWNE::DiwneAction | getHoldActionType() const |
| virtual ImRect | getRectDiwne() const override |
| ImVec2 | getStartControlPoint() |
| ImVec2 | getStartpoint() |
| virtual DIWNE::DiwneAction | getTouchActionType() const |
| virtual bool | initialize() |
| virtual bool | initializeDiwne() |
| bool | isLinkOnWorkArea() |
| virtual bool | processFocused() |
| virtual bool | processFocusedForInteraction() |
| void | setLinkEndpointsDiwne(const ImVec2 start, const ImVec2 end) |
| void | updateControlPoints() |
| virtual void | updateEndpoints() |
| void | updateSquareDistanceMouseFromLink() |
Public Attributes
| Name | |
|---|---|
| bool | m_just_pluged |
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 | 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 | interactionBeginInLastDraw() |
| virtual bool | interactionEndInLastDraw() |
| virtual void | popupContent()<br>Content of popup menu raise on this object. |
| virtual bool | processDrag() |
| bool | processDragDiwne() |
| bool | processFocusedDiwne() |
| bool | processFocusedForInteractionDiwne() |
| virtual bool | processHold() |
| bool | processHoldDiwne() |
| virtual bool | processInteractions() |
| virtual bool | processInteractionsAlways() |
| 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. |
| virtual void | updateSizes() |
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 Link
cpp
Link(
DIWNE::Diwne & diwne,
DIWNE::ID id,
std::string const labelDiwne ="DiwneLink"
)Link(
DIWNE::Diwne & diwne,
DIWNE::ID id,
std::string const labelDiwne ="DiwneLink"
)function ~Link
cpp
inline virtual ~Link()inline virtual ~Link()Default destructor.
function begin
cpp
inline virtual void begin()inline virtual void begin()Reimplements: DIWNE::DiwneObject::begin
begin of object
function bypassFocusAction
cpp
virtual bool bypassFocusAction()virtual bool bypassFocusAction()Reimplements: DIWNE::DiwneObject::bypassFocusAction
action identified as focusing on object (and prevent underlying object from focusing)
function bypassFocusForInteractionAction
cpp
virtual bool bypassFocusForInteractionAction()virtual bool bypassFocusForInteractionAction()Reimplements: DIWNE::DiwneObject::bypassFocusForInteractionAction
action identified as focusing on object for interacting with it
function content
cpp
virtual bool content()virtual bool content()Reimplements: DIWNE::DiwneObject::content
content of object
function end
cpp
inline virtual void end()inline virtual void end()Reimplements: DIWNE::DiwneObject::end
link is not ImGui element - it is just picture of line
function getDragActionType
cpp
inline virtual DIWNE::DiwneAction getDragActionType() constinline virtual DIWNE::DiwneAction getDragActionType() constReimplements: DIWNE::DiwneObject::getDragActionType
return which type of object/action this object is
function getEndControlPoint
cpp
inline ImVec2 getEndControlPoint()inline ImVec2 getEndControlPoint()function getEndpoint
cpp
inline ImVec2 getEndpoint()inline ImVec2 getEndpoint()function getHoldActionType
cpp
inline virtual DIWNE::DiwneAction getHoldActionType() constinline virtual DIWNE::DiwneAction getHoldActionType() constReimplements: DIWNE::DiwneObject::getHoldActionType
return which type of object/action this object is
function getRectDiwne
cpp
inline virtual ImRect getRectDiwne() const overrideinline virtual ImRect getRectDiwne() const overrideReimplements: DIWNE::DiwneObject::getRectDiwne
return rectangle of object
function getStartControlPoint
cpp
inline ImVec2 getStartControlPoint()inline ImVec2 getStartControlPoint()function getStartpoint
cpp
inline ImVec2 getStartpoint()inline ImVec2 getStartpoint()function getTouchActionType
cpp
inline virtual DIWNE::DiwneAction getTouchActionType() constinline virtual DIWNE::DiwneAction getTouchActionType() constReimplements: DIWNE::DiwneObject::getTouchActionType
return which type of object/action this object is
function initialize
cpp
virtual bool initialize()virtual bool initialize()Reimplements: DIWNE::DiwneObject::initialize
is called every time in drawDiwne() do any initialization of your object here
function initializeDiwne
cpp
virtual bool initializeDiwne()virtual bool initializeDiwne()Reimplements: DIWNE::DiwneObject::initializeDiwne
DIWNE wrapper
function isLinkOnWorkArea
cpp
bool isLinkOnWorkArea()bool isLinkOnWorkArea()in fact just rectangle (from startPoint to endPoint) check - so could return true while Link is not visible
function processFocused
cpp
virtual bool processFocused()virtual bool processFocused()Reimplements: DIWNE::DiwneObject::processFocused
function processFocusedForInteraction
cpp
virtual bool processFocusedForInteraction()virtual bool processFocusedForInteraction()Reimplements: DIWNE::DiwneObject::processFocusedForInteraction
function setLinkEndpointsDiwne
cpp
inline void setLinkEndpointsDiwne(
const ImVec2 start,
const ImVec2 end
)inline void setLinkEndpointsDiwne(
const ImVec2 start,
const ImVec2 end
)function updateControlPoints
cpp
void updateControlPoints()void updateControlPoints()function updateEndpoints
cpp
inline virtual void updateEndpoints()inline virtual void updateEndpoints()function updateSquareDistanceMouseFromLink
cpp
void updateSquareDistanceMouseFromLink()void updateSquareDistanceMouseFromLink()Public Attributes Documentation
variable m_just_pluged
cpp
bool m_just_pluged;bool m_just_pluged;< not select link when just pluged
Updated on 2024-11-06 at 20:16:54 +0000