inviwo::SpotLight Class Reference

Inheritance diagram for inviwo::SpotLight:

Public Member Functions
virtual SpotLight *	clone () const override
virtual float	getArea () const override
virtual vec3	getPower () const override
LightSourceType	getLightSourceType () const override
vec3	getPosition () const
void	setPosition (const vec3 &position)
const vec3 &	getDirection () const
void	setDirection (const vec3 &direction)
const float &	getConeRadiusAngle () const
void	setConeRadiusAngle (const float &angle)
const float &	getConeFallOffAngle () const
void	setConeFallOffAngle (const float &angle)
float	getFullVisbilityValue () const
float	getPartialVisbilityValue () const
Public Member Functions inherited from inviwo::LightSource
const vec3	getIntensity () const
void	setIntensity (const vec3 &intensity)
float	getFieldOfView () const
void	setFieldOfView (float FOVInRadians)
const vec2 &	getSize () const
void	setSize (const vec2 &newSize)
bool	isEnabled () const
void	setEnabled (bool enable)
virtual Document	getInfo () const
Public Member Functions inherited from inviwo::SpatialEntity< 3 >
	SpatialEntity (const SpatialEntity< N > &rhs)
	SpatialEntity (const Matrix< N+1, float > &modelMatrix)
	SpatialEntity (const Matrix< N+1, float > &modelMatrix, const Matrix< N+1, float > &worldMatrix)
SpatialEntity< N > &	operator= (const SpatialEntity< N > &that)
Vector< N, float >	getOffset () const
void	setOffset (const Vector< N, float > &offset)
Matrix< N, float >	getBasis () const
void	setBasis (const Matrix< N, float > &basis)
Matrix< N+1, float >	getModelMatrix () const
void	setModelMatrix (const Matrix< N+1, float > &modelMatrix)
Matrix< N+1, float >	getWorldMatrix () const
void	setWorldMatrix (const Matrix< N+1, float > &worldMatrix)
virtual const SpatialCoordinateTransformer< N > &	getCoordinateTransformer () const
virtual const SpatialCameraCoordinateTransformer< N > &	getCoordinateTransformer (const CameraND< N > &camera) const

Protected Attributes
vec3	position_
vec3	direction_
float	coneRadiusAngle_
float	coneFallOffAngle_
Protected Attributes inherited from inviwo::LightSource
vec3	intensity_
float	fieldOfView_
vec2	size_
bool	enabled_
Protected Attributes inherited from inviwo::SpatialEntity< 3 >
SpatialCoordinateTransformer< N > *	transformer_
SpatialCameraCoordinateTransformer< N > *	cameraTransformer_
Matrix< N+1, float >	modelMatrix_
Matrix< N+1, float >	worldMatrix_

Additional Inherited Members
Static Public Attributes inherited from inviwo::LightSource
static const uvec3	colorCode = uvec3(128, 64, 196)
static const std::string	classIdentifier = "org.inviwo.LightSource"
static const std::string	dataName = "LightSource"

Member Function Documentation

getConeFallOffAngle()

const float& inviwo::SpotLight::getConeFallOffAngle ( ) const

inline

Get fall off angle of the light source.

Returns

Fall off angle of the light source.

getConeRadiusAngle()

const float& inviwo::SpotLight::getConeRadiusAngle ( ) const

inline

Get cone radius angle of the light source.

Returns

Cone radius angle of the light source.

getDirection()

const vec3& inviwo::SpotLight::getDirection ( ) const

inline

Get normalized general direction of light source.

Returns

Normalized direction of light source.

getFullVisbilityValue()

float inviwo::SpotLight::getFullVisbilityValue ( ) const

inline

Get value for checking full visibility (inside cone angle) against the light source.

Returns

Value for checking full visibility (inside cone angle against the light source.

getPartialVisbilityValue()

float inviwo::SpotLight::getPartialVisbilityValue ( ) const

inline

Get value for checking partial visibility (inside cone + falloff angle) against the light source.

Returns

Value for checking partial visibility (inside cone + falloff angle) against the light source.

getPosition()

vec3 inviwo::SpotLight::getPosition ( ) const

inline

Get world position of light source.

Returns

World position of light source.

getPower()

virtual vec3 inviwo::SpotLight::getPower ( ) const

inlineoverridevirtual

Get radiant flux (color) of light source.

See also

setPower

Returns

Radiant flux in watt.

Implements inviwo::LightSource.

setConeFallOffAngle()

void inviwo::SpotLight::setConeFallOffAngle ( const float &  angle )

inline

Set the fall off angle of the light source.

Parameters

angle

Fall off angle of the light source.

setConeRadiusAngle()

void inviwo::SpotLight::setConeRadiusAngle ( const float &  angle )

inline

Set the cone radius angle of the light source.

Parameters

angle

Cone radius angle of the light source.

setDirection()

void inviwo::SpotLight::setDirection ( const vec3 &  direction )

inline

Set normalized direction of light source.

Parameters

direction

Normalized direction of light source.

setPosition()

void inviwo::SpotLight::setPosition ( const vec3 &  position )

inline

Set world position of light source.

Parameters

position

World position of light source.

---

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

• spotlight.h