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
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Content Creation
Materials
Unigine Material Library
Tutorials
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::LightOmni Class

Interface for light omni handling.

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

Unigine::LightOmni Class

Members


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

LightOmni constructor.

Arguments

  • const NodePtr & node - Node smart pointer.

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

LightOmni constructor.

Arguments

  • const LightPtr & light - Light smart pointer.

static Ptr< LightOmni > create (const vec4 & color, const vec3 & radius, const char * name)

LightOmni constructor.

Arguments

  • const vec4 & color - Light color.
  • const vec3 & radius - Light radius.
  • const char * name - Light image texture name.

virtual void setRadius (const vec3 & radius) const =0

Sets a light radius.

Arguments

  • const vec3 & radius - Light radius.

virtual vec3 getRadius () const =0

Returns a light radius.

Return value

Light radius.

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.

virtual void setShadowMask (int mask) const =0

Sets a light shadow mask.

Arguments

  • int mask - Light shadow mask.

virtual int getShadowMask () const =0

Returns a light shadow mask.

Return value

Light shadow mask.
Last update: 2017-07-03
Build: ()