IG::ICollisionVolume Class
| Header: | #include <plugins/IGInterface.h> |
This class is used to manage collision volumes that are assigned to entities and used for collision detection.
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.
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.
ICollisionVolume Class
Members
int getID( )
Returns the ID of the collision volume.Return value
Collision volume ID.IEntity * getEntity( )
Returns the entity to which the collision volume is assigned.Return value
Entity to which the collision volume is assigned.void setEnable( int value )
Enables or disables the collision volume.Arguments
- int value - 1 to enable the collision volume; 0 - to disable it.
int isEnable( )
Returns a value indicating if the collision volume is enabled.Return value
1 if the collision volume is enabled; otherwise, 0void 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( )
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 IConverter::eulerNEDToRotation() method.Arguments
- const quat & value - Quaternion defining rotation of the cuboid-shaped collision volume.
quat getRotation( )
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 IConverter::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( 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./// callback function to be called when a collision with the collision volume is detected
void my_collision_callback()
{
// your code
}
// ...
// somwhere in code
void SomeClass::init()
{
// adding "my_collision_callback" to be called when a collision with the volume is detected
ig_manager->getEntity(entity_id)->getCollisionVolume(volume_id)->setCollisionDetectedCallback(Unigine::MakeCallback( my_collision_callback );
}Arguments
- CallbackBase * func - Callback pointer.