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...

Types publics
using	OnChangedFunction = std::function< void(Camera const &) >

using	OnChanged = Castor::Signal< OnChangedFunction >

Fonctions membres publiques
C3D_API	Camera (Castor::String const &p_name, Scene &p_scene, const SceneNodeSPtr p_node, Viewport &&p_viewport)
	Constructeur. Plus de détails...

C3D_API	Camera (Castor::String const &p_name, Scene &p_scene, const SceneNodeSPtr p_node)
	Constructeur. Plus de détails...

C3D_API	~Camera ()
	Destructeur. Plus de détails...

C3D_API void	AttachTo (SceneNodeSPtr p_node) override
	Attache cette lumière au node donné Plus de détails...

C3D_API void	ResetOrientation ()
	Met l'orientation à l'identité Plus de détails...

C3D_API void	ResetPosition ()
	Réinitialise la position. 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 p_width, uint32_t p_height)
	Redimensionne le viewport. Plus de détails...

C3D_API void	Resize (Castor::Size const &p_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 val)
	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 (Castor::CubeBox const &p_box, Castor::Matrix4x4r const &m_transformations) const
	Vérifie si la CubeBox donnée est dans le frustum de vue. Plus de détails...

C3D_API bool	IsVisible (Castor::SphereBox const &p_box, Castor::Matrix4x4r const &m_transformations) 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 &p_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 &p_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
OnChanged	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

SceneNode::OnChanged::connection	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 définitions de type membres

◆ OnChanged

using Castor3D::Camera::OnChanged = Castor::Signal< OnChangedFunction >

◆ OnChangedFunction

using Castor3D::Camera::OnChangedFunction = std::function< void( Camera const & ) >

Documentation des constructeurs et destructeur

◆ Camera() [1/2]

C3D_API Castor3D::Camera::Camera	(	Castor::String const &	p_name,
		Scene &	p_scene,
		const SceneNodeSPtr	p_node,
		Viewport &&	p_viewport
	)

Constructeur.

Remarques: L'utilisateur ne devrait pas s'en servir, préférer l'utilisation de Scene::CreateCamera

Paramètres

[in]	p_name	Le nom de la caméra
[in]	p_scene	La scène parente
[in]	p_node	Le noeud de scène parent
[in]	p_viewport	Viewport à copier

◆ Camera() [2/2]

C3D_API Castor3D::Camera::Camera	(	Castor::String const &	p_name,
		Scene &	p_scene,
		const SceneNodeSPtr	p_node
	)

Constructeur.

Remarques: L'utilisateur ne devrait pas s'en servir, préférer l'utilisation de Scene::CreateCamera

Paramètres

[in]	p_name	Le nom de la caméra
[in]	p_scene	La scène parente
[in]	p_node	SceneNode parent

◆ ~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 p_node )

overridevirtual

Attache cette lumière au node donné

Paramètres

[in] p_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/3]

C3D_API bool Castor3D::Camera::IsVisible	(	Castor::CubeBox const &	p_box,
		Castor::Matrix4x4r const &	m_transformations
	)		const

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

Paramètres

[in]	p_box	La CubeBox
[in]	m_transformations	La matrice de transformations de la CubeBox

Renvoie: false si la CubeBox est complètement en dehors du frustum de vue

◆ IsVisible() [2/3]

C3D_API bool Castor3D::Camera::IsVisible	(	Castor::SphereBox const &	p_box,
		Castor::Matrix4x4r const &	m_transformations
	)		const

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

Paramètres

[in]	p_box	La SphereBox
[in]	m_transformations	La SphereBox de transformations de la CubeBox

Renvoie: false si la SphereBox est complètement en dehors du frustum de vue

◆ IsVisible() [3/3]

C3D_API bool Castor3D::Camera::IsVisible ( Castor::Point3r const & p_point ) const

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

Paramètres

[in] p_point Le point

Renvoie: false si le point en dehors du frustum de vue

◆ ResetOrientation()

C3D_API void Castor3D::Camera::ResetOrientation ( )

Met l'orientation à l'identité

◆ ResetPosition()

C3D_API void Castor3D::Camera::ResetPosition ( )

Réinitialise la position.

◆ Resize() [1/2]

C3D_API void Castor3D::Camera::Resize	(	uint32_t	p_width,
		uint32_t	p_height
	)

Redimensionne le viewport.

Paramètres

[in] p_width,p_height Dimensions de la fenêtre d'affichage

◆ Resize() [2/2]

C3D_API void Castor3D::Camera::Resize ( Castor::Size const & p_size )

Redimensionne le viewport.

Paramètres

[in] p_size Dimensions de la fenêtre d'affichage

◆ SetView()

void Castor3D::Camera::SetView ( Castor::Matrix4x4r const & p_view )

inline

Définit la matrice de vue.

Paramètres

[in] p_view La nouvelle valeur.

◆ SetViewportType()

C3D_API void Castor3D::Camera::SetViewportType ( ViewportType val )

Définit le type de viewport.

Paramètres

[in] val 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

OnChanged Castor3D::Camera::onChanged

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

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

Y:/software/perso/Castor3D/source/Core/Castor3D/Src/Scene/Camera.hpp

Classes

Types publics

Fonctions membres publiques

Attributs publics

Amis

Membres hérités additionnels

Description détaillée

Documentation des définitions de type membres

◆ OnChanged

◆ OnChangedFunction

Documentation des constructeurs et destructeur

◆ Camera() [1/2]

◆ Camera() [2/2]

◆ ~Camera()

Documentation des fonctions membres

◆ Apply()

◆ AttachTo()

◆ GetHeight()

◆ GetView()

◆ GetViewport() [1/2]

◆ GetViewport() [2/2]

◆ GetViewportType()

◆ GetWidth()

◆ IsVisible() [1/3]

◆ IsVisible() [2/3]

◆ IsVisible() [3/3]

◆ ResetOrientation()

◆ ResetPosition()

◆ Resize() [1/2]

◆ Resize() [2/2]

◆ SetView()

◆ SetViewportType()

◆ Update()

Documentation des fonctions amies et associées

◆ Scene

Documentation des données membres

◆ onChanged