This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Basics
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
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
Animations-Related Classes
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
VR-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Unigine::ObjectVolumeSphere Class

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

This class is used to create a volume sphere. Depending on the assigned material, it can be used to render fog or a visible volume of light around a light source. A volume sphere can also be of an ellipsoid shape.

See Also#

A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/objects/ folder:

  • volumes_01
  • volumes_02

ObjectVolumeSphere Class

Members


static ObjectVolumeSpherePtr create ( const Math::vec3 & radius ) #

Constructor. Creates a new volume sphere object with given radius values.
Notice
If a volume light material is assigned to an object, it is rendered based only on the X-axis radius value. If its radius values along Y or Z axes are smaller, then the object is cut along them.

Arguments

  • const Math::vec3 & radius - Radius values of the new volume sphere object in units. If a negative value is provided, 0 will be used instead.

void setRadius ( const Math::vec3 & radius ) #

Updates volume sphere radius values. If a volume light material is assigned to an object, it is rendered based only on the radius value along the X axis. If its radius values along the Y or Z axes are smaller than along the X axis, the object is cut along them.

Arguments

  • const Math::vec3 & radius - New radius values of the volume sphere in units. If a negative value is provided, 0 will be used instead.

Math::vec3 getRadius ( ) const#

Returns the volume sphere radius values.

Return value

The radius values of the volume sphere in units.

static int type ( ) #

Returns the type of the node.

Return value

Object type identifier.
Last update: 2024-08-16
Build: ()