irrlicht/source/Irrlicht/CCameraSceneNode.h

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h

#pragma once

#include "ICameraSceneNode.h"
#include "SViewFrustum.h"

namespace irr
{
namespace scene
{

class CCameraSceneNode : public ICameraSceneNode
{
public:
	//! constructor
	CCameraSceneNode(ISceneNode *parent, ISceneManager *mgr, s32 id,
			const core::vector3df &position = core::vector3df(0, 0, 0),
			const core::vector3df &lookat = core::vector3df(0, 0, 100));

	//! Sets the projection matrix of the camera.
	/** The core::matrix4 class has some methods
	to build a projection matrix. e.g: core::matrix4::buildProjectionMatrixPerspectiveFovLH.
	Note that the matrix will only stay as set by this method until one of
	the following Methods are called: setNearValue, setFarValue, setAspectRatio, setFOV.
	\param projection The new projection matrix of the camera.
	\param isOrthogonal Set this to true if the matrix is an orthogonal one (e.g.
	from matrix4::buildProjectionMatrixOrthoLH(). */
	void setProjectionMatrix(const core::matrix4 &projection, bool isOrthogonal = false) override;

	//! Gets the current projection matrix of the camera
	//! \return Returns the current projection matrix of the camera.
	const core::matrix4 &getProjectionMatrix() const override;

	//! Gets the current view matrix of the camera
	//! \return Returns the current view matrix of the camera.
	const core::matrix4 &getViewMatrix() const override;

	//! Sets a custom view matrix affector.
	/** \param affector: The affector matrix. */
	void setViewMatrixAffector(const core::matrix4 &affector) override;

	//! Gets the custom view matrix affector.
	const core::matrix4 &getViewMatrixAffector() const override;

	//! It is possible to send mouse and key events to the camera. Most cameras
	//! may ignore this input, but camera scene nodes which are created for
	//! example with scene::ISceneManager::addMayaCameraSceneNode or
	//! scene::ISceneManager::addMeshViewerCameraSceneNode, may want to get this input
	//! for changing their position, look at target or whatever.
	bool OnEvent(const SEvent &event) override;

	//! Sets the look at target of the camera
	/** If the camera's target and rotation are bound ( @see bindTargetAndRotation() )
	then calling this will also change the camera's scene node rotation to match the target.
	\param pos: Look at target of the camera. */
	void setTarget(const core::vector3df &pos) override;

	//! Sets the rotation of the node.
	/** This only modifies the relative rotation of the node.
	If the camera's target and rotation are bound ( @see bindTargetAndRotation() )
	then calling this will also change the camera's target to match the rotation.
	\param rotation New rotation of the node in degrees. */
	void setRotation(const core::vector3df &rotation) override;

	//! Gets the current look at target of the camera
	/** \return The current look at target of the camera */
	const core::vector3df &getTarget() const override;

	//! Sets the up vector of the camera.
	//! \param pos: New upvector of the camera.
	void setUpVector(const core::vector3df &pos) override;

	//! Gets the up vector of the camera.
	//! \return Returns the up vector of the camera.
	const core::vector3df &getUpVector() const override;

	//! Gets distance from the camera to the near plane.
	//! \return Value of the near plane of the camera.
	f32 getNearValue() const override;

	//! Gets the distance from the camera to the far plane.
	//! \return Value of the far plane of the camera.
	f32 getFarValue() const override;

	//! Get the aspect ratio of the camera.
	//! \return The aspect ratio of the camera.
	f32 getAspectRatio() const override;

	//! Gets the field of view of the camera.
	//! \return Field of view of the camera
	f32 getFOV() const override;

	//! Sets the value of the near clipping plane. (default: 1.0f)
	void setNearValue(f32 zn) override;

	//! Sets the value of the far clipping plane (default: 2000.0f)
	void setFarValue(f32 zf) override;

	//! Sets the aspect ratio (default: 4.0f / 3.0f)
	void setAspectRatio(f32 aspect) override;

	//! Sets the field of view (Default: PI / 3.5f)
	void setFOV(f32 fovy) override;

	//! PreRender event
	void OnRegisterSceneNode() override;

	//! Render
	void render() override;

	//! Update
	void updateMatrices() override;

	//! Returns the axis aligned bounding box of this node
	const core::aabbox3d<f32> &getBoundingBox() const override;

	//! Returns the view area.
	const SViewFrustum *getViewFrustum() const override;

	//! Disables or enables the camera to get key or mouse inputs.
	//! If this is set to true, the camera will respond to key inputs
	//! otherwise not.
	void setInputReceiverEnabled(bool enabled) override;

	//! Returns if the input receiver of the camera is currently enabled.
	bool isInputReceiverEnabled() const override;

	//! Returns type of the scene node
	ESCENE_NODE_TYPE getType() const override { return ESNT_CAMERA; }

	//! Binds the camera scene node's rotation to its target position and vice versa, or unbinds them.
	void bindTargetAndRotation(bool bound) override;

	//! Queries if the camera scene node's rotation and its target position are bound together.
	bool getTargetAndRotationBinding(void) const override;

	//! Creates a clone of this scene node and its children.
	ISceneNode *clone(ISceneNode *newParent = 0, ISceneManager *newManager = 0) override;

protected:
	void recalculateProjectionMatrix();
	void recalculateViewArea();

	core::aabbox3d<f32> BoundingBox;

	core::vector3df Target;
	core::vector3df UpVector;

	f32 Fovy;   // Field of view, in radians.
	f32 Aspect; // Aspect ratio.
	f32 ZNear;  // value of the near view-plane.
	f32 ZFar;   // Z-value of the far view-plane.

	SViewFrustum ViewArea;
	core::matrix4 Affector;

	bool InputReceiverEnabled;
	bool TargetAndRotationAreBound;
};

} // end namespace
} // end namespace