PointLightComponentInstance Class Reference

#include <pointlightcomponent.h>

Public Member Functions
	PointLightComponentInstance (EntityInstance &entity, Component &resource)
virtual bool	init (utility::ErrorState &errorState) override
virtual ELightType	getLightType () const override
virtual EShadowMapType	getShadowMapType () const override
float	getAttenuation () const
void	setAttenuation (float attenuation)
Public Member Functions inherited from LightComponentInstance
	LightComponentInstance (EntityInstance &entity, Component &resource)
virtual	~LightComponentInstance ()
virtual void	onDestroy () override
virtual void	enable (bool enable)
bool	isEnabled () const
bool	canCastShadows () const
bool	castsShadows () const
virtual uint	getShadowMapSize () const
virtual float	getIntensity () const
void	setIntensity (float intensity)
virtual float	getShadowStrength () const
virtual void	setShadowStrength (float strength)
virtual float	getShadowSpread () const
virtual void	setShadowSpread (float spread)
virtual const RGBColorFloat &	getColor () const
void	setColor (const RGBColorFloat &color)
const glm::vec3	getLightPosition () const
const glm::vec3	getLightDirection () const
const TransformComponentInstance &	getTransform () const
TransformComponentInstance &	getTransform ()
bool	hasCamera () const
CameraComponentInstance &	getCamera () const
CameraComponentInstance &	getCamera ()
const RenderGnomonComponentInstance &	getGnomon () const
RenderGnomonComponentInstance &	getGnomon ()
const RenderFrustumComponentInstance *	getFrustrum () const
RenderFrustumComponentInstance *	getFrustrum ()
Public Member Functions inherited from ComponentInstance
	ComponentInstance (EntityInstance &entity, Component &resource)
virtual void	update (double deltaTime)
nap::EntityInstance *	getEntityInstance () const
nap::Component *	getComponent () const
template<typename T >
T *	getComponent () const
virtual bool	init (utility::ErrorState &errorState)
Public Member Functions inherited from Object
	Object ()
virtual	~Object ()
	Object (Object &)=delete
Object &	operator= (const Object &)=delete
	Object (Object &&)=delete
Object &	operator= (Object &&)=delete

Public Attributes
float	mAttenuation = 0.1f
Public Attributes inherited from LightComponentInstance
float	mIntensity = 1.0f
RGBColorFloat	mColor = { 1.0f, 1.0f, 1.0f }
Public Attributes inherited from Object
std::string	mID
	Property: 'mID' unique name of the object. Used as an identifier by the system. More...

Additional Inherited Members
Static Public Member Functions inherited from Object
static bool	isIDProperty (rtti::Instance &object, const rtti::Property &property)
Protected Member Functions inherited from LightComponentInstance
void	registerUniformLightProperty (const std::string &memberName)
SpawnedEntityInstance	spawnShadowCamera (const nap::Entity &entity, nap::utility::ErrorState &error)
Protected Attributes inherited from LightComponentInstance
LightComponent *	mResource = nullptr
TransformComponentInstance *	mTransform = nullptr
RenderAdvancedService *	mService = nullptr
SpawnedEntityInstance	mSpawnedCamera
bool	mIsEnabled = true
bool	mIsShadowEnabled = false
float	mShadowStrength = 1.0f
float	mShadowSpread = 2.0f
uint	mShadowMapSize = 512

Description

Point light component instance for NAP RenderAdvanced's light system.

Omnidirectional light that emits from its origin. Therefore, ignores the direction uniform. The Render Advanced service creates and manages a nap::CubeDepthRenderTarget and nap::DepthRenderTextureCube for rendering this light's shadow maps.

Inheritance diagram for PointLightComponentInstance:

Collaboration diagram for PointLightComponentInstance:

Constructor & Destructor Documentation

PointLightComponentInstance()

PointLightComponentInstance	(	EntityInstance &	entity,
		Component &	resource
	)

Member Function Documentation

getAttenuation()

float getAttenuation

(

)

const

The rate at which light intensity is lost over distance from the origin

Returns

light attenuation

getLightType()

virtual ELightType getLightType ( ) const

overridevirtual

Returns

the light type

Implements LightComponentInstance.

getShadowMapType()

virtual EShadowMapType getShadowMapType ( ) const

overridevirtual

Returns

the shadow map type

Implements LightComponentInstance.

init()

virtual bool init ( utility::ErrorState &  errorState )

overridevirtual

Initialize LightComponentInstance based on the LightComponent resource

Parameters

errorState

should hold the error message when initialization fails

Returns

if the LightComponentInstance is initialized successfully

Reimplemented from LightComponentInstance.

setAttenuation()

void setAttenuation

(

float

attenuation

)

Set the rate at which light intensity is lost over distance from the origin

Parameters

attenuation

light attenuation

Member Data Documentation

mAttenuation

float mAttenuation = 0.1f