LightOmni Class

#include <UnigineLights.h>
using namespace Unigine;

/* .. */

// creating an omni light source and setting its color to white, attenuation distance to 10 units
LightOmniPtr light_omni = LightOmni::create(Math::vec4(1.0f, 1.0f, 1.0f, 1.0f), 10.0f, "");

// setting the name of the light source
light_omni->setName("omni");

// setting position of the light source
light_omni->setWorldPosition(Math::Vec3(0.0f, 0.0f, 5.0f));

// setting a texture named "mytexture.tga" for light modulation
projector->setTextureFilePath("mytexture.tga");

// setting light intensity
light_omni->setIntensity(0.1f);

LightOmni Class

Members

void setAttenuationDistance ( float distance ) #

Arguments

• float distance - The distance from the light source shape, at which the light source doesn't illuminate anything.

float getAttenuationDistance() const#

Return value

Current distance from the light source shape, at which the light source doesn't illuminate anything.

Math::vec2 getShadowDepthRange() const#

Return value

Current shadow depth range for the light source as a two-component vector (min, max).

void setShapeType ( Light::SHAPE type ) #

Arguments

• Light::SHAPE type - The shape of the light source (one of the SHAPE_* variables).

Light::SHAPE getShapeType() const#

Return value

Current shape of the light source (one of the SHAPE_* variables).

void setShapeHeight ( float height ) #

Arguments

• float height - The height of the light source shape.

float getShapeHeight() const#

Return value

Current height of the light source shape.

void setShapeLength ( float length ) #

Arguments

• float length - The length of the light source shape.

float getShapeLength() const#

Return value

Current length of the light source shape.

void setShapeRadius ( float radius ) #

Arguments

• float radius - The radius of the light source shape.

float getShapeRadius() const#

Return value

Current radius of the light source shape.

Math::vec3 getSize() const#

Return value

Current size of the illuminated area.

void setTexture ( const const Ptr<Texture> && texture ) #

Arguments

• const const Ptr<Texture> && texture - The texture smart pointer.

const Ptr<Texture> & getTexture() const#

Return value

Current texture smart pointer.

void setTextureFilePath ( const char * path ) #

Arguments

• const char * path - The cubemap texture file path.

const char * getTextureFilePath() const#

Return value

Current cubemap texture file path.

void setShadowNearClippingDistance ( float distance ) #

Arguments

• float distance - The distance from the light source shape, within which the object doesn't cast shadow under this light source.

float getShadowNearClippingDistance() const#

Return value

Current distance from the light source shape, within which the object doesn't cast shadow under this light source.

void setNearAttenuationGradientLength ( float length ) #

Arguments

• float length - The length of the gradient area smoothering the attenuation border near the light source.

float getNearAttenuationGradientLength() const#

Return value

Current length of the gradient area smoothering the attenuation border near the light source.

void setNearAttenuationDistance ( float distance ) #

Arguments

• float distance - The distance from the light source shape, within which the light source doesn't illuminate anything.

float getNearAttenuationDistance() const#

Return value

Current distance from the light source shape, within which the light source doesn't illuminate anything.

---

static LightOmniPtr create ( const Math::vec4 & color, float attenuation_distance, const char * name = 0 ) #

Constructor. Creates a new omni light source with the given parameters.

Arguments

• const Math::vec4 & color - Color of the new light source.
• float attenuation_distance - Attenuation distance
• const char * name - Name of the source.

int setTextureImage ( const Ptr<Image> & image, bool dynamic = 0 ) #

Sets a given Image instance as the light image texture. If you need to set a texture of all the lights in the scene, set dynamic flag to 1.

Arguments

• const Ptr<Image> & image - New texture to set.
• bool dynamic - Dynamic texture flag.
  • If set to 0, changing a texture of the light instance will also affect all the lights in the scene.
  • If set to 1, an image will be successfully set only for the current light instance.

Return value

Returns 1 if the texture is set successfully; otherwise, 0.

int getTextureImage ( const Ptr<Image> & image ) const#

Reads the light image texture into an Image instance.

Arguments

• const Ptr<Image> & image - Image, into which the texture is read.

Return value

Returns 1 if the texture is read successfully; otherwise, 0.

void setShadowSideEnabled ( int side, int enable ) #

Enables or disables shadows for the specified side of the omni light source's cube map. By default the light source casts shadows in all directions.

Arguments

• int side - Number of the side of the omni light source for which shadows are to be enabled or disabled. One of the following values:
  • 0 - positive X
  • 1 - negative X
  • 2 - positive Y
  • 3 - negative Y
  • 4 - positive Z
  • 5 - negative Z
• int enable - 1 to enable shadows for the specified side of the omni light source, 0 - to disable.

int isShadowSideEnabled ( int side ) const#

Returns a value indicating if shadows are to be cast for the specified side of the omni light source. By default the light source casts shadows in all directions.

Arguments

• int side - Number of the side of the omni light source for which shadows are to be enabled or disabled. One of the following values:
  • 0 - positive X
  • 1 - negative X
  • 2 - positive Y
  • 3 - negative Y
  • 4 - positive Z
  • 5 - negative Z

Return value

1 if shadows are to be cast for the specified side of the omni light source; otherwise, 0.

static int type ( ) #

Returns the type of the node.

Return value

Light type identifier.