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::ObjectVolumeOmni Class

Interface for object volumeomni handling. See also the UnigineScript analog. 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.

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

Unigine::ObjectVolumeOmni Class

Members


static int type ()

ObjectVolumeOmni type.

Return value

ObjectVolumeOmni type identifier.

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

ObjectVolumeOmni constructor.

Arguments

  • const NodePtr & node - Node smart pointer.

static Ptr< ObjectVolumeOmni > create (const ObjectPtr & object)

ObjectVolumeOmni constructor.

Arguments

  • const ObjectPtr & object - Object smart pointer.

static Ptr< ObjectVolumeOmni > create (float width, float height, float radius)

ObjectVolumeOmni constructor. The volume omni object is rendered as a flat rectangle and billboards around its edges.

Arguments

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

virtual void setSize (float width, float height) const =0

Sets new dimensions of the volume omni object.

Arguments

  • float width - A new width of the central flat rectangle in units. If a negative value is provided, 0 will be used instead.
  • float height - A new height of the central flat rectangle in units. If a negative value is provided, 0 will be used instead.

virtual float getWidth () const =0

Returns the width of the central flat rectangle.

Return value

The width of the central rectangle in units.

virtual float getHeight () const =0

Returns the height of the central flat rectangle in units.

Return value

The height of the central rectangle in units.

virtual void setRadius (float radius) const =0

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.

virtual float getRadius () const =0

Returns the size of billboards.

Return value

The size of billboards in units.

virtual void setAttenuation (float attenuation) const =0

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

Arguments

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

virtual float getAttenuation () const =0

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

Return value

The current attenuation factor.
Last update: 2017-07-03
Build: ()