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 &p_engine)
	Constructeur. Plus de détails...
C3D_API	Viewport (Viewport const &p_rhs)
	Constructeur par copie. Plus de détails...
C3D_API Viewport &	operator= (Viewport const &p_rhs)
	Opérateur d'affectation par copie. Plus de détails...
C3D_API	Viewport (Viewport &&p_rhs)=default
	Constructeur par déplacement. Plus de détails...
C3D_API Viewport &	operator= (Viewport &&p_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 &p_fovy, real p_aspect, real p_near, real p_far)
	Construit vioewport en perspective centrée. Plus de détails...
C3D_API void	SetFrustum (real p_left, real p_right, real p_bottom, real p_top, real p_near, real p_far)
	Construit une matrice de projection en perspective non centrée. Plus de détails...
C3D_API void	SetOrtho (real p_left, real p_right, real p_bottom, real p_top, real p_near, real p_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 &p_position)
	Définit la position de rendu du viewport. Plus de détails...
void	Resize (const Castor::Size &p_size)
	Définit les dimensions de rendu du viewport. Plus de détails...
void	UpdateType (ViewportType p_type)
	Récupère le type de projection du viewport. Plus de détails...
void	UpdateRatio (real p_rRatio)
	Récupère le ratio d'aspect. Plus de détails...
void	UpdateNear (real p_rNear)
	Récupère la position du plan proche. Plus de détails...
void	UpdateFar (real p_rFar)
	Récupère la position du plan lointain. Plus de détails...
void	UpdateFovY (Castor::Angle const &p_aFovY)
	Récupère l'angle de vue vertical. Plus de détails...
void	UpdateLeft (real p_rLeft)
	Récupère la position du plan gauche. Plus de détails...
void	UpdateRight (real p_rRight)
	Récupère la position du plan droit. Plus de détails...
void	UpdateTop (real p_rTop)
	Récupère la position du plan haut. Plus de détails...
void	UpdateBottom (real p_rBottom)
	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 &  p_engine )

explicit

Constructeur.

Paramètres

[in]

p_engine

Le moteur.

Viewport() [2/3]

C3D_API Castor3D::Viewport::Viewport

(

Viewport const &

p_rhs

)

Constructeur par copie.

Paramètres

[in]

p_rhs

L'objet à copier.

Viewport() [3/3]

C3D_API Castor3D::Viewport::Viewport ( Viewport &&  p_rhs )

default

Constructeur par déplacement.

Paramètres

[in]

p_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 &

p_rhs

)

Opérateur d'affectation par copie.

Paramètres

[in]

p_rhs

L'objet à copier.

operator=() [2/2]

C3D_API Viewport& Castor3D::Viewport::operator= ( Viewport &&  p_rhs )

default

Opérateur d'affectation par déplacement.

Paramètres

[in]

p_rhs

L'objet à déplacer.

Resize()

void Castor3D::Viewport::Resize ( const Castor::Size &  p_size )

inline

Définit les dimensions de rendu du viewport.

Paramètres

[in]

p_size

La nouvelle valeur

SetFrustum()

C3D_API void Castor3D::Viewport::SetFrustum	(	real	p_left,
		real	p_right,
		real	p_bottom,
		real	p_top,
		real	p_near,
		real	p_far
	)

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

Paramètres

[in]	p_left	Position du plan gauche.
[in]	p_right	Position du plan droit.
[in]	p_bottom	Position du plan bas.
[in]	p_top	Position du plan haut.
[in]	p_near	Position du plan proche.
[in]	p_far	Position du plan éloigné.

Renvoie

Le viewport.

SetOrtho()

C3D_API void Castor3D::Viewport::SetOrtho	(	real	p_left,
		real	p_right,
		real	p_bottom,
		real	p_top,
		real	p_near,
		real	p_far
	)

Construit une matrice de projection orthographique.

Paramètres

[in]	p_left	Position du plan gauche.
[in]	p_right	Position du plan droit.
[in]	p_bottom	Position du plan bas.
[in]	p_top	Position du plan haut.
[in]	p_near	Position du plan proche.
[in]	p_far	Position du plan éloigné.

Renvoie

Le viewport.

SetPerspective()

C3D_API void Castor3D::Viewport::SetPerspective	(	Castor::Angle const &	p_fovy,
		real	p_aspect,
		real	p_near,
		real	p_far
	)

Construit vioewport en perspective centrée.

Paramètres

[in]	p_fovy	Angle de vision Y.
[in]	p_aspect	Ratio Largeur / Hauteur.
[in]	p_near	Position du plan proche.
[in]	p_far	Position du plan éloigné.

Renvoie

Le viewport.

SetPosition()

void Castor3D::Viewport::SetPosition ( const Castor::Position &  p_position )

inline

Définit la position de rendu du viewport.

Paramètres

[in]

p_position

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  p_rBottom )

inline

Récupère la position du plan bas.

Renvoie

La valeur

UpdateFar()

void Castor3D::Viewport::UpdateFar ( real  p_rFar )

inline

Récupère la position du plan lointain.

Renvoie

La valeur

UpdateFovY()

void Castor3D::Viewport::UpdateFovY ( Castor::Angle const &  p_aFovY )

inline

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

Renvoie

La valeur

UpdateLeft()

void Castor3D::Viewport::UpdateLeft ( real  p_rLeft )

inline

Récupère la position du plan gauche.

Renvoie

La valeur

UpdateNear()

void Castor3D::Viewport::UpdateNear ( real  p_rNear )

inline

Récupère la position du plan proche.

Renvoie

La valeur

UpdateRatio()

void Castor3D::Viewport::UpdateRatio ( real  p_rRatio )

inline

Récupère le ratio d'aspect.

Renvoie

La valeur

UpdateRight()

void Castor3D::Viewport::UpdateRight ( real  p_rRight )

inline

Récupère la position du plan droit.

Renvoie

La valeur

UpdateTop()

void Castor3D::Viewport::UpdateTop ( real  p_rTop )

inline

Récupère la position du plan haut.

Renvoie

La valeur

UpdateType()

void Castor3D::Viewport::UpdateType ( ViewportType  p_type )

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 :

• Y:/software/perso/Castor3D/source/Core/Castor3D/Src/Render/Viewport.hpp