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

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

class	TextLoader
	Loader de Viewport. Plus de détails...

Fonctions membres publiques
C3D_API	Viewport (Engine &p_engine, eVIEWPORT_TYPE p_type)
	Constructeur. Plus de détails...

virtual C3D_API	~Viewport ()
	Destructeur. Plus de détails...

C3D_API bool	Render (Pipeline &p_pipeline)
	Rend le viewport. Plus de détails...

const Castor::Size &	GetSize () const

eVIEWPORT_TYPE	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

void	SetSize (const Castor::Size &p_size)
	Définit les dimensions de rendu du viewport. Plus de détails...

void	SetType (eVIEWPORT_TYPE p_type)
	Récupère le type de projection du viewport. Plus de détails...

void	SetRatio (real p_rRatio)
	Récupère le ratio d'aspect. Plus de détails...

void	SetNear (real p_rNear)
	Récupère la position du plan proche. Plus de détails...

void	SetFar (real p_rFar)
	Récupère la position du plan lointain. Plus de détails...

void	SetFovY (Castor::Angle const &p_aFovY)
	Récupère l'angle de vue vertical. Plus de détails...

void	SetLeft (real p_rLeft)
	Récupère la position du plan gauche. Plus de détails...

void	SetRight (real p_rRight)
	Récupère la position du plan droit. Plus de détails...

void	SetTop (real p_rTop)
	Récupère la position du plan haut. Plus de détails...

void	SetBottom (real p_rBottom)
	Récupère la position du plan bas. Plus de détails...

const Castor::PlaneEquation< real > &	GetFrustumPlane (eFRUSTUM_PLANE p_ePlane) const
	Récupère le plan voulu du frustum de vue. Plus de détails...

Castor::Matrix4x4r const &	GetProjection () const

Fonctions membres publiques statiques
static C3D_API Viewport	Perspective (Engine &p_engine, Castor::Angle const &p_fovy, real p_aspect, real p_near, real p_far)
	Construit vioewport en perspective centrée. Plus de détails...

static C3D_API Viewport	Frustum (Engine &p_engine, 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...

static C3D_API Viewport	Ortho (Engine &p_engine, 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...

Attributs publics statiques
static C3D_API const Castor::String	string_type [eVIEWPORT_TYPE_COUNT]

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

C3D_API Castor3D::Viewport::Viewport	(	Engine &	p_engine,
		eVIEWPORT_TYPE	p_type
	)

Constructeur.

Paramètres

[in]	p_engine	Le moteur
[in]	p_type	Type de projection

virtual C3D_API Castor3D::Viewport::~Viewport ( )

virtual

Destructeur.

Documentation des fonctions membres

static C3D_API Viewport Castor3D::Viewport::Frustum	(	Engine &	p_engine,
		real	p_left,
		real	p_right,
		real	p_bottom,
		real	p_top,
		real	p_near,
		real	p_far
	)

static

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

Paramètres

[in]	p_engine	Le moteur
[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.

real Castor3D::Viewport::GetBottom ( ) const

inline

Renvoie: La position du plan bas

real Castor3D::Viewport::GetFar ( ) const

inline

Renvoie: La position du plan lointain

Castor::Angle Castor3D::Viewport::GetFovY ( ) const

inline

Renvoie: L'angle de vue vertical

const Castor::PlaneEquation< real >& Castor3D::Viewport::GetFrustumPlane ( eFRUSTUM_PLANE p_ePlane ) const

inline

Récupère le plan voulu du frustum de vue.

Paramètres

[in] p_ePlane L'index du plan voulu

Renvoie: La valeur

uint32_t Castor3D::Viewport::GetHeight ( ) const

inline

Renvoie: La hauteur du viewport

real Castor3D::Viewport::GetLeft ( ) const

inline

Renvoie: La position du plan gauche

real Castor3D::Viewport::GetNear ( ) const

inline

Renvoie: La position du plan proche

Castor::Matrix4x4r const& Castor3D::Viewport::GetProjection ( ) const

inline

Renvoie: La matrice de projection

real Castor3D::Viewport::GetRatio ( ) const

inline

Renvoie: Le ratio d'aspect

real Castor3D::Viewport::GetRight ( ) const

inline

Renvoie: La position du plan droit

const Castor::Size& Castor3D::Viewport::GetSize ( ) const

inline

Renvoie: Les dimensions de rendu du viewport

real Castor3D::Viewport::GetTop ( ) const

inline

Renvoie: La position du plan haut

eVIEWPORT_TYPE Castor3D::Viewport::GetType ( ) const

inline

Renvoie: Le type de projection du viewport

uint32_t Castor3D::Viewport::GetWidth ( ) const

inline

Renvoie: La largeur du viewport

bool Castor3D::Viewport::IsModified ( ) const

inline

Renvoie: Le statut de modification du viewport

static C3D_API Viewport Castor3D::Viewport::Ortho	(	Engine &	p_engine,
		real	p_left,
		real	p_right,
		real	p_bottom,
		real	p_top,
		real	p_near,
		real	p_far
	)

static

Construit une matrice de projection orthographique.

Paramètres

[in]	p_engine	Le moteur
[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.

static C3D_API Viewport Castor3D::Viewport::Perspective	(	Engine &	p_engine,
		Castor::Angle const &	p_fovy,
		real	p_aspect,
		real	p_near,
		real	p_far
	)

static

Construit vioewport en perspective centrée.

Paramètres

[in]	p_engine	Le moteur
[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.

C3D_API bool Castor3D::Viewport::Render ( Pipeline & p_pipeline )

Rend le viewport.

Remarques: Applique la perspective

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

void Castor3D::Viewport::SetBottom ( real p_rBottom )

inline

Récupère la position du plan bas.

Renvoie: La valeur

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

inline

Récupère la position du plan lointain.

Renvoie: La valeur

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

inline

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

Renvoie: La valeur

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

inline

Récupère la position du plan gauche.

Renvoie: La valeur

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

inline

Récupère la position du plan proche.

Renvoie: La valeur

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

inline

Récupère le ratio d'aspect.

Renvoie: La valeur

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

inline

Récupère la position du plan droit.

Renvoie: La valeur

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

inline

Définit les dimensions de rendu du viewport.

Paramètres

[in] p_size La nouvelle valeur

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

inline

Récupère la position du plan haut.

Renvoie: La valeur

void Castor3D::Viewport::SetType ( eVIEWPORT_TYPE p_type )

inline

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

Renvoie: La valeur

Documentation des données membres

C3D_API const Castor::String Castor3D::Viewport::string_type[eVIEWPORT_TYPE_COUNT]

static

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

Y:/software/Castor3D/source/Core/Castor3D/Src/Viewport.hpp

Classes

Fonctions membres publiques

Fonctions membres publiques statiques

Attributs publics statiques

Description détaillée

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des données membres