MT Showcase SDK
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Showcase::FloatingItem Class Referenceabstract

This is an interface for floating items. More...

#include <FloatingItem.hpp>

Inherits Widget.

Public Member Functions

virtual float openCollisionRadius () const =0
 Collision radius when item is open, regardless of current state.
 
virtual void open ()=0
 Opens the item. More...
 
virtual void close ()=0
 Closes the item. More...
 
virtual void setParentNodeCenterLocation (const Nimble::Vector2 &loc)=0
 Set the location of this item's parent item. More...
 
virtual bool active () const =0
 Set item active state. More...
 
virtual float order () const =0
 Get the order of this menu item, this can be used to sort the items in a menu. More...
 
virtual void setOrder (float order)=0
 Set the order for this menu item. More...
 

Detailed Description

This is an interface for floating items.

In old experience the single menu bubble would correspond to this interface

Member Function Documentation

virtual bool Showcase::FloatingItem::active ( ) const
pure virtual

Set item active state.

Inactive item can be moved or animated to grab the user's attention

virtual void Showcase::FloatingItem::close ( )
pure virtual

Closes the item.

This should be called after the item is ready to be removed. For example this may launch the initial opening animation of floating item

virtual void Showcase::FloatingItem::open ( )
pure virtual

Opens the item.

This needs to be called before the item is ready for use. For example this may launch the initial opening animation of floating item

virtual float Showcase::FloatingItem::order ( ) const
pure virtual

Get the order of this menu item, this can be used to sort the items in a menu.

Returns
numeric order value
virtual void Showcase::FloatingItem::setOrder ( float  order)
pure virtual

Set the order for this menu item.

Parameters
ordernumeric order value
virtual void Showcase::FloatingItem::setParentNodeCenterLocation ( const Nimble::Vector2 &  loc)
pure virtual

Set the location of this item's parent item.

Parameters
loclocation in this widget's parent's coordinates