UrUIView Class Reference

The aspect class for the UI layer of the game scene. More...

#include <ur_ui_view.hpp>

Inheritance diagram for UrUIView:

Public Member Functions
std::shared_ptr< BaseSimObjectAspect >	clone () const override
void	onActivated () override
void	variableUpdate (uint32_t timeStep) override
const GameOfUrModel &	getModel () const

Static Public Member Functions
static std::string	getSimObjectAspectTypeName ()
static std::shared_ptr< BaseSimObjectAspect >	create (const nlohmann::json &jsonAspectProperties)

Public Attributes
ToyMaker::SignalObserver< const std::string & >	mObserveButtonClicked
ToyMaker::SignalObserver< GamePhaseData >	mObservePhaseUpdated
ToyMaker::SignalObserver< GameScoreData >	mObserveScoreUpdated
ToyMaker::SignalObserver< PlayerData >	mObservePlayerUpdated
ToyMaker::SignalObserver< DiceData >	mObserveDiceUpdated
ToyMaker::SignalObserver< MoveResultData >	mObserveMoveMade
ToyMaker::SignalObserver< PlayerID >	mObserveControlInterface
ToyMaker::Signal	mSigDiceRollAttempted { *this, "DiceRollAttempted" }
ToyMaker::Signal	mSigNextTurnAttempted { *this, "NextTurnAttempted" }
ToyMaker::Signal< PieceTypeID >	mSigLaunchPieceInitiated { *this, "LaunchPieceInitiated" }
ToyMaker::Signal	mSigLaunchPieceCanceled { *this, "LaunchPieceCanceled" }
ToyMaker::SignalObserver	mObserveControllerReady
ToyMaker::Signal< std::string >	mSigViewSubscribed {*this, "ViewSubscribed"}
ToyMaker::SignalObserver	mObserveViewUpdateStarted
ToyMaker::Signal< std::string >	mSigViewUpdateCompleted

Private Types
enum	Buttons {   SWALLOW =PieceTypeID::SWALLOW , STORMBIRD =PieceTypeID::STORMBIRD , RAVEN =PieceTypeID::RAVEN , ROOSTER =PieceTypeID::ROOSTER ,   EAGLE =PieceTypeID::EAGLE , NEXT_TURN , DICE }
enum class	Mode { INTERACT , TRANSITION }

Private Member Functions
void	onControllerReady ()
void	updateText (const std::string &path, const std::string &text)
void	reactivateControls ()
void	onButtonClicked (const std::string &button)
void	onPhaseUpdated (GamePhaseData phase)
void	onScoreUpdated (GameScoreData score)
void	onPlayerUpdated (PlayerData player)
void	onDiceUpdated (DiceData dice)
void	onViewUpdateStarted ()
void	onMoveMade (MoveResultData moveData)
void	onControlInterface (PlayerID playerID)
bool	onCancel (const ToyMaker::ActionData &actionData, const ToyMaker::ActionDefinition &actionDefinition)
std::shared_ptr< ToyMaker::SimObject >	getLaunchButton (PieceTypeID pieceTypeID, PlayerID player)
std::shared_ptr< ToyMaker::SceneNode >	getPlayerPanel (PlayerID player)
std::shared_ptr< ToyMaker::SimObject >	getEndTurnButton ()

Private Attributes
std::weak_ptr< ToyMaker::SimObject >	mGameOfUrController {}
std::string	mControllerPath {}
PlayerID	mControlledBy {}
Mode	mMode { Mode::INTERACT }
std::vector< std::reference_wrapper< ToyMaker::UIText > >	mUpdatedTextElements {}
uint32_t	mAnimationTimeMillis { 0 }
uint32_t	mBlinkLengthMillis { 2500 }
uint32_t	mBlinkPeriodMillis { 400 }
std::weak_ptr< ToyMaker::FixedActionBinding >	handleCancel

Static Private Attributes
static const std::map< std::string, Buttons >	kButtonEnumMap

Detailed Description

The aspect class for the UI layer of the game scene.

Converts UI interactions into game actions sent to the active player controller. Partially displays information about the current state of the game, as reported by the game data model or UrController.

Member Data Documentation

handleCancel

std::weak_ptr<ToyMaker::FixedActionBinding> UrUIView::handleCancel

private

Initial value:

{ declareFixedActionBinding(
        "General", "Cancel", [this](const ToyMaker::ActionData& actionData, const ToyMaker::ActionDefinition& actionDefinition) {
            return this->onCancel(actionData, actionDefinition);
        }
    )}

kButtonEnumMap

const std::map< std::string, UrUIView::Buttons > UrUIView::kButtonEnumMap

staticprivate

Initial value:

{
    {"swallow", UrUIView::Buttons::SWALLOW},
    {"storm_bird", UrUIView::Buttons::STORMBIRD},
    {"raven", UrUIView::Buttons::RAVEN},
    {"rooster", UrUIView::Buttons::ROOSTER},
    {"eagle", UrUIView::Buttons::EAGLE},
 
    {"dice_roll", UrUIView::Buttons::DICE},
    {"next_turn", UrUIView::Buttons::NEXT_TURN},
}

mObserveButtonClicked

ToyMaker::SignalObserver<const std::string&> UrUIView::mObserveButtonClicked

Initial value:

{
        *this, "ButtonClickedObserved",
        [this](const std::string& button) { this->onButtonClicked(button); }
    }

mObserveControlInterface

ToyMaker::SignalObserver<PlayerID> UrUIView::mObserveControlInterface

Initial value:

{
        *this, "ControlInterfaceObserved",
        [this](PlayerID playerID) { this->onControlInterface(playerID); }
    }

mObserveControllerReady

ToyMaker::SignalObserver UrUIView::mObserveControllerReady

Initial value:

{ 
        *this, "ControllerReadyObserved",
        [this]() {this->onControllerReady();}
    }

mObserveDiceUpdated

ToyMaker::SignalObserver<DiceData> UrUIView::mObserveDiceUpdated

Initial value:

{
        *this, "DiceUpdatedObserved",
        [this](DiceData diceData) { this->onDiceUpdated(diceData); }
    }

mObserveMoveMade

ToyMaker::SignalObserver<MoveResultData> UrUIView::mObserveMoveMade

Initial value:

{
        *this, "MoveMadeObserved",
        [this](MoveResultData moveData) { this->onMoveMade(moveData); }
    }

mObservePhaseUpdated

ToyMaker::SignalObserver<GamePhaseData> UrUIView::mObservePhaseUpdated

Initial value:

{
        *this, "PhaseUpdatedObserved",
        [this](GamePhaseData phaseData) { this->onPhaseUpdated(phaseData); }
    }

mObservePlayerUpdated

ToyMaker::SignalObserver<PlayerData> UrUIView::mObservePlayerUpdated

Initial value:

{
        *this, "PlayerUpdatedObserved",
        [this](PlayerData playerData) { this->onPlayerUpdated(playerData); }
    }

mObserveScoreUpdated

ToyMaker::SignalObserver<GameScoreData> UrUIView::mObserveScoreUpdated

Initial value:

{
        *this, "ScoreUpdatedObserved",
        [this](GameScoreData scoreData) { this->onScoreUpdated(scoreData); }
    }

mObserveViewUpdateStarted

ToyMaker::SignalObserver UrUIView::mObserveViewUpdateStarted

Initial value:

{ 
        *this, "ViewUpdateStartedObserved",
        [this](){ this->onViewUpdateStarted(); }
    }

mSigViewUpdateCompleted

ToyMaker::Signal<std::string> UrUIView::mSigViewUpdateCompleted

Initial value:

{
        *this, "ViewUpdateCompleted"
    }

---

The documentation for this class was generated from the following files:

• src/app/ur_ui_view.hpp
• src/app/ur_ui_view.cpp