UrSceneView Class Reference

The class responsible for managing the 3D representation and interactions of a game in progress. More...

#include <ur_scene_view.hpp>

Inheritance diagram for UrSceneView:

Public Member Functions
std::shared_ptr< BaseSimObjectAspect >	clone () const override
const GameOfUrModel &	getModel () const
const BoardLocations &	getBoard () const

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

Public Attributes
ToyMaker::SignalObserver< glm::u8vec2 >	mObserveBoardClicked
ToyMaker::SignalObserver< glm::u8vec2 >	mObserveBoardHovered
ToyMaker::SignalObserver< PieceTypeID >	mObserveLaunchPieceInitiated
ToyMaker::SignalObserver< PieceTypeID >	mObserveLaunchPieceHovered
ToyMaker::SignalObserver	mObserveLaunchPieceCancelled
ToyMaker::SignalObserver< MoveResultData >	mObserveMoveMade
ToyMaker::SignalObserver< PlayerID >	mObserveControlInterface
ToyMaker::Signal< PieceTypeID, glm::u8vec2 >	mSigLaunchPieceAttempted
ToyMaker::Signal< PieceIdentity >	mSigMovePieceAttempted
ToyMaker::SignalObserver	mObserveControllerReady
ToyMaker::Signal< std::string >	mSigViewSubscribed {*this, "ViewSubscribed"}
ToyMaker::SignalObserver	mObserveViewUpdateStarted
ToyMaker::Signal< std::string >	mSigViewUpdateCompleted

Private Types
enum class	Mode { GENERAL , LAUNCH_POSITION_SELECTION , TRANSITION }

Private Member Functions
void	onControllerReady ()
void	onBoardClicked (glm::u8vec2 boardLocation)
void	onBoardHovered (glm::u8vec2 boardLocation)
void	onLaunchPieceInitiated (PieceTypeID piece)
void	onLaunchPieceHovered (PieceTypeID piece)
void	onLaunchPieceCanceled ()
void	onMoveMade (const MoveResultData &moveResultData)
void	onViewUpdateStarted ()
void	onControlInterface (PlayerID player)
void	onActivated () override
void	variableUpdate (uint32_t variableStepMillis) override
void	addLight (glm::u8vec2 boardPosition, const ToyMaker::LightEmissionData &light)
void	addLights (const std::vector< glm::u8vec2 > &boardPositions)
void	clearLights ()

Private Attributes
std::map< PieceIdentity, std::string >	mPieceModelMap {}
std::map< PieceIdentity, std::shared_ptr< ToyMaker::SceneNode > >	mPieceNodeMap {}
std::weak_ptr< ToyMaker::SimObject >	mGameOfUrController {}
std::weak_ptr< ToyMaker::SimObject >	mGameOfUrBoard {}
std::priority_queue< UrPieceAnimationKey >	mAnimationKeys {}
uint32_t	mAnimationTimeMillis {}
std::string	mControllerPath {}
Mode	mMode { Mode::GENERAL }
PlayerID	mControlledBy {}
glm::u8vec2	mFocusedGridCell {}

Static Private Attributes
static const glm::u8vec2	kGridUnfocused { 255, 255 }

Detailed Description

The class responsible for managing the 3D representation and interactions of a game in progress.

Displays the game board and adds game pieces to it per the current state of the game. The state of the game is read from the game data model (or from changes broadcasted by UrController).

Converts board or game piece clicks into actions usable by the currently active player controller. Also reports view updates (like animations that play after a game state change) to the game controller.

Member Data Documentation

mObserveBoardClicked

ToyMaker::SignalObserver<glm::u8vec2> UrSceneView::mObserveBoardClicked

Initial value:

{ 
        *this, "BoardClickedObserved",
        [this](glm::u8vec2 boardLocation) { this->onBoardClicked(boardLocation); }
    }

mObserveBoardHovered

ToyMaker::SignalObserver<glm::u8vec2> UrSceneView::mObserveBoardHovered

Initial value:

{
        *this, "BoardHoveredObserved",
        [this](glm::u8vec2 boardLocation) { this->onBoardHovered(boardLocation); }
    }

mObserveControlInterface

ToyMaker::SignalObserver<PlayerID> UrSceneView::mObserveControlInterface

Initial value:

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

mObserveControllerReady

ToyMaker::SignalObserver UrSceneView::mObserveControllerReady

Initial value:

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

mObserveLaunchPieceCancelled

ToyMaker::SignalObserver UrSceneView::mObserveLaunchPieceCancelled

Initial value:

{
        *this, "LaunchPieceCanceledObserved",
        [this]() { this->onLaunchPieceCanceled(); }
    }

mObserveLaunchPieceHovered

ToyMaker::SignalObserver<PieceTypeID> UrSceneView::mObserveLaunchPieceHovered

Initial value:

{
        *this, "LaunchPieceHoveredObserved",
        [this](PieceTypeID pieceType) { this->onLaunchPieceHovered(pieceType); }
    }

mObserveLaunchPieceInitiated

ToyMaker::SignalObserver<PieceTypeID> UrSceneView::mObserveLaunchPieceInitiated

Initial value:

{
        *this, "LaunchPieceInitiatedObserved",
        [this](PieceTypeID pieceType) { this->onLaunchPieceInitiated(pieceType); }
    }

mObserveMoveMade

ToyMaker::SignalObserver<MoveResultData> UrSceneView::mObserveMoveMade

Initial value:

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

mObserveViewUpdateStarted

ToyMaker::SignalObserver UrSceneView::mObserveViewUpdateStarted

Initial value:

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

mSigLaunchPieceAttempted

ToyMaker::Signal<PieceTypeID, glm::u8vec2> UrSceneView::mSigLaunchPieceAttempted

Initial value:

{
        *this, "LaunchPieceAttempted"
    }

mSigMovePieceAttempted

ToyMaker::Signal<PieceIdentity> UrSceneView::mSigMovePieceAttempted

Initial value:

{
        *this, "MovePieceAttempted"
    }

mSigViewUpdateCompleted

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

Initial value:

{
        *this, "ViewUpdateCompleted"
    }

---

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

• src/app/ur_scene_view.hpp
• src/app/ur_scene_view.cpp