This page has been translated automatically.
UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Migration
Migrating to UNIGINE 2.0
C++ API Migration
Migrating from UNIGINE 2.0 to UNIGINE 2.1
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Unigine::LightProj Class

Interface for light omni handling.

To use this class, include the UnigineLightProj.h file.

Unigine::LightProj Class

Members


static int type ()

LightProj type.

Return value

LightProj type identifier.

static Ptr< LightProj > create (const NodePtr & node)

LightProj constructor.

Arguments

  • const NodePtr & node - Node smart pointer.

static Ptr< LightProj > create (const LightPtr & light)

LightProj constructor.

Arguments

  • const LightPtr & light - Light smart pointer.

static Ptr< LightProj > create (const vec4 & color, float radius, float fov, const char * name)

LightProj constructor.

Arguments

  • const vec4 & color - Light color.
  • float radius - Light radius.
  • float fov - Field of view.
  • const char * name - Light image texture name.

virtual void setRadius (float radius) const =0

Sets a light radius.

Arguments

  • float radius - Light radius.

virtual float getRadius () const =0

Returns a light radius.

Return value

Light radius.

virtual void setFov (float fov) const =0

Sets the light field of view.

Arguments

  • float fov - Field of view.

virtual float getFov () const =0

Returns the light field of view.

Return value

Light field of view.

virtual void setZNear (float znear) const =0

Sets a light near clipping plane.

Arguments

  • float znear - Light near clipping plane.

virtual float getZNear () const =0

Returns a light near clipping plane.

Return value

Light near clipping plane.

virtual void setImageTextureName (const char * name) const =0

Sets a light image texture name.

Arguments

  • const char * name - Light image texture name.

virtual const char * getImageTextureName () const =0

Returns a light image texture name.

Return value

Light image texture name.

virtual int setImageTextureImage (const ImagePtr & image, int dynamic) const =0

Sets a light image texture image.

Arguments

  • const ImagePtr & image - Image smart pointer.
  • int dynamic - Dynamic texture flag.

Return value

Returns 1 if the operation was a success; otherwise, 0 is returned.

virtual int getImageTextureImage (const ImagePtr & image) const =0

Gets a light image texture image.

Arguments

  • const ImagePtr & image - Image smart pointer.

Return value

Returns 1 if the operation was a success; otherwise, 0 is returned.

virtual void setImageTexture (const TexturePtr & texture) const =0

Sets the light image texture smart pointer.

Arguments

  • const TexturePtr & texture - Texture smart pointer.

virtual TexturePtr getImageTexture (num) const =0

Gets a light image texture smart pointer.

Arguments

  • num - Texture number.

Return value

Returns image texture smart pointer.
Last update: 2017-07-03
Build: ()