inviwo::SpotLight Class Reference

Inheritance diagram for inviwo::SpotLight:

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

Protected Attributes
float	coneFallOffAngle_ {1.0f}
float	coneRadiusAngle_ {1.0f}
vec3	direction_ {1.0f, 0.0f, 0.0f}
vec3	position_ {0.0f}
Protected Attributes inherited from inviwo::LightSource
bool	enabled_
float	fieldOfView_
vec3	intensity_
vec2	size_
Protected Attributes inherited from inviwo::SpatialEntity
std::unique_ptr< SpatialCameraCoordinateTransformer >	cameraTransformer_
glm::mat4	modelMatrix_
std::unique_ptr< SpatialCoordinateTransformer >	transformer_
glm::mat4	worldMatrix_

Additional Inherited Members
Static Public Attributes inherited from inviwo::LightSource
static constexpr std::string_view	classIdentifier {"org.inviwo.LightSource"}
static constexpr uvec3	colorCode {128, 64, 196}
static constexpr std::string_view	dataName {"LightSource"}

Member Function Documentation

clone()

virtual SpotLight * inviwo::SpotLight::clone ( ) const

overridevirtual

Implements inviwo::SpatialEntity.

getArea()

virtual float inviwo::SpotLight::getArea ( ) const

inlineoverridevirtual

Implements inviwo::LightSource.

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.

getInfo()

virtual Document inviwo::SpotLight::getInfo ( ) const

overridevirtual

Reimplemented from inviwo::LightSource.

getLightSourceType()

LightSourceType inviwo::SpotLight::getLightSourceType ( ) const

inlineoverridevirtual

Implements inviwo::LightSource.

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:

• include/inviwo/core/datastructures/light/spotlight.h