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

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. The default is 1.

Return value

Attenuation factor.

float getHeight ()

Returns the height of the central rectangle in units. The default is 1 unit.

Return value

Height of the central rectangle in units.

float getRadius ()

Returns the size of billboards. The default is 1 unit.

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. The default is 1 unit.

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. The default is 1.

Arguments

  • float attenuation - Attenuation factor.

void setRadius (float radius)

Sets the width of billboards at the edges. The default is 1 unit.

Arguments

  • float radius - New width in units.

void setSize (float width, float height)

Sets new dimensions of the volume omni object. The default is 1 unit for width and height.

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: 2017-07-03