This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
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
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
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG 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.

CigiVolumeDef Class

Warning
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to Sim SDK edition to use it.
Header: #include <plugins/UnigineCIGIConnector.h>
Inherits from: CigiHostPacket

CigiVolumeDef Class

Members


int getEntityID ( ) const#

Returns the entity ID specified in the packet.

Return value

Entity ID.

int getVolumeID ( ) const#

Returns the volume ID specified in the packet.

Return value

Volume ID.

int getVolumeEnabled ( ) const#

Returns the value of the Volume Enable parameter specified in the packet.

Return value

Volume Enable parameter value: 1 - the volume will be considered during collision testing; otherwise, 0.

int getVolumeType ( ) const#

Returns the value of the Volume Type parameter specified in the packet.

Return value

Volume Type parameter value. The following values are supported:
  • 0 - Sphere
  • 1 - Cuboid

Math::vec3 getCenter ( ) const#

Returns the coordinates of the offset of the center of the collision volume specified in the packet.

Return value

Offset of the center of the collision volume.
Notice
Measured with respect to the coordinate system of the entity specified by the Entity ID parameter

Math::vec3 getSize ( ) const#

Returns the size of the collision volume specified in the packet.

Return value

Sizes of the collision volume: (height, width, depth).
Notice
For spherical volumes only the first component of the vector is considered - it is interpreted as radius.

Math::vec3 getRotation ( ) const#

Returns the rotation euler angles of the collision volume specified in the packet.

Return value

Collision volume rotation euler angles (roll, pitch, yaw).

float getRadius ( ) const#

Returns the radius of the spherical collision volume specified in the packet.

Return value

Collision volume radius.
Last update: 2021-12-13
Build: ()