Castor3D 0.15.0
Multiplatform 3D engine
Fonctions membres publiques | Attributs publics statiques | Liste de tous les membres
Référence de la classe castor3d::PanelCtrl

#include <CtrlPanel.hpp>

Graphe d'héritage de castor3d::PanelCtrl:
Inheritance graph
[légende]
Graphe de collaboration de castor3d::PanelCtrl:
Collaboration graph
[légende]

Fonctions membres publiques

C3D_API PanelCtrl (SceneRPtr scene, castor::String const &name, PanelStyle *style, ControlRPtr parent)
 
C3D_API PanelCtrl (SceneRPtr scene, castor::String const &name, PanelStyle *style, ControlRPtr parent, castor::Position const &position, castor::Size const &size, ControlFlagType flags=0, bool visible=true)
 
PanelStyle const & getStyle () const
 
PanelStyle & getStyle ()
 
- Fonctions membres publiques hérités de castor3d::LayoutControl
C3D_API LayoutControl (ControlType type, SceneRPtr scene, castor::String const &name, ControlStyleRPtr controlStyle, ScrollableStyleRPtr scrollableStyle, ControlRPtr parent, castor::Position const &position, castor::Size const &size, ControlFlagType flags=0, bool visible=true)
 
C3D_API void setLayout (LayoutUPtr layout)
 
auto getLayout () const
 
- Fonctions membres publiques hérités de castor3d::Control
C3D_API Control (ControlType type, SceneRPtr scene, castor::String const &name, ControlStyleRPtr style, ControlRPtr parent, castor::Position const &position, castor::Size const &size, ControlFlagType flags=0, bool visible=true)
 
C3D_API ~Control () noexcept override
 
C3D_API void setStyle (ControlStyleRPtr value)
 
C3D_API void setPosition (castor::Position const &value)
 
C3D_API void setSize (castor::Size const &value)
 
C3D_API void setUV (castor::Point4d const &value)
 
C3D_API void setBorderSize (castor::Point4ui const &value)
 
C3D_API void setBorderInnerUV (castor::Point4d const &value)
 
C3D_API void setBorderOuterUV (castor::Point4d const &value)
 
C3D_API void setCaption (castor::U32String const &caption)
 
C3D_API void setVisible (bool value)
 
C3D_API castor::Position getAbsolutePosition () const
 
C3D_API bool isVisible () const
 
C3D_API bool isBackgroundInvisible () const
 
C3D_API ControlRPtr getChildControl (ControlID id) const
 
C3D_API std::array< bool, 4u > isInResizeRange (castor::Position const &position) const
 
template<ControlFlagTypeT FlagTypeT>
void addFlag (FlagTypeT flag)
 
template<ControlFlagTypeT FlagTypeT>
void addFlag (castor::FlagCombination< FlagTypeT > flag)
 
template<ControlFlagTypeT FlagTypeT>
void removeFlag (FlagTypeT flag)
 
template<ControlFlagTypeT FlagTypeT>
void removeFlag (castor::FlagCombination< FlagTypeT > flag)
 
C3D_API castor::Point4d const & getBorderInnerUV () const
 
C3D_API castor::Point4d const & getBorderOuterUV () const
 
C3D_API BorderPosition getBorderPosition () const
 
C3D_API castor::Point4d const & getUV () const
 
C3D_API bool isBackgroundVisible () const
 
ControlID getId () const noexcept
 
ControlType getType () const noexcept
 
uint64_t getFlags () const noexcept
 
castor::Position const & getPosition () const noexcept
 
castor::Size const & getSize () const noexcept
 
ControlRPtr getParent () const noexcept
 
castor::Point4ui const & getBorderSize () const noexcept
 
ControlsManagerRPtr getControlsManager () const noexcept
 
MouseCursor getCursor () const noexcept
 
Engine & getEngine () const noexcept
 
ControlStyle const & getBaseStyle () const noexcept
 
std::vector< ControlRPtr > const & getChildren () const noexcept
 
bool hasScene () const noexcept
 
Scene & getScene () const noexcept
 
uint32_t getResizeBorderSize () const noexcept
 
castor::Point4ui const & getClientRect () const noexcept
 
castor::Position getClientOffset () const
 
castor::Size getClientSize () const
 
bool isAlwaysOnTop () const noexcept
 
bool isMovable () const noexcept
 
bool isResizable () const noexcept
 
void show ()
 
void hide ()
 
- Fonctions membres publiques hérités de castor3d::NonClientEventHandler< Control >
 NonClientEventHandler (castor::String const &name, bool catchMouseEvents)
 Constructeur.
 
void connectNC (MouseEventType event, NonClientMouseFunction function)
 Connecte un fonction à un évènement souris non client.
 
void connectNC (KeyboardEventType event, NonClientKeyboardFunction function)
 Connecte un fonction à un évènement clavier non client.
 
void connectNC (HandlerEventType event, NonClientHandlerFunction function)
 Connecte un fonction à un évènement gestionnaire non client.
 
- Fonctions membres publiques hérités de castor3d::EventHandler
void pushEvent (MouseEvent const &event)
 Ajoute un évènement de souris à la file.
 
void connect (MouseEventType event, ClientMouseFunction function)
 Connecte un fonction à un évènement souris.
 
bool catchesMouseEvents () const
 
void setCatchesMouseEvents (bool value)
 
void pushEvent (KeyboardEvent const &event)
 Ajoute un évènement de clavier à la file.
 
void connect (KeyboardEventType event, ClientKeyboardFunction function)
 Connecte un fonction à un évènement clavier.
 
bool catchesTabKey () const
 
bool catchesReturnKey () const
 
 EventHandler (castor::String const &name, bool catchMouseEvents)
 Constructeur.
 
virtual ~EventHandler ()
 Destructeur.
 
void processEvents ()
 Traite tous les évènement dans la file.
 
bool isEnabled () const
 
void enable ()
 
void disable ()
 
void pushEvent (HandlerEvent const &event)
 Ajoute un évènement de gestionnaire à la file.
 
void connect (HandlerEventType event, ClientHandlerFunction function)
 Connecte un fonction à un évènement gestionnaire.
 
- Fonctions membres publiques hérités de castor3d::ScrollableCtrl
virtual C3D_API ~ScrollableCtrl () noexcept
 
C3D_API castor::Position getScrollPosition () const
 
ScrollableStyle & getStyle () const noexcept
 

Attributs publics statiques

static C3D_API ControlType constexpr Type { ControlType::ePanel }
 

Membres hérités additionnels

- Types publics hérités de castor3d::NonClientEventHandler< Control >
using DerivedPtr = Control *
 
using ClientMouseFunction = EventHandler::ClientMouseFunction
 
using ClientKeyboardFunction = EventHandler::ClientKeyboardFunction
 
using ClientHandlerFunction = EventHandler::ClientHandlerFunction
 
using NonClientMouseFunction = std::function< void(DerivedPtr, MouseEvent const &) >
 
using NonClientKeyboardFunction = std::function< void(DerivedPtr, KeyboardEvent const &) >
 
using NonClientHandlerFunction = std::function< void(DerivedPtr, HandlerEvent const &) >
 
using OnNonClientMouseEvent = castor::SignalT< NonClientMouseFunction >
 
using OnNonClientKeyboardEvent = castor::SignalT< NonClientKeyboardFunction >
 
using OnNonClientHandlerEvent = castor::SignalT< NonClientHandlerFunction >
 
using OnNonClientMouseEventConnection = typename OnNonClientMouseEvent::connection
 
using OnNonClientKeyboardEventConnection = typename OnNonClientKeyboardEvent::connection
 
using OnNonClientHandlerEventConnection = typename OnNonClientHandlerEvent::connection
 
- Types publics hérités de castor3d::EventHandler
using ClientMouseFunction = std::function< void(MouseEvent const &) >
 
using ClientKeyboardFunction = std::function< void(KeyboardEvent const &) >
 
using ClientHandlerFunction = std::function< void(HandlerEvent const &) >
 
using EnableFunction = std::function< void(bool) >
 
using OnClientMouseEvent = castor::SignalT< ClientMouseFunction >
 
using OnClientKeyboardEvent = castor::SignalT< ClientKeyboardFunction >
 
using OnClientHandlerEvent = castor::SignalT< ClientHandlerFunction >
 
using OnEnable = castor::SignalT< EnableFunction >
 
using OnClientMouseEventConnection = OnClientMouseEvent::connection
 
using OnClientKeyboardEventConnection = OnClientKeyboardEvent::connection
 
using OnClientHandlerEventConnection = OnClientHandlerEvent::connection
 
using OnEnableConnection = OnEnable::connection
 
- Attributs publics hérités de castor3d::Control
OnControlChanged onChanged
 
- Attributs publics hérités de castor3d::EventHandler
OnEnable onEnable
 
- Types protégés hérités de castor3d::NonClientEventHandler< Control >
using EventHandlerFunction = EventHandler::EventHandlerFunction
 
using EventQueue = EventHandler::EventQueue
 
- Types protégés hérités de castor3d::EventHandler
using EventHandlerFunction = std::function< void() >
 
using EventQueue = std::deque< std::pair< UserInputEventSPtr, EventHandlerFunction > >
 
- Types protégés hérités de castor3d::ScrollableCtrl
using OnScrollContentFunction = std::function< void(castor::Position const &) >
 
using OnScrollContent = castor::SignalT< OnScrollContentFunction >
 
using OnScrollContentConnection = OnScrollContent::connection
 
- Fonctions membres protégées hérités de castor3d::Control
C3D_API Overlay & getBackgroundOverlay ()
 
C3D_API void setBackgroundMaterial (MaterialObs value)
 
C3D_API void setBackgroundSize (castor::Size const &value)
 
C3D_API void setBackgroundBorderPosition (BorderPosition value)
 
C3D_API void setBackgroundBorderMaterial (MaterialObs value)
 
C3D_API void create (ControlsManager &ctrlManager)
 
C3D_API void destroy ()
 
C3D_API void addChild (ControlRPtr control)
 
C3D_API void removeChild (ControlRPtr control)
 
ControlStyle & getBaseStyle ()
 
- Fonctions membres protégées hérités de castor3d::EventHandler
void processMouseEvent (MouseEventSPtr event)
 Fonction de traitement d'un évènement souris.
 
void processKeyboardEvent (KeyboardEventSPtr event)
 Fonction de traitement d'un évènement clavier.
 
void processHandlerEvent (HandlerEventSPtr event)
 Fonction de traitement d'un évènement de gestionnaire.
 
- Fonctions membres protégées hérités de castor3d::ScrollableCtrl
C3D_API ScrollableCtrl (Control &target, ScrollableStyleRPtr style)
 
C3D_API void createScrollBars ()
 
C3D_API void destroyScrollBars ()
 
C3D_API void updateScrollBarsStyle ()
 
C3D_API void checkScrollBarFlags ()
 
C3D_API void updateScrollBars ()
 
C3D_API castor::Point4ui updateScrollableClientRect (castor::Point4ui const &clientRect)
 
C3D_API void updateScrollBarsThumb (castor::Position const &pos)
 
C3D_API void setScrollBarsVisible (bool visible)
 
C3D_API void registerControl (Control &control)
 
C3D_API void unregisterControl (Control &control)
 
C3D_API void updateTotalSize (castor::Size const &size)
 
C3D_API void updateScrollZIndex (uint32_t &index)
 
C3D_API void adjustScrollZIndex (uint32_t offset)
 
bool hasVerticalScrollBar () const noexcept
 
bool hasHorizontalScrollBar () const noexcept
 
- Attributs protégés hérités de castor3d::Control
SceneRPtr m_scene {}
 
ControlRPtr m_parent {}
 The parent control, if any.
 
MaterialObs m_backgroundMaterial {}
 The background material.
 
MaterialObs m_foregroundMaterial {}
 The foreground material.
 
ControlFlagType m_flags {}
 The control flgas.
 
- Attributs protégés hérités de castor3d::NonClientEventHandler< Control >
std::array< OnNonClientMouseEvent, size_t(MouseEventType::eCount) > m_ncMouseSlots
 
std::array< std::vector< OnNonClientMouseEventConnection >, size_t(MouseEventType::eCount) > m_ncMouseSlotsConnections
 
std::array< OnNonClientKeyboardEvent, size_t(KeyboardEventType::eCount) > m_ncKeyboardSlots
 
std::array< std::vector< OnNonClientKeyboardEventConnection >, size_t(KeyboardEventType::eCount) > m_ncKeyboardSlotsConnections
 
std::array< OnNonClientHandlerEvent, size_t(HandlerEventType::eCount) > m_ncHandlerSlots
 
std::array< std::vector< OnNonClientHandlerEventConnection >, size_t(HandlerEventType::eCount) > m_ncHandlerSlotsConnections
 
- Attributs protégés hérités de castor3d::EventHandler
std::array< OnClientMouseEvent, size_t(MouseEventType::eCount) > m_mouseSlots
 
std::array< std::vector< OnClientMouseEventConnection >, size_t(MouseEventType::eCount) > m_mouseSlotsConnections
 
std::array< OnClientKeyboardEvent, size_t(KeyboardEventType::eCount) > m_keyboardSlots
 
std::array< std::vector< OnClientKeyboardEventConnection >, size_t(KeyboardEventType::eCount) > m_keyboardSlotsConnections
 
std::array< OnClientHandlerEvent, size_t(HandlerEventType::eCount) > m_handlerSlots
 
std::array< std::vector< OnClientHandlerEventConnection >, size_t(HandlerEventType::eCount) > m_handlerSlotsConnections
 
- Attributs protégés hérités de castor3d::ScrollableCtrl
OnScrollContent onScrollContent
 

Documentation des constructeurs et destructeur

◆ PanelCtrl() [1/2]

C3D_API castor3d::PanelCtrl::PanelCtrl ( SceneRPtr  scene,
castor::String const &  name,
PanelStyle *  style,
ControlRPtr  parent 
)

Constructor

Paramètres
[in]sceneThe parent scene (nullptr for global).
[in]nameThe control name
[in]styleThe control style
[in]parentThe parent control, if any

◆ PanelCtrl() [2/2]

C3D_API castor3d::PanelCtrl::PanelCtrl ( SceneRPtr  scene,
castor::String const &  name,
PanelStyle *  style,
ControlRPtr  parent,
castor::Position const &  position,
castor::Size const &  size,
ControlFlagType  flags = 0,
bool  visible = true 
)

Constructor

Paramètres
[in]sceneThe parent scene (nullptr for global).
[in]nameThe control name
[in]styleThe control style
[in]parentThe parent control, if any
[in]positionThe control position
[in]sizeThe control size
[in]flagsThe configuration flags
[in]visibleInitial visibility status

Documentation des fonctions membres

◆ getStyle() [1/2]

PanelStyle & castor3d::PanelCtrl::getStyle ( )
inline

Références castor3d::Control::getBaseStyle().

Voici le graphe d'appel pour cette fonction :

◆ getStyle() [2/2]

PanelStyle const & castor3d::PanelCtrl::getStyle ( ) const
inline
Renvoie
The panel style.

Références castor3d::Control::getBaseStyle().

Voici le graphe d'appel pour cette fonction :

Documentation des données membres

◆ Type

C3D_API ControlType constexpr castor3d::PanelCtrl::Type { ControlType::ePanel }
staticconstexpr
La documentation de cette classe a été générée à partir du fichier suivant :
Généré le Vendredi 28 Avril 2023 14:43:11 pour Castor3D par doxygen 1.9.6