Inviwo 0.9.12-pre
Inviwo documentation
Loading...
Searching...
No Matches
inviwo::SpotLight Class Reference
Inheritance diagram for inviwo::SpotLight:

Public Member Functions

virtual SpotLightclone () 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
virtual Document getInfo () const override
Public Member Functions inherited from inviwo::LightSource
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 const AxisgetAxis (size_t) const override
Public Member Functions inherited from inviwo::SpatialEntity
 SpatialEntity (const glm::mat4 &modelMatrix)
 SpatialEntity (const glm::mat4 &modelMatrix, const glm::mat4 &worldMatrix)
 SpatialEntity (const SpatialEntity &rhs)
SpatialEntityoperator= (const SpatialEntity &that)
glm::vec3 getOffset () const
void setOffset (const glm::vec3 &offset)
glm::mat3 getBasis () const
void setBasis (const glm::mat3 &basis)
glm::mat4 getModelMatrix () const
void setModelMatrix (const glm::mat4 &modelMatrix)
glm::mat4 getWorldMatrix () const
void setWorldMatrix (const glm::mat4 &worldMatrix)
virtual const SpatialCoordinateTransformergetCoordinateTransformer () const
virtual const SpatialCameraCoordinateTransformergetCoordinateTransformer (const Camera &camera) const

Protected Attributes

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

Additional Inherited Members

Static Public Attributes inherited from inviwo::LightSource
static constexpr uvec3 colorCode {128, 64, 196}
static constexpr std::string_view classIdentifier {"org.inviwo.LightSource"}
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
angleFall 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
angleCone radius angle of the light source.

◆ setDirection()

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

Set normalized direction of light source.

Parameters
directionNormalized direction of light source.

◆ setPosition()

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

Set world position of light source.

Parameters
positionWorld position of light source.

The documentation for this class was generated from the following file:
  • spotlight.h