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

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

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

Graphe de collaboration de castor3d::Camera:

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

Fonctions membres publiques
C3D_API	Camera (castor::String const &name, Scene &scene, SceneNodeSPtr const node, Viewport &&viewport, bool invertX=false)
	Constructeur. Plus de détails...
C3D_API	Camera (castor::String const &name, Scene &scene, SceneNodeSPtr const node, bool invertX=false)
	Constructeur. Plus de détails...
C3D_API	~Camera ()
	Destructeur. Plus de détails...
C3D_API void	attachTo (SceneNodeSPtr node) override
	Attache cette lumière au node donné Plus de détails...
C3D_API void	update ()
	Met à jour le viewport, frustum... Plus de détails...
C3D_API void	apply () const
	Applique le viewport. Plus de détails...
C3D_API void	resize (uint32_t width, uint32_t height)
	Redimensionne le viewport. Plus de détails...
C3D_API void	resize (castor::Size const &size)
	Redimensionne le viewport. Plus de détails...
C3D_API ViewportType	getViewportType () const
	Récupère le type de viewport. Plus de détails...
C3D_API void	setViewportType (ViewportType value)
	Définit le type de viewport. Plus de détails...
C3D_API uint32_t	getWidth () const
	Récupère la largeur du viewport. Plus de détails...
C3D_API uint32_t	getHeight () const
	Récupère la hauteur du viewport. Plus de détails...
C3D_API bool	isVisible (Geometry const &geometry, Submesh const &submesh) const
	Vérifie si un sous-maillage est visible, via une géométrie. Plus de détails...
C3D_API bool	isVisible (castor::BoundingBox const &box, castor::Matrix4x4r const &transformations) const
	Vérifie si la BoundingBox donnée est dans le frustum de vue. Plus de détails...
C3D_API bool	isVisible (castor::BoundingSphere const &sphere, castor::Matrix4x4r const &transformations, castor::Point3r const &scale) const
	Vérifie si la SphereBox donnée est dans le frustum de vue. Plus de détails...
C3D_API bool	isVisible (castor::Point3r const &point) const
	Vérifie si le point donné est dans le frustum de vue. Plus de détails...
Viewport const &	getViewport () const
	Récupère le Viewport. Plus de détails...
Viewport &	getViewport ()
	Récupère le Viewport. Plus de détails...
castor::Matrix4x4r const &	getView () const
	Récupère la matrice de vue. Plus de détails...
void	setView (castor::Matrix4x4r const &view)
	Définit la matrice de vue. Plus de détails...
Fonctions membres publiques hérités de castor3d::MovableObject
C3D_API	MovableObject (castor::String const &p_name, Scene &p_scene, MovableType p_type, SceneNodeSPtr p_sn)
	Constructeur. Plus de détails...
virtual C3D_API	~MovableObject ()
	Destructeur. Plus de détails...
C3D_API void	detach ()
	Détache l'objet de son parent. Plus de détails...
SceneNodeSPtr	getParent () const
	Récupère le noeud parent. Plus de détails...
MovableType	getType () const
	Récupère le type d'objet. Plus de détails...
Fonctions membres publiques hérités de castor3d::Animable
C3D_API void	cleanupAnimations ()
	Vid ela map d'animations. Plus de détails...
C3D_API bool	hasAnimation (castor::String const &p_name) const
	Récupère une animation. Plus de détails...
C3D_API Animation const &	getAnimation (castor::String const &p_name) const
	Récupère une animation. Plus de détails...
C3D_API Animation &	getAnimation (castor::String const &p_name)
	Récupère une animation. Plus de détails...
AnimationPtrStrMap const &	getAnimations () const

Attributs publics
OnCameraChanged	onChanged

Amis
class	Scene

Membres hérités additionnels
Fonctions membres protégées hérités de castor3d::Animable
	Animable (Scene &p_scene)
	Constructeur. Plus de détails...
virtual	~Animable ()
	Destructeur. Plus de détails...
C3D_API	Animable (Animable &&p_rhs)=default
	Constructeur par déplacement. Plus de détails...
C3D_API Animable &	operator= (Animable &&p_rhs)=default
	Opérateur d'affectation par déplacement. Plus de détails...
C3D_API	Animable (Animable const &p_rhs)=delete
	Constructeur par copie. Plus de détails...
C3D_API Animable &	operator= (Animable const &p_rhs)=delete
	Opérateur d'affectation par copie. Plus de détails...
void	doAddAnimation (AnimationSPtr &&p_animation)
	Ajoute une animation. Plus de détails...
template<typename Type >
Type &	doGetAnimation (castor::String const &p_name)
	Récupère une animation. Plus de détails...
Attributs protégés hérités de castor3d::MovableObject
MovableType	m_type
castor::String	m_strNodeName
SceneNodeWPtr	m_sceneNode
OnSceneNodeChangedConnection	m_notifyIndex
Attributs protégés hérités de castor3d::Animable
AnimationPtrStrMap	m_animations

Description détaillée

Classe de représentation de Camera.

Auteur

Sylvain DOREMUS

Version

0.1

Date

09/02/2010

Remarques

donne la position, orientation, viewport ...

Documentation des constructeurs et destructeur

Camera() [1/2]

C3D_API castor3d::Camera::Camera	(	castor::String const &	name,
		Scene &	scene,
		SceneNodeSPtr const	node,
		Viewport &&	viewport,
		bool	invertX = false
	)

Constructeur.

Paramètres

[in]	name	Le nom de la caméra.
[in]	scene	La scène parente.
[in]	node	Le noeud de scène parent.
[in]	viewport	Viewport à copier.
[in]	invertX	Dit si l'axe des X est inversé.

Camera() [2/2]

C3D_API castor3d::Camera::Camera	(	castor::String const &	name,
		Scene &	scene,
		SceneNodeSPtr const	node,
		bool	invertX = false
	)

Constructeur.

Paramètres

[in]	name	Le nom de la caméra.
[in]	scene	La scène parente.
[in]	node	SceneNode parent.
[in]	invertX	Dit si l'axe des X est inversé.

~Camera()

C3D_API castor3d::Camera::~Camera

(

)

Destructeur.

Documentation des fonctions membres

apply()

C3D_API void castor3d::Camera::apply

(

)

const

Applique le viewport.

attachTo()

C3D_API void castor3d::Camera::attachTo ( SceneNodeSPtr  node )

overridevirtual

Attache cette lumière au node donné

Paramètres

[in]

node

Le nouveau node parent de cette lumière

Réimplémentée à partir de castor3d::MovableObject.

getHeight()

C3D_API uint32_t castor3d::Camera::getHeight

(

)

const

Récupère la hauteur du viewport.

Renvoie

La hauteur

getView()

castor::Matrix4x4r const& castor3d::Camera::getView ( ) const

inline

Récupère la matrice de vue.

getViewport() [1/2]

Viewport const& castor3d::Camera::getViewport ( ) const

inline

Récupère le Viewport.

Renvoie

Le Viewport

getViewport() [2/2]

Viewport& castor3d::Camera::getViewport ( )

inline

Récupère le Viewport.

Renvoie

Le Viewport

getViewportType()

C3D_API ViewportType castor3d::Camera::getViewportType

(

)

const

Récupère le type de viewport.

Renvoie

Le type de viewport

getWidth()

C3D_API uint32_t castor3d::Camera::getWidth

(

)

const

Récupère la largeur du viewport.

Renvoie

La largeur

isVisible() [1/4]

C3D_API bool castor3d::Camera::isVisible	(	Geometry const &	geometry,
		Submesh const &	submesh
	)		const

Vérifie si un sous-maillage est visible, via une géométrie.

Paramètres

[in]	geometry	La géométrie.
[in]	submesh	Le sous-maillage.

Renvoie

false si le sous-maillage n'est pas visible.

isVisible() [2/4]

C3D_API bool castor3d::Camera::isVisible	(	castor::BoundingBox const &	box,
		castor::Matrix4x4r const &	transformations
	)		const

Vérifie si la BoundingBox donnée est dans le frustum de vue.

Paramètres

[in]	box	La BoundingBox
[in]	transformations	La matrice de transformations de la BoundingBox

Renvoie

false si la BoundingBox est complètement en dehors du frustum de vue

isVisible() [3/4]

C3D_API bool castor3d::Camera::isVisible	(	castor::BoundingSphere const &	sphere,
		castor::Matrix4x4r const &	transformations,
		castor::Point3r const &	scale
	)		const

Vérifie si la SphereBox donnée est dans le frustum de vue.

Paramètres

[in]	sphere	La BoundingSphere.
[in]	transformations	La matrice de transformations de la BoundingSphere.
[in]	scale	L'échelle de la BoundingSphere.

Renvoie

false si la BoundingSphere est complètement en dehors du frustum de vue.

isVisible() [4/4]

C3D_API bool castor3d::Camera::isVisible

(

castor::Point3r const &

point

)

const

Vérifie si le point donné est dans le frustum de vue.

Paramètres

[in]

point

Le point

Renvoie

false si le point en dehors du frustum de vue

resize() [1/2]

C3D_API void castor3d::Camera::resize	(	uint32_t	width,
		uint32_t	height
	)

Redimensionne le viewport.

Paramètres

[in]

width,height

Dimensions de la fenêtre d'affichage

resize() [2/2]

C3D_API void castor3d::Camera::resize

(

castor::Size const &

size

)

Redimensionne le viewport.

Paramètres

[in]

size

Dimensions de la fenêtre d'affichage

setView()

void castor3d::Camera::setView ( castor::Matrix4x4r const &  view )

inline

Définit la matrice de vue.

Paramètres

[in]

view

La nouvelle valeur.

setViewportType()

C3D_API void castor3d::Camera::setViewportType

(

ViewportType

value

)

Définit le type de viewport.

Paramètres

[in]

value

Le type de viewport

update()

C3D_API void castor3d::Camera::update

(

)

Met à jour le viewport, frustum...

Documentation des fonctions amies et associées

Scene

friend class Scene

friend

Documentation des données membres

onChanged

OnCameraChanged castor3d::Camera::onChanged

mutable

Le signal levé lorsque la caméra a changé.

---

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

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/Scene/Camera.hpp