Unigine::Plugins::IG::CollisionVolume 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/UnigineIG.h>

This class is used to manage collision volumes that are assigned to entities and used for collision detection.

Notice

IG plugin must be loaded.

A collision detection volume is a sphere or a cuboid through which collision testing is performed by the IG. When a collision detection volume passes through another collision volume, the IG registers a collision by sending the corresponding notification.

Notice

Collision detection testing is performed by the IG every frame.

A volume is defined by specifying its location, size, and orientation with respect to the associated entity’s body coordinate system. A sphere’s size is specified as a radius; a cuboid’s size is specified by its width, height, and depth.

Unlike collision detection segments, which are tested segment-to-polygon, collision detection volumes are tested volume-to-volume. Volumes associated with the same entity are not tested against each other.

Methods:

Name	Description View: Sort by:
getID	Returns the ID of the collision volume.
getEntity	Returns the entity to which the collision volume is assigned.
setEnable	Enables or disables the collision volume.
isEnable	Returns a value indicating if the collision volume is enabled.
setPosition	Sets the coordinates of the center of the collision volume.
getPosition	Returns the current coordinates of the center of the collision volume.
setRotation	Sets the rotation of the cuboid-shaped collision volume.
getRotation	Returns the current rotation of the cuboid-shaped collision volume.
setSize	Sets the size of the cuboid-shaped collision volume.
setRadius	Sets the radius of the spherical collision volume.
setCollisionDetectedCallback	Sets a callback on detecting a collision with the collision volume.
getName	Returns the name of the collision volume.
setName	Sets a new name for the collision volume.

CollisionVolume Class

Members

int getID ( ) const#

Returns the ID of the collision volume.

Return value

Collision volume ID.

Entity * getEntity ( ) const#

Returns the entity to which the collision volume is assigned.

Return value

Entity to which the collision volume is assigned.

void setEnable ( bool value ) #

Enables or disables the collision volume.

Arguments

bool value - true to enable the collision volume; false - to disable it.

bool isEnable ( ) const#

Returns a value indicating if the collision volume is enabled.

Return value

true if the collision volume is enabled; otherwise, false

void setPosition ( const vec3 & value ) #

Sets the coordinates of the center of the collision volume.

Arguments

const vec3 & value - Coordinates of the center of the collision volume, in the coordinate system of the entity.

vec3 getPosition ( ) const#

Returns the current coordinates of the center of the collision volume.

Return value

Current coordinates of the center of the collision volume, in the coordinate system of the entity.

void setRotation ( const quat & value ) #

Sets the rotation of the cuboid-shaped collision volume. The rotation quaternion is obtained by converting NED euler rotation (roll, pitch, yaw) to a quaternion via the Converter::eulerNEDToRotation() method.

Arguments

const quat & value - Quaternion defining rotation of the cuboid-shaped collision volume.

quat getRotation ( ) const#

Returns the current rotation of the cuboid-shaped collision volume. You can convert the obtained rotation quaternion to NED euler rotation (roll, pitch, yaw) via the Converter::rotationToEulerNED() method.

Return value

Quaternion defining rotation of the cuboid-shaped collision volume.

void setSize ( const vec3 & size ) #

Sets the size of the cuboid-shaped collision volume.

Arguments

const vec3 & size - Vector defining the size of the cuboid-shaped collision volume (depth, width, height). Each component is specified in meters.

void setRadius ( float radius ) #

Sets the radius of the spherical collision volume.

Arguments

float radius - Radius of the spherical collision volume, in meters.

void setCollisionDetectedCallback ( Unigine::CallbackBase * func ) #

Sets a callback on detecting a collision with the collision volume. This function can be used to define specific actions to be performed when a collision with the segment is detected. void(CollisionVolume *v, ContactPtr cnt, int contacted_entity, int contacted_segment)

Source code (C++)

/// callback function to be called when a collision with the collision volume is detected
void my_callback(CollisionVolume *v, ContactPtr cnt, int contacted_entity, int contacted_segment)
{
	// your code
}

// ...
// somewhere in code
void SomeClass::init()
{
	// adding "my_callback" to be called when a collision with the volume is detected
	ig_manager->getEntity(entity_id)->getCollisionVolume(volume_id)->setCollisionDetectedCallback(Unigine::MakeCallback( my_callback );
}

Arguments

Unigine::CallbackBase * func - Callback pointer.

const String & getName ( ) const#

Returns the name of the collision volume.

Return value

Collision volume name.

void setName ( const String & value ) #

Sets a new name for the collision volume.

Arguments

const String & value - Collision volume name to be set.

Last update: 2021-04-29

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)