R-Type
Public Member Functions | List of all members
GameEngine::View Class Reference

Class representing a view wrapper for sf::View. More...

#include <SfmlTypes.hpp>

Inheritance diagram for GameEngine::View:
GameEngine::IView< sf::View >

Public Member Functions

 View ()=default
 default constructor More...
 
 View (const Rect< float > &rect)
 Constructor for View. More...
 
 ~View ()=default
 Destructor for View. More...
 
const sf::View & getBaseView () const override
 Returns the wrapped sf::View. More...
 
void setCenter (const Vector2< float > &center) override
 set center of the view More...
 
Vector2< float > getCenter () const override
 get the center of the view More...
 
void setViewPort (const Vector2< float > &startingPoint, float width, float height) override
 set a viewport rectangle More...
 
- Public Member Functions inherited from GameEngine::IView< sf::View >
 ~IView ()=default
 Destructor. More...
 

Detailed Description

Class representing a view wrapper for sf::View.

Constructor & Destructor Documentation

◆ View() [1/2]

GameEngine::View::View ( )
default

default constructor

◆ View() [2/2]

GameEngine::View::View ( const Rect< float > &  rect)
inline

Constructor for View.

Parameters
rectThe rectangle defining the initial position and size of the view

◆ ~View()

GameEngine::View::~View ( )
default

Destructor for View.

Member Function Documentation

◆ getBaseView()

const sf::View& GameEngine::View::getBaseView ( ) const
inlineoverridevirtual

Returns the wrapped sf::View.

Returns
Reference to the sf::View instance

Implements GameEngine::IView< sf::View >.

◆ getCenter()

Vector2<float> GameEngine::View::getCenter ( ) const
inlineoverridevirtual

get the center of the view

Returns
the center of the view

Implements GameEngine::IView< sf::View >.

◆ setCenter()

void GameEngine::View::setCenter ( const Vector2< float > &  center)
inlineoverridevirtual

set center of the view

Parameters
centerpoint to center the view

Implements GameEngine::IView< sf::View >.

◆ setViewPort()

void GameEngine::View::setViewPort ( const Vector2< float > &  startingPoint,
float  width,
float  height 
)
inlineoverridevirtual

set a viewport rectangle

Parameters
startingPointthe point at the up left corner of the viewport rectangle
widththe width of the viewport
heightthe height of the viewport

Implements GameEngine::IView< sf::View >.


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