This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
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::ObjectVolumeOmni Class

Header: #include <UnigineObjects.h>
Inherits from: Object

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.

See Also#

A UnigineScript API sample <UnigineSDK>/data/samples/objects/volumes_03

ObjectVolumeOmni Class

Members


static ObjectVolumeOmniPtr create ( 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.

void setAttenuation ( float attenuation ) #

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.

float getAttenuation ( ) const#

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.

float getHeight ( ) const#

Returns the height of the central flat rectangle in units.

Return value

The height of the central rectangle in units.

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.

float getRadius ( ) const#

Returns the size of billboards.

Return value

The size of billboards in units.

void setSize ( float width, float height ) #

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.

float getWidth ( ) const#

Returns the width of the central flat rectangle.

Return value

The width of the central rectangle in units.

static int type ( ) #

Returns the type of the node.

Return value

Object type identifier.
Last update: 2022-12-14
Build: ()