Scene Node which is a (controllable) camera. More...

#include <duckcpp/core/engine/ICameraSceneNode.hpp>

Inheritance diagram for dcpp::scene::ICameraSceneNode:

Collaboration diagram for dcpp::scene::ICameraSceneNode:

Public Member Functions
	ICameraSceneNode (ISceneNode parent, ISceneManager mgr, dcpp::int32_kt id, const dcpp::nub::vector3df &position=dcpp::nub::vector3df(0, 0, 0), const dcpp::nub::vector3df &rotation=dcpp::nub::vector3df(0, 0, 0), const dcpp::nub::vector3df &scale=dcpp::nub::vector3df(1.0f, 1.0f, 1.0f))
	Constructor.

virtual void	setProjectionMatrix (const dcpp::nub::matrix4 &projection, bool isOrthogonal=false)=0
	Sets the projection matrix of the camera.

virtual const dcpp::nub::matrix4 &	getProjectionMatrix () const =0
	Gets the current projection matrix of the camera.

virtual const dcpp::nub::matrix4 &	getViewMatrix () const =0
	Gets the current view matrix of the camera.

virtual void	setViewMatrixAffector (const dcpp::nub::matrix4 &affector)=0
	Sets a custom view matrix affector.

virtual const dcpp::nub::matrix4 &	getViewMatrixAffector () const =0
	Get the custom view matrix affector.

virtual bool	OnEvent (const SEvent &event) override=0
	It is possible to send mouse and key events to the camera.

virtual void	setTarget (const dcpp::nub::vector3df &pos)=0
	Sets the look at target of the camera.

virtual void	setRotation (const dcpp::nub::vector3df &rotation) override=0
	Sets the rotation of the node.

virtual const dcpp::nub::vector3df &	getTarget () const =0
	Gets the current look at target of the camera.

virtual void	setUpVector (const dcpp::nub::vector3df &pos)=0
	Sets the up vector of the camera.

virtual const dcpp::nub::vector3df &	getUpVector () const =0
	Gets the up vector of the camera.

virtual dcpp::float32_kt	getNearValue () const =0
	Gets the value of the near plane of the camera.

virtual dcpp::float32_kt	getFarValue () const =0
	Gets the value of the far plane of the camera.

virtual dcpp::float32_kt	getAspectRatio () const =0
	Gets the aspect ratio of the camera.

virtual dcpp::float32_kt	getFOV () const =0
	Gets the field of view of the camera.

virtual void	setNearValue (dcpp::float32_kt zn)=0
	Sets the value of the near clipping plane. (default: 1.0f)

virtual void	setFarValue (dcpp::float32_kt zf)=0
	Sets the value of the far clipping plane (default: 2000.0f)

virtual void	setAspectRatio (dcpp::float32_kt aspect)=0
	Sets the aspect ratio (default: 4.0f / 3.0f)

virtual void	setFOV (dcpp::float32_kt fovy)=0
	Sets the field of view (Default: PI / 2.5f)

virtual const SViewFrustum *	getViewFrustum () const =0
	Get the view frustum.

virtual void	setInputReceiverEnabled (bool enabled)=0
	Disables or enables the camera to get key or mouse inputs.

virtual bool	isInputReceiverEnabled () const =0
	Checks if the input receiver of the camera is currently enabled.

virtual bool	isOrthogonal () const
	Checks if a camera is orthogonal.

virtual void	bindTargetAndRotation (bool bound)=0
	Binds the camera scene node's rotation to its target position and vice versa, or unbinds them.

virtual void	updateMatrices ()=0
	Updates the view matrix and frustum without uploading the matrix to the driver.

virtual bool	getTargetAndRotationBinding (void) const =0
	Queries if the camera scene node's rotation and its target position are bound together.

virtual void	serializeAttributes (dcpp::io::IAttributes out, dcpp::io::SAttributeReadWriteOptions options=0) const override
	Writes attributes of the camera node.

virtual void	deserializeAttributes (dcpp::io::IAttributes in, dcpp::io::SAttributeReadWriteOptions options=0) override
	Reads attributes of the camera node.

Public Member Functions inherited from dcpp::scene::ISceneNode
	ISceneNode (ISceneNode parent, ISceneManager mgr, dcpp::int32_kt id=-1, const dcpp::nub::vector3df &position=dcpp::nub::vector3df(0, 0, 0), const dcpp::nub::vector3df &rotation=dcpp::nub::vector3df(0, 0, 0), const dcpp::nub::vector3df &scale=dcpp::nub::vector3df(1.0f, 1.0f, 1.0f))
	Constructor.

virtual	~ISceneNode ()
	Destructor.

virtual void	OnRegisterSceneNode ()
	This method is called just before the rendering process of the whole scene.

virtual void	OnAnimate (dcpp::uint32_kt timeMs)
	OnAnimate() is called just before rendering the whole scene.

virtual void	render ()=0
	Renders the node.

virtual const dcpp::char_kt *	getName () const
	Returns the name of the node.

virtual void	setName (const dcpp::char_kt *name)
	Sets the name of the node.

virtual void	setName (const dcpp::nub::string &name)
	Sets the name of the node.

virtual const dcpp::nub::aabbox3df &	getBoundingBox () const =0
	Get the axis aligned, not transformed bounding box of this node.

virtual const dcpp::nub::aabbox3df	getTransformedBoundingBox () const
	Get the axis aligned, transformed and animated absolute bounding box of this node.

virtual void	getTransformedBoundingBoxEdges (dcpp::nub::array< dcpp::nub::vector3df > &edges) const

virtual const dcpp::nub::matrix4 &	getAbsoluteTransformation () const
	Get the absolute transformation of the node. Is recalculated every OnAnimate()-call.

virtual dcpp::nub::matrix4	getRelativeTransformation () const
	Returns the relative transformation of the scene node.

virtual bool	isVisible () const
	Returns whether the node should be visible (if all of its parents are visible).

virtual bool	isTrulyVisible () const
	Check whether the node is truly visible, taking into accounts its parents' visibility.

virtual void	setVisible (bool isVisible)
	Sets if the node should be visible or not.

virtual dcpp::int32_kt	getID () const
	Get the id of the scene node.

virtual void	setID (dcpp::int32_kt id)
	Sets the id of the scene node.

virtual void	addChild (ISceneNode *child)
	Adds a child to this scene node.

virtual bool	removeChild (ISceneNode *child)
	Removes a child from this scene node.

virtual void	removeAll ()
	Removes all children of this scene node.

virtual void	remove ()
	Removes this scene node from the scene.

virtual void	addAnimator (ISceneNodeAnimator *animator)
	Adds an animator which should animate this node.

const dcpp::nub::list< ISceneNodeAnimator * > &	getAnimators () const
	Get a list of all scene node animators.

virtual void	removeAnimator (ISceneNodeAnimator *animator)
	Removes an animator from this scene node.

virtual void	removeAnimators ()
	Removes all animators from this scene node.

virtual dcpp::video::SMaterial &	getMaterial (dcpp::uint32_kt num)
	Returns the material based on the zero based index i.

virtual dcpp::uint32_kt	getMaterialCount () const
	Get amount of materials used by this scene node.

void	setMaterialFlag (dcpp::video::E_MATERIAL_FLAG flag, bool newvalue)
	Sets all material flags at once to a new value.

void	setMaterialTexture (dcpp::uint32_kt textureLayer, dcpp::video::ITexture *texture)
	Sets the texture of the specified layer in all materials of this scene node to the new texture.

void	setMaterialType (dcpp::video::E_MATERIAL_TYPE newType)
	Sets the material type of all materials in this scene node to a new material type.

virtual const dcpp::nub::vector3df &	getScale () const
	Gets the scale of the scene node relative to its parent.

virtual void	setScale (const dcpp::nub::vector3df &scale)
	Sets the relative scale of the scene node.

virtual const dcpp::nub::vector3df &	getRotation () const
	Gets the rotation of the node relative to its parent.

virtual const dcpp::nub::vector3df &	getPosition () const
	Gets the position of the node relative to its parent.

virtual void	setPosition (const dcpp::nub::vector3df &newpos)
	Sets the position of the node relative to its parent.

virtual dcpp::nub::vector3df	getAbsolutePosition () const
	Gets the absolute position of the node in world coordinates.

void	setAutomaticCulling (dcpp::uint32_kt state)
	Set a culling style or disable culling completely.

dcpp::uint32_kt	getAutomaticCulling () const
	Gets the automatic culling state.

void	setUpdateAbsolutePosBehavior (ESCENE_NODE_UPDATE_ABS behavior)
	Set how updateAbsolutePosition calculates the absolute transformation matrix.

ESCENE_NODE_UPDATE_ABS	getUpdateAbsolutePosBehavior () const
	Get how updateAbsolutePosition calculates the absolute transformation matrix.

virtual void	setDebugDataVisible (dcpp::uint32_kt state)
	Sets if debug data like bounding boxes should be drawn.

dcpp::uint32_kt	isDebugDataVisible () const
	Returns if debug data like bounding boxes are drawn.

void	setIsDebugObject (bool debugObject)
	Sets if this scene node is a debug object.

bool	isDebugObject () const
	Returns if this scene node is a debug object.

const dcpp::nub::list< ISceneNode * > &	getChildren () const
	Returns a const reference to the list of all children.

virtual void	setParent (ISceneNode *newParent)
	Changes the parent of the scene node.

virtual ITriangleSelector *	getTriangleSelector () const
	Returns the triangle selector attached to this scene node.

virtual void	setTriangleSelector (ITriangleSelector *selector)
	Sets the triangle selector of the scene node.

virtual void	updateAbsolutePosition ()
	Updates the absolute tranformation or position based on the relative and the parents transformation.

dcpp::scene::ISceneNode *	getParent () const
	Returns the parent of this scene node.

virtual ESCENE_NODE_TYPE	getType () const
	Returns type of the scene node.

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

virtual ISceneManager *	getSceneManager (void) const
	Retrieve the scene manager for this node.

Public Member Functions inherited from dcpp::IReferenceCounted
	IReferenceCounted ()
	Constructor.

virtual	~IReferenceCounted ()
	Destructor.

void	grab () const
	Grabs the object. Increments the reference counter by one.

bool	drop () const
	Drops the object. Decrements the reference counter by one.

dcpp::int32_kt	getReferenceCount () const
	Get the reference count.

const dcpp::char_kt *	getDebugName () const
	Returns the debug name of the object.

Public Member Functions inherited from dcpp::IEventReceiver
virtual	~IEventReceiver ()
	Destructor.

Protected Member Functions
void	cloneMembers (const ICameraSceneNode *toCopyFrom)

Protected Member Functions inherited from dcpp::scene::ISceneNode
void	cloneMembers (ISceneNode toCopyFrom, ISceneManager newManager)
	A clone function for the ISceneNode members.

void	setSceneManager (ISceneManager *newManager)

Protected Member Functions inherited from dcpp::IReferenceCounted
void	setDebugName (const dcpp::char_kt *newName)
	Sets the debug name of the object.

Protected Attributes
bool	IsOrthogonal

Protected Attributes inherited from dcpp::scene::ISceneNode
dcpp::nub::string	Name
	Name of the scene node.

dcpp::nub::matrix4	AbsoluteTransformation
	Absolute transformation of the node.

dcpp::nub::vector3df	RelativeTranslation
	Relative translation of the scene node.

dcpp::nub::vector3df	RelativeRotation
	Relative rotation of the scene node.

dcpp::nub::vector3df	RelativeScale
	Relative scale of the scene node.

ISceneNode *	Parent
	Pointer to the parent.

dcpp::nub::list< ISceneNode * >	Children
	List of all children of this node.

dcpp::nub::list< ISceneNodeAnimator * >	Animators
	List of all animator nodes.

ISceneManager *	SceneManager
	Pointer to the scene manager.

ITriangleSelector *	TriangleSelector
	Pointer to the triangle selector.

dcpp::int32_kt	ID
	ID of the node.

ESCENE_NODE_UPDATE_ABS	UpdateAbsolutePosBehavior
	How updateAbsolutePosition calculates AbsoluteTransformation.

dcpp::uint32_kt	AutomaticCullingState
	Automatic culling state.

dcpp::uint32_kt	DebugDataVisible
	Flag if debug data should be drawn, such as Bounding Boxes.

bool	IsVisible
	Is the node visible?

bool	IsDebugObject
	Is debug object?

Detailed Description

Scene Node which is a (controllable) camera.

The whole scene will be rendered from the cameras point of view. Because the ICameraSceneNode is a SceneNode, it can be attached to any other scene node, and will follow its parents movement, rotation and so on.

Member Function Documentation

◆ bindTargetAndRotation()

virtual void dcpp::scene::ICameraSceneNode::bindTargetAndRotation ( bool bound )

pure virtual

Binds the camera scene node's rotation to its target position and vice versa, or unbinds them.

When bound, calling setRotation() will update the camera's target position to be along its +Z axis, and likewise calling setTarget() will update its rotation so that its +Z axis will point at the target point. FPS camera use this binding by default; other cameras do not.

Parameters

bound True to bind the camera's scene node rotation and targeting, false to unbind them.

See also: getTargetAndRotationBinding()

◆ deserializeAttributes()

virtual void dcpp::scene::ICameraSceneNode::deserializeAttributes	(	dcpp::io::IAttributes *	in,
		dcpp::io::SAttributeReadWriteOptions *	options = `0`
	)

inlineoverridevirtual

Reads attributes of the camera node.

Reimplemented from dcpp::scene::ISceneNode.

◆ getAspectRatio()

virtual dcpp::float32_kt dcpp::scene::ICameraSceneNode::getAspectRatio ( ) const

pure virtual

Gets the aspect ratio of the camera.

Returns: The aspect ratio of the camera.

◆ getFarValue()

virtual dcpp::float32_kt dcpp::scene::ICameraSceneNode::getFarValue ( ) const

pure virtual

Gets the value of the far plane of the camera.

Returns: The value of the far plane of the camera.

◆ getFOV()

virtual dcpp::float32_kt dcpp::scene::ICameraSceneNode::getFOV ( ) const

pure virtual

Gets the field of view of the camera.

Returns: The field of view of the camera in radians.

◆ getNearValue()

virtual dcpp::float32_kt dcpp::scene::ICameraSceneNode::getNearValue ( ) const

pure virtual

Gets the value of the near plane of the camera.

Returns: The value of the near plane of the camera.

◆ getProjectionMatrix()

virtual const dcpp::nub::matrix4 & dcpp::scene::ICameraSceneNode::getProjectionMatrix ( ) const

pure virtual

Gets the current projection matrix of the camera.

Returns: The current projection matrix of the camera.

◆ getTarget()

virtual const dcpp::nub::vector3df & dcpp::scene::ICameraSceneNode::getTarget ( ) const

pure virtual

Gets the current look at target of the camera.

Returns: The current look at target of the camera, in world co-ordinates

◆ getTargetAndRotationBinding()

virtual bool dcpp::scene::ICameraSceneNode::getTargetAndRotationBinding ( void ) const

pure virtual

Queries if the camera scene node's rotation and its target position are bound together.

See also: bindTargetAndRotation()

◆ getUpVector()

virtual const dcpp::nub::vector3df & dcpp::scene::ICameraSceneNode::getUpVector ( ) const

pure virtual

Gets the up vector of the camera.

Returns: The up vector of the camera, in world space.

◆ getViewFrustum()

virtual const SViewFrustum * dcpp::scene::ICameraSceneNode::getViewFrustum ( ) const

pure virtual

Get the view frustum.

Returns: The current view frustum.

◆ getViewMatrix()

virtual const dcpp::nub::matrix4 & dcpp::scene::ICameraSceneNode::getViewMatrix ( ) const

pure virtual

Gets the current view matrix of the camera.

Returns: The current view matrix of the camera.

◆ getViewMatrixAffector()

virtual const dcpp::nub::matrix4 & dcpp::scene::ICameraSceneNode::getViewMatrixAffector ( ) const

pure virtual

Get the custom view matrix affector.

Returns: The affector matrix.

◆ OnEvent()

virtual bool dcpp::scene::ICameraSceneNode::OnEvent ( const SEvent & event )

overridepure virtual

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 ISceneManager::addCameraSceneNodeDqrs or ISceneManager::addCameraSceneNodeFPS, may want to get this input for changing their position, look at target or whatever.

Implements dcpp::IEventReceiver.

◆ serializeAttributes()

virtual void dcpp::scene::ICameraSceneNode::serializeAttributes	(	dcpp::io::IAttributes *	out,
		dcpp::io::SAttributeReadWriteOptions *	options = `0`
	)		const

inlineoverridevirtual

Writes attributes of the camera node.

Reimplemented from dcpp::scene::ISceneNode.

◆ setAspectRatio()

virtual void dcpp::scene::ICameraSceneNode::setAspectRatio ( dcpp::float32_kt aspect )

pure virtual

Sets the aspect ratio (default: 4.0f / 3.0f)

Also changes projection matrix and resets IsOrthogonal flag.

Parameters

aspect New aspect ratio.

◆ setFarValue()

virtual void dcpp::scene::ICameraSceneNode::setFarValue ( dcpp::float32_kt zf )

pure virtual

Sets the value of the far clipping plane (default: 2000.0f)

Also changes projection matrix and resets IsOrthogonal flag.

Parameters

zf	New z far value.

◆ setFOV()

virtual void dcpp::scene::ICameraSceneNode::setFOV ( dcpp::float32_kt fovy )

pure virtual

Sets the field of view (Default: PI / 2.5f)

Also changes projection matrix and resets IsOrthogonal flag.

Parameters

fovy	New field of view in radians.

◆ setInputReceiverEnabled()

virtual void dcpp::scene::ICameraSceneNode::setInputReceiverEnabled ( bool enabled )

pure virtual

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.

◆ setNearValue()

virtual void dcpp::scene::ICameraSceneNode::setNearValue ( dcpp::float32_kt zn )

pure virtual

Sets the value of the near clipping plane. (default: 1.0f)

Also changes projection matrix and resets IsOrthogonal flag.

Parameters

zn	New z near value.

◆ setProjectionMatrix()

virtual void dcpp::scene::ICameraSceneNode::setProjectionMatrix	(	const dcpp::nub::matrix4 &	projection,
		bool	isOrthogonal = `false`
	)

pure virtual

Sets the projection matrix of the camera.

The dcpp::nub::matrix4 class has some methods to build a projection matrix. e.g: dcpp::nub::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. NOTE: The frustum is not updated before render() is called unless you explicitly call updateMatrices()

Parameters

projection	The new projection matrix of the camera.
isOrthogonal	Set this to true if the matrix is an orthogonal one (e.g. from matrix4::buildProjectionMatrixOrtho).

◆ setRotation()

virtual void dcpp::scene::ICameraSceneNode::setRotation ( const dcpp::nub::vector3df & rotation )

overridepure virtual

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 also: bindTargetAndRotation() ) then calling this will also change the camera's target to match the rotation.

Parameters

rotation New rotation of the node in degrees.

Reimplemented from dcpp::scene::ISceneNode.

◆ setTarget()

virtual void dcpp::scene::ICameraSceneNode::setTarget ( const dcpp::nub::vector3df & pos )

pure virtual

Sets the look at target of the camera.

If the camera's target and rotation are bound (

See also: bindTargetAndRotation() ) then calling this will also change the camera's scene node rotation to match the target. Note that setTarget uses the current absolute position internally, so if you changed setPosition since last rendering you must call updateAbsolutePosition before using this function.

Parameters

pos	Look at target of the camera, in world co-ordinates.

◆ setUpVector()

virtual void dcpp::scene::ICameraSceneNode::setUpVector ( const dcpp::nub::vector3df & pos )

pure virtual

Sets the up vector of the camera.

Parameters

pos	New upvector of the camera.

◆ setViewMatrixAffector()

virtual void dcpp::scene::ICameraSceneNode::setViewMatrixAffector ( const dcpp::nub::matrix4 & affector )

pure virtual

Sets a custom view matrix affector.

The matrix passed here, will be multiplied with the view matrix when it gets updated. This allows for custom camera setups like, for example, a reflection camera.

Parameters

affector The affector matrix.

◆ updateMatrices()

virtual void dcpp::scene::ICameraSceneNode::updateMatrices ( )

pure virtual

Updates the view matrix and frustum without uploading the matrix to the driver.

You need this when you want an up-to-date camera view matrix & frustum before the render() call. Usually you should call updateAbsolutePosition() before calling this. Despite it's function name, the projection matrix is not touched.

The documentation for this class was generated from the following file:

include/duckcpp/core/engine/ICameraSceneNode.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ bindTargetAndRotation()

◆ deserializeAttributes()

◆ getAspectRatio()

◆ getFarValue()

◆ getFOV()

◆ getNearValue()

◆ getProjectionMatrix()

◆ getTarget()

◆ getTargetAndRotationBinding()

◆ getUpVector()

◆ getViewFrustum()

◆ getViewMatrix()

◆ getViewMatrixAffector()

◆ OnEvent()

◆ serializeAttributes()

◆ setAspectRatio()

◆ setFarValue()

◆ setFOV()

◆ setInputReceiverEnabled()

◆ setNearValue()

◆ setProjectionMatrix()

◆ setRotation()

◆ setTarget()

◆ setUpVector()

◆ setViewMatrixAffector()

◆ updateMatrices()