Référence de la classe castor3d::Viewport

Classe de représentation de viewport. Plus de détails...

Graphe d'héritage de castor3d::Viewport:

Graphe de collaboration de castor3d::Viewport:

Classes
class	TextWriter
	Loader de Viewport. Plus de détails...

Fonctions membres publiques
C3D_API	Viewport (Engine &engine)
	Constructeur. Plus de détails...
C3D_API	Viewport (Viewport const &rhs)
	Constructeur par copie. Plus de détails...
C3D_API Viewport &	operator= (Viewport const &rhs)
	Opérateur d'affectation par copie. Plus de détails...
C3D_API	Viewport (Viewport &&rhs)=default
	Constructeur par déplacement. Plus de détails...
C3D_API Viewport &	operator= (Viewport &&rhs)=default
	Opérateur d'affectation par déplacement. Plus de détails...
C3D_API	~Viewport ()
	Destructeur. Plus de détails...
C3D_API bool	initialise ()
	Crée l'implémentation spécifique à l'API de rendu. Plus de détails...
C3D_API void	cleanup ()
	Détruit l'implémentation spécifique à l'API de rendu. Plus de détails...
C3D_API bool	update ()
	Rend le viewport. Plus de détails...
C3D_API void	apply () const
	Applique le viewport. Plus de détails...
C3D_API void	setPerspective (castor::Angle const &fovy, real aspect, real near, real far)
	Construit vioewport en perspective centrée. Plus de détails...
C3D_API void	setFrustum (real left, real right, real bottom, real top, real near, real far)
	Construit une matrice de projection en perspective non centrée. Plus de détails...
C3D_API void	setOrtho (real left, real right, real bottom, real top, real near, real far)
	Construit une matrice de projection orthographique. Plus de détails...
const castor::Size &	getSize () const
const castor::Position &	getPosition () const
ViewportType	getType () const
real	getRatio () const
real	getNear () const
real	getFar () const
castor::Angle	getFovY () const
real	getLeft () const
real	getRight () const
real	getTop () const
real	getBottom () const
uint32_t	getWidth () const
uint32_t	getHeight () const
bool	isModified () const
castor::Matrix4x4r const &	getProjection () const
void	setPosition (const castor::Position &value)
	Définit la position de rendu du viewport. Plus de détails...
void	resize (const castor::Size &value)
	Définit les dimensions de rendu du viewport. Plus de détails...
void	updateType (ViewportType value)
	Récupère le type de projection du viewport. Plus de détails...
void	updateRatio (real value)
	Récupère le ratio d'aspect. Plus de détails...
void	updateNear (real value)
	Récupère la position du plan proche. Plus de détails...
void	updateFar (real value)
	Récupère la position du plan lointain. Plus de détails...
void	updateFovY (castor::Angle const &value)
	Récupère l'angle de vue vertical. Plus de détails...
void	updateLeft (real value)
	Récupère la position du plan gauche. Plus de détails...
void	updateRight (real value)
	Récupère la position du plan droit. Plus de détails...
void	updateTop (real value)
	Récupère la position du plan haut. Plus de détails...
void	updateBottom (real value)
	Récupère la position du plan bas. Plus de détails...

Attributs publics statiques
static C3D_API const std::array< castor::String, size_t(ViewportType::eCount) >	string_type

Description détaillée

Classe de représentation de viewport.

Auteur

Sylvain DOREMUS

Version

0.1

Date

09/02/2010

Remarques

donne le type de projection FOV, ...

Documentation des constructeurs et destructeur

Viewport() [1/3]

C3D_API castor3d::Viewport::Viewport ( Engine &  engine )

explicit

Constructeur.

Paramètres

[in]

engine

Le moteur.

Viewport() [2/3]

C3D_API castor3d::Viewport::Viewport

(

Viewport const &

rhs

)

Constructeur par copie.

Paramètres

[in]

rhs

L'objet à copier.

Viewport() [3/3]

C3D_API castor3d::Viewport::Viewport ( Viewport &&  rhs )

default

Constructeur par déplacement.

Paramètres

[in]

rhs

L'objet à déplacer.

~Viewport()

C3D_API castor3d::Viewport::~Viewport

(

)

Destructeur.

Documentation des fonctions membres

apply()

C3D_API void castor3d::Viewport::apply

(

)

const

Applique le viewport.

cleanup()

C3D_API void castor3d::Viewport::cleanup

(

)

Détruit l'implémentation spécifique à l'API de rendu.

getBottom()

real castor3d::Viewport::getBottom ( ) const

inline

Renvoie

La position du plan bas

getFar()

real castor3d::Viewport::getFar ( ) const

inline

Renvoie

La position du plan lointain

getFovY()

castor::Angle castor3d::Viewport::getFovY ( ) const

inline

Renvoie

L'angle de vue vertical

getHeight()

uint32_t castor3d::Viewport::getHeight ( ) const

inline

Renvoie

La hauteur du viewport

getLeft()

real castor3d::Viewport::getLeft ( ) const

inline

Renvoie

La position du plan gauche

getNear()

real castor3d::Viewport::getNear ( ) const

inline

Renvoie

La position du plan proche

getPosition()

const castor::Position& castor3d::Viewport::getPosition ( ) const

inline

Renvoie

La position de rendu du viewport.

getProjection()

castor::Matrix4x4r const& castor3d::Viewport::getProjection ( ) const

inline

Renvoie

La matrice de projection

getRatio()

real castor3d::Viewport::getRatio ( ) const

inline

Renvoie

Le ratio d'aspect

getRight()

real castor3d::Viewport::getRight ( ) const

inline

Renvoie

La position du plan droit

getSize()

const castor::Size& castor3d::Viewport::getSize ( ) const

inline

Renvoie

Les dimensions de rendu du viewport

getTop()

real castor3d::Viewport::getTop ( ) const

inline

Renvoie

La position du plan haut

getType()

ViewportType castor3d::Viewport::getType ( ) const

inline

Renvoie

Le type de projection du viewport

getWidth()

uint32_t castor3d::Viewport::getWidth ( ) const

inline

Renvoie

La largeur du viewport

initialise()

C3D_API bool castor3d::Viewport::initialise

(

)

Crée l'implémentation spécifique à l'API de rendu.

Renvoie

true si tout s'est bien passé.

isModified()

bool castor3d::Viewport::isModified ( ) const

inline

Renvoie

Le statut de modification du viewport

operator=() [1/2]

C3D_API Viewport& castor3d::Viewport::operator=

(

Viewport const &

rhs

)

Opérateur d'affectation par copie.

Paramètres

[in]

rhs

L'objet à copier.

operator=() [2/2]

C3D_API Viewport& castor3d::Viewport::operator= ( Viewport &&  rhs )

default

Opérateur d'affectation par déplacement.

Paramètres

[in]

rhs

L'objet à déplacer.

resize()

void castor3d::Viewport::resize ( const castor::Size &  value )

inline

Définit les dimensions de rendu du viewport.

Paramètres

[in]

value

La nouvelle valeur

setFrustum()

C3D_API void castor3d::Viewport::setFrustum	(	real	left,
		real	right,
		real	bottom,
		real	top,
		real	near,
		real	far
	)

Construit une matrice de projection en perspective non centrée.

Paramètres

[in]	left	Position du plan gauche.
[in]	right	Position du plan droit.
[in]	bottom	Position du plan bas.
[in]	top	Position du plan haut.
[in]	near	Position du plan proche.
[in]	far	Position du plan éloigné.

setOrtho()

C3D_API void castor3d::Viewport::setOrtho	(	real	left,
		real	right,
		real	bottom,
		real	top,
		real	near,
		real	far
	)

Construit une matrice de projection orthographique.

Paramètres

[in]	left	Position du plan gauche.
[in]	right	Position du plan droit.
[in]	bottom	Position du plan bas.
[in]	top	Position du plan haut.
[in]	near	Position du plan proche.
[in]	far	Position du plan éloigné.

setPerspective()

C3D_API void castor3d::Viewport::setPerspective	(	castor::Angle const &	fovy,
		real	aspect,
		real	near,
		real	far
	)

Construit vioewport en perspective centrée.

Paramètres

[in]	fovy	Angle de vision Y.
[in]	aspect	Ratio Largeur / Hauteur.
[in]	near	Position du plan proche.
[in]	far	Position du plan éloigné.

setPosition()

void castor3d::Viewport::setPosition ( const castor::Position &  value )

inline

Définit la position de rendu du viewport.

Paramètres

[in]

value

La nouvelle valeur

update()

C3D_API bool castor3d::Viewport::update

(

)

Rend le viewport.

Remarques

Applique la perspective

Renvoie

true si le frustum de vue a été modifié

updateBottom()

void castor3d::Viewport::updateBottom ( real  value )

inline

Récupère la position du plan bas.

Renvoie

La valeur

updateFar()

void castor3d::Viewport::updateFar ( real  value )

inline

Récupère la position du plan lointain.

Renvoie

La valeur

updateFovY()

void castor3d::Viewport::updateFovY ( castor::Angle const &  value )

inline

Récupère l'angle de vue vertical.

Renvoie

La valeur

updateLeft()

void castor3d::Viewport::updateLeft ( real  value )

inline

Récupère la position du plan gauche.

Renvoie

La valeur

updateNear()

void castor3d::Viewport::updateNear ( real  value )

inline

Récupère la position du plan proche.

Renvoie

La valeur

updateRatio()

void castor3d::Viewport::updateRatio ( real  value )

inline

Récupère le ratio d'aspect.

Renvoie

La valeur

updateRight()

void castor3d::Viewport::updateRight ( real  value )

inline

Récupère la position du plan droit.

Renvoie

La valeur

updateTop()

void castor3d::Viewport::updateTop ( real  value )

inline

Récupère la position du plan haut.

Renvoie

La valeur

updateType()

void castor3d::Viewport::updateType ( ViewportType  value )

inline

Récupère le type de projection du viewport.

Renvoie

La valeur

Documentation des données membres

string_type

C3D_API const std::array< castor::String, size_t( ViewportType::eCount ) > castor3d::Viewport::string_type

static

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/Render/Viewport.hpp