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
Внимание! Эта версия документация УСТАРЕЛА, поскольку относится к более ранней версии SDK! Пожалуйста, переключитесь на самую актуальную документацию для последней версии SDK.
Внимание! Эта версия документации описывает устаревшую версию SDK, которая больше не поддерживается! Пожалуйста, обновитесь до последней версии SDK.

ObjectVolumeOmni Class

This class is used to create a volume omni object. It simulates a visible volume of light emitted from a flat light source.

The volume omni object is rendered as a flat rectangle and billboards around its edges. The rectangle simulates a light emitting surface and billboards create a light volume around it.

ObjectVolumeOmni Class

This class inherits from Object

Members


ObjectVolumeOmni (float width, float height, float radius)

Constructor. Creates a new volume omni object with given properties.

Arguments

  • float width - Width of the central rectangle in units.
  • float height - Height of the central rectangle in units.
  • float radius - Size of billboards in units.

float getAttenuation ()

Returns attenuation that modulates smooth fading of the volume omni object when the camera looks at it from a side.

Return value

Attenuation factor.

float getHeight ()

Returns the height of the central rectangle in units.

Return value

Height of the central rectangle in units.

float getRadius ()

Returns the size of billboards.

Return value

Radius in units. If a negative value is provided, 0 will be used instead.

float getWidth ()

Returns the width of the central rectangle.

Return value

Width of the central rectangle in units.

void setAttenuation (float attenuation)

Sets attenuation that contols how fast the volume omni object fades out when a camera looks at it from a side.

Arguments

  • float attenuation - An attenuation factor. If a too small value is provided, 1E-6 will be used instead.

void setRadius (float radius)

Sets the width of billboards at the edges.

Arguments

  • float radius - A new width in units. If a negative value is provided, 0 will be used instead.

void setSize (float width, float height)

Sets new dimensions of the volume omni object.

Arguments

  • float width - New width of the central rectangle in units. If a negative value is provided, 0 will be used instead.
  • float height - New height of the central rectangle in units. If a negative value is provided, 0 will be used instead.
Last update: 03.07.2017
Build: ()