irrlicht/source/Irrlicht/CLightSceneNode.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

#ifndef IRR_C_LIGHT_SCENE_NODE_H_INCLUDED
#define IRR_C_LIGHT_SCENE_NODE_H_INCLUDED

#include "ILightSceneNode.h"

namespace irr
{
namespace scene
{

//! Scene node which is a dynamic light. You can switch the light on and off by
//! making it visible or not, and let it be animated by ordinary scene node animators.
class CLightSceneNode : public ILightSceneNode
{
public:

	//! constructor
	CLightSceneNode(ISceneNode* parent, ISceneManager* mgr, s32 id,
		const core::vector3df& position, video::SColorf color, f32 range);

	//! pre render event
	virtual void OnRegisterSceneNode() IRR_OVERRIDE;

	//! render
	virtual void render() IRR_OVERRIDE;

	//! set node light data from light info
	virtual void setLightData(const video::SLight& light) IRR_OVERRIDE;

	//! \return Returns the light data.
	virtual const video::SLight& getLightData() const IRR_OVERRIDE;

	//! \return Returns the light data.
	virtual video::SLight& getLightData() IRR_OVERRIDE;

	//! Sets if the node should be visible or not.
	/** All children of this node won't be visible either, when set
	to true.
	\param isVisible If the node shall be visible. */
	virtual void setVisible(bool isVisible) IRR_OVERRIDE;

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

	//! Returns type of the scene node
	virtual ESCENE_NODE_TYPE getType() const IRR_OVERRIDE { return ESNT_LIGHT; }

	//! Writes attributes of the scene node.
	virtual void serializeAttributes(io::IAttributes* out, io::SAttributeReadWriteOptions* options=0) const IRR_OVERRIDE;

	//! Reads attributes of the scene node.
	virtual void deserializeAttributes(io::IAttributes* in, io::SAttributeReadWriteOptions* options=0) IRR_OVERRIDE;

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

	//! Sets the light's radius of influence.
	/** Outside this radius the light won't lighten geometry and cast no
	shadows. Setting the radius will also influence the attenuation, setting
	it to (0,1/radius,0). If you want to override this behavior, set the
	attenuation after the radius.
	\param radius The new radius. */
	virtual void setRadius(f32 radius) IRR_OVERRIDE;

	//! Gets the light's radius of influence.
	/** \return The current radius. */
	virtual f32 getRadius() const IRR_OVERRIDE;

	//! Sets the light type.
	/** \param type The new type. */
	virtual void setLightType(video::E_LIGHT_TYPE type) IRR_OVERRIDE;

	//! Gets the light type.
	/** \return The current light type. */
	virtual video::E_LIGHT_TYPE getLightType() const IRR_OVERRIDE;

	//! Sets whether this light casts shadows.
	/** Enabling this flag won't automatically cast shadows, the meshes
	will still need shadow scene nodes attached. But one can enable or
	disable distinct lights for shadow casting for performance reasons.
	\param shadow True if this light shall cast shadows. */
	virtual void enableCastShadow(bool shadow=true) IRR_OVERRIDE;

	//! Check whether this light casts shadows.
	/** \return True if light would cast shadows, else false. */
	virtual bool getCastShadow() const IRR_OVERRIDE;

	//! Updates the absolute position based on the relative and the parents position
	virtual void updateAbsolutePosition() IRR_OVERRIDE;

private:

	video::SLight LightData;
	core::aabbox3d<f32> BBox;
	s32 DriverLightIndex;
	bool LightIsOn;
	void doLightRecalc();
};


} // end namespace scene
} // end namespace irr

#endif