Scrollable

Header

Includes/Chicane/Grid/Component/Scrollable.hpp

Namespace

Chicane::Grid::Scrollable

Constructors

Name	Description
Scrollable( const XmlNode& inNode )
Scrollable( const String& inTag )

Destructors

Name	Description
~Scrollable()

Override Functions

Access	Return	Modifier	Name
public	void		tick( float inDelta )
public	bool		onEvent( const WindowEvent& inEvent )
public	Vec2	const	getScrollOffset()
public	Vec2	const	getScrollBarGutter()

Functions

Access	Return	Modifier	Name
public	bool	const	isScrollPinned( const Component* inChild )
public	const Vec2&	const	getScroll()
public	Vec2	const	getScrollMax()
public	void		addScroll( const Vec2& inValue )
public	void		addScroll( float inX, float inY )
public	void		setScroll( const Vec2& inValue )
public	void		setScroll( float inX, float inY )
public	void		setVirtualContentSize( const Vec2& inValue )
public	void		clearVirtualContentSize()
public	bool	const	isClippingOverflow()
public	bool	const	canScroll()
public	bool	const	canScrollX()
public	bool	const	canScrollY()
public	bool	const	hasScrollBar()
public	bool	const	isDragging()
protected	void		refreshPeripherals()
protected	void		setPinnedPeripherals( const std::vector<Component*>& inPeripherals )
protected	void		setPeripherals( const std::vector<Component*>& inPeripherals )
protected	bool	const	hitScrollBar( const Vec2& inLocation )
protected	void		beginScrollBarDrag( const Vec2& inLocation )
protected	void		updateScrollBarDrag( const Vec2& inLocation )
protected	void		endScrollBarDrag()
protected	Bounds2D	const	getScrollBarXTrack()
protected	Bounds2D	const	getScrollBarXThumb()
protected	Bounds2D	const	getScrollBarYTrack()
protected	Bounds2D	const	getScrollBarYThumb()
protected	bool		handleWheel( const Vec2& inDelta )
protected	void		clampScroll()
protected	float	const	scrollBarThickness()
protected	float	const	scrollBarMargin()
protected	void		refreshScrollBarReservation()
protected	void		refreshScrollBars()
protected	void		ensureScrollBarParts( ScrollBarProperties& inBar )
protected	void		syncScrollBarPart( ScrollBar* inPart, const Bounds2D& inBox, const Color::Rgba& inColor, float inDepthBias )

Members

Access	Type	Name
protected	Vec2	m_currentPosition
protected	Vec2	m_virtualContentSize
protected	bool	m_bHasVirtualContent
protected	bool	m_bReserveHorizontalBar
protected	bool	m_bReserveVerticalBar
protected	ScrollBarProperties	m_horizontalBar
protected	ScrollBarProperties	m_verticalBar
protected	std::vector<Component*>	m_pinnedPeripherals