light_properties.h File Reference

Functions

string getTypeName () const
 Gets the value of TypeNameProperty. More...
 
void setTypeName (string value)
 Sets the value of TypeNameProperty. More...
 
bool isEnabled () const
 Gets the value of EnabledProperty. More...
 
void setEnabled (bool value)
 Sets the value of EnabledProperty. More...
 
float getColorScale () const
 Gets the value of ColorScaleProperty. More...
 
void setColorScale (float value)
 Sets the value of ColorScaleProperty. More...
 
ColorRGBA getDirectionalLightColor () const
 Gets the value of DirectionalLightColorProperty. More...
 
void setDirectionalLightColor (ColorRGBA value)
 Sets the value of DirectionalLightColorProperty. More...
 
Vector3 getDirectionalLightDirection () const
 Gets the value of DirectionalLightDirectionProperty. More...
 
ColorRGBA getPointLightColor () const
 Gets the value of PointLightColorProperty. More...
 
void setPointLightColor (ColorRGBA value)
 Sets the value of PointLightColorProperty. More...
 
Vector3 getPointLightAttenuation () const
 Gets the value of PointLightAttenuationProperty. More...
 
void setPointLightAttenuation (Vector3 value)
 Sets the value of PointLightAttenuationProperty. More...
 
Vector3 getPointLightPosition () const
 Gets the value of PointLightPositionProperty. More...
 
float getPointLightRadius () const
 Gets the value of PointLightRadiusProperty. More...
 
void setPointLightRadius (float value)
 Sets the value of PointLightRadiusProperty. More...
 
ColorRGBA getSpotLightColor () const
 Gets the value of SpotLightColorProperty. More...
 
void setSpotLightColor (ColorRGBA value)
 Sets the value of SpotLightColorProperty. More...
 
Vector3 getSpotLightAttenuation () const
 Gets the value of SpotLightAttenuationProperty. More...
 
void setSpotLightAttenuation (Vector3 value)
 Sets the value of SpotLightAttenuationProperty. More...
 
float getSpotLightCutoffAngle () const
 Gets the value of SpotLightCutoffAngleProperty. More...
 
void setSpotLightCutoffAngle (float value)
 Sets the value of SpotLightCutoffAngleProperty. More...
 
float getSpotLightInnerAngle () const
 Gets the value of SpotLightInnerAngleProperty. More...
 
void setSpotLightInnerAngle (float value)
 Sets the value of SpotLightInnerAngleProperty. More...
 
Vector3 getSpotLightDirection () const
 Gets the value of SpotLightDirectionProperty. More...
 
float getSpotLightExponent () const
 Gets the value of SpotLightExponentProperty. More...
 
void setSpotLightExponent (float value)
 Sets the value of SpotLightExponentProperty. More...
 
Vector3 getSpotLightPosition () const
 Gets the value of SpotLightPositionProperty. More...
 

Variables

static PropertyType< string > TypeNameProperty
 TypeName property. More...
 
static PropertyType< bool > EnabledProperty
 Enabled property. More...
 
static PropertyType< float > ColorScaleProperty
 ColorScale property. More...
 
static PropertyType< ColorRGBA > DirectionalLightColorProperty
 DirectionalLightColor property. More...
 
static PropertyType< Vector3 > DirectionalLightDirectionProperty
 DirectionalLightDirection property. More...
 
static PropertyType< ColorRGBA > PointLightColorProperty
 PointLightColor property. More...
 
static PropertyType< Vector3 > PointLightAttenuationProperty
 PointLightAttenuation property. More...
 
static PropertyType< Vector3 > PointLightPositionProperty
 PointLightPosition property. More...
 
static PropertyType< float > PointLightRadiusProperty
 PointLightRadius property. More...
 
static PropertyType< ColorRGBA > SpotLightColorProperty
 SpotLightColor property. More...
 
static PropertyType< Vector3 > SpotLightAttenuationProperty
 SpotLightAttenuation property. More...
 
static PropertyType< float > SpotLightCutoffAngleProperty
 SpotLightCutoffAngle property. More...
 
static PropertyType< float > SpotLightInnerAngleProperty
 SpotLightInnerAngle property. More...
 
static PropertyType< Vector3 > SpotLightDirectionProperty
 SpotLightDirection property. More...
 
static PropertyType< float > SpotLightExponentProperty
 SpotLightExponent property. More...
 
static PropertyType< Vector3 > SpotLightPositionProperty
 SpotLightPosition property. More...
 

Function Documentation

string getTypeName ( ) const

Gets the value of TypeNameProperty.

See also
setTypeName()
void setTypeName ( string  value)

Sets the value of TypeNameProperty.

See also
getTypeName()
bool isEnabled ( ) const

Gets the value of EnabledProperty.

See also
setEnabled()
void setEnabled ( bool  value)

Sets the value of EnabledProperty.

See also
isEnabled()
float getColorScale ( ) const

Gets the value of ColorScaleProperty.

See also
setColorScale()
void setColorScale ( float  value)

Sets the value of ColorScaleProperty.

See also
getColorScale()
ColorRGBA getDirectionalLightColor ( ) const
void setDirectionalLightColor ( ColorRGBA  value)
Vector3 getDirectionalLightDirection ( ) const

Gets the value of DirectionalLightDirectionProperty.

See also
setDirectionalLightDirection()
ColorRGBA getPointLightColor ( ) const

Gets the value of PointLightColorProperty.

See also
setPointLightColor()
void setPointLightColor ( ColorRGBA  value)

Sets the value of PointLightColorProperty.

See also
getPointLightColor()
Vector3 getPointLightAttenuation ( ) const
void setPointLightAttenuation ( Vector3  value)
Vector3 getPointLightPosition ( ) const

Gets the value of PointLightPositionProperty.

See also
setPointLightPosition()
float getPointLightRadius ( ) const

Gets the value of PointLightRadiusProperty.

See also
setPointLightRadius()
void setPointLightRadius ( float  value)

Sets the value of PointLightRadiusProperty.

See also
getPointLightRadius()
ColorRGBA getSpotLightColor ( ) const

Gets the value of SpotLightColorProperty.

See also
setSpotLightColor()
void setSpotLightColor ( ColorRGBA  value)

Sets the value of SpotLightColorProperty.

See also
getSpotLightColor()
Vector3 getSpotLightAttenuation ( ) const
void setSpotLightAttenuation ( Vector3  value)
float getSpotLightCutoffAngle ( ) const
void setSpotLightCutoffAngle ( float  value)
float getSpotLightInnerAngle ( ) const
void setSpotLightInnerAngle ( float  value)
Vector3 getSpotLightDirection ( ) const

Gets the value of SpotLightDirectionProperty.

See also
setSpotLightDirection()
float getSpotLightExponent ( ) const
void setSpotLightExponent ( float  value)
Vector3 getSpotLightPosition ( ) const

Gets the value of SpotLightPositionProperty.

See also
setSpotLightPosition()

Variable Documentation

PropertyType<string> TypeNameProperty
static

TypeName property.

The default value is "DirectionalLight".

See also
setTypeName(), getTypeName()
PropertyType<bool> EnabledProperty
static

Enabled property.

Whether the light is switched on or off. The light affects rendering only when the value is set to true. The default value is true.

See also
setEnabled(), isEnabled()
PropertyType<float> ColorScaleProperty
static

ColorScale property.

Scales light color. The default value is 1.0f.

See also
setColorScale(), getColorScale()
PropertyType<ColorRGBA> DirectionalLightColorProperty
static

DirectionalLightColor property.

Defines the color of a directional light. The default value is ColorRGBA(0.4980392f, 0.4980392f, 0.4980392f, 1.0f).

See also
setDirectionalLightColor(), getDirectionalLightColor()
PropertyType<Vector3> DirectionalLightDirectionProperty
static

DirectionalLightDirection property.

Contains the direction vector of a directional light. Calculated automatically from a directional light's world transformation. The default value is Vector3(0.0f, 0.0f, 0.0f).

See also
setDirectionalLightDirection(), getDirectionalLightDirection()
PropertyType<ColorRGBA> PointLightColorProperty
static

PointLightColor property.

Defines the color of a point light. The default value is ColorRGBA(0.4980392f, 0.4980392f, 0.4980392f, 1.0f).

See also
setPointLightColor(), getPointLightColor()
PropertyType<Vector3> PointLightAttenuationProperty
static

PointLightAttenuation property.

Defines the effect of a point light on objects that are farther away. Define the attenuation value of a point light by setting constant, linear, and quadratic coefficients. The default value is Vector3(1.0f, 0.0f, 0.0f).

See also
setPointLightAttenuation(), getPointLightAttenuation()
PropertyType<Vector3> PointLightPositionProperty
static

PointLightPosition property.

Contains the position vector of a point light. Calculated automatically from a point light's world transformation. The default value is Vector3(0.0f, 0.0f, 0.0f).

See also
setPointLightPosition(), getPointLightPosition()
PropertyType<float> PointLightRadiusProperty
static

PointLightRadius property.

Sphere light radius. The default value is 0.0f.

See also
setPointLightRadius(), getPointLightRadius()
PropertyType<ColorRGBA> SpotLightColorProperty
static

SpotLightColor property.

Defines the color of a spot light. The default value is ColorRGBA(0.4980392f, 0.4980392f, 0.4980392f, 1.0f).

See also
setSpotLightColor(), getSpotLightColor()
PropertyType<Vector3> SpotLightAttenuationProperty
static

SpotLightAttenuation property.

Defines the effect of a spot light on objects that are farther away. Define the attenuation value of a spot light by setting constant, linear, and quadratic coefficients. The default value is Vector3(1.0f, 0.0f, 0.0f).

See also
setSpotLightAttenuation(), getSpotLightAttenuation()
PropertyType<float> SpotLightCutoffAngleProperty
static

SpotLightCutoffAngle property.

Defines the angle of the light cone in degrees. The default value is 90.0f.

See also
setSpotLightCutoffAngle(), getSpotLightCutoffAngle()
PropertyType<float> SpotLightInnerAngleProperty
static

SpotLightInnerAngle property.

Defines the inner angle of the light cone in degrees. The default value is 80.0f.

See also
setSpotLightInnerAngle(), getSpotLightInnerAngle()
PropertyType<Vector3> SpotLightDirectionProperty
static

SpotLightDirection property.

Contains the direction vector of a spot light. Calculated automatically from a spot light's world transformation. The default value is Vector3(0.0f, 0.0f, 0.0f).

See also
setSpotLightDirection(), getSpotLightDirection()
PropertyType<float> SpotLightExponentProperty
static

SpotLightExponent property.

Defines how fast a fully lit area at the center of the light cone turns into an unlit area. The default value is 1.0f.

See also
setSpotLightExponent(), getSpotLightExponent()
PropertyType<Vector3> SpotLightPositionProperty
static

SpotLightPosition property.

Contains the position vector of a spot light. Calculated automatically from a spot light's world transformation. The default value is Vector3(0.0f, 0.0f, 0.0f).

See also
setSpotLightPosition(), getSpotLightPosition()