This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and 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
Rendering-Related Classes
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::Cigi::ICigiVolumeDef Class

Header: #include <CigiClientInterface.h>
Inherits: ICigiHostPacket
Warning
The CIGIClient plugin is deprecated and no longer supported. For more information on working with CIGI please refer to the IG Application section.

This class represents the CIGI Collision Detection Volume Definition packet interface.

Notice
CIGI plugin must be loaded.

ICigiVolumeDef Class

Members


int getEntityID( )

Returns the entity ID specified in the packet.

Return value

Entity ID.

int getVolumeID( )

Returns the volume ID specified in the packet.

Return value

Volume ID.

int getVolumeEnabled( )

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( )

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

const Math::vec3& getCenter( )

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

const Math::vec3& getSize( )

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.

const Math::vec3& getRotation( )

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

Return value

Collision volume rotation euler angles (roll, pitch, yaw).
Last update: 2020-01-14
Build: ()