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
CIGI Client Plugin
Rendering-Related Classes

IG::ICollisionSegment Class

Header: #include <plugins/IGInterface.h>

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

Notice
IG plugin must be loaded.

A collision detection segment is a line segment along which collision testing is performed by the IG. When a collision detection segment intersects a polygon, the IG registers a collision by sending the corresponding notification.

Notice
Collision detection testing is performed by the IG every frame.

The segment is defined by specifying the locations of its endpoints with respect to the associated entity’s body coordinate system. Figure below illustrates five segments defined for an aircraft.

Collision detection volumes are tested segment-to-polygon. An entity will not perform collision detection segment testing against its own geometry.

If an entity is destroyed, all collision detection segments defined for that entity will also be destroyed.

ICollisionSegment Class

Members


int getID( )

Returns the ID of the collision segment.

Return value

Collision segment ID.

IEntity * getEntity( )

Returns the entity to which the collision segment is assigned.

Return value

Entity to which the collision segment is assigned.

int isEnable( )

Returns a value indicating if the collision segment is enabled.

Return value

1 if the collision segment is enabled; otherwise, 0

void setEnable( int value )

Enables or disables the collision segment.

Arguments

  • int value - 1 to enable the collision segment; 0 - to disable it.

void setStartPoint( const vec3 & point )

Sets the coordinates of the start point of the collision segment.

Arguments

  • const vec3 & point - Coordinates of the start point of the collision segment, in the coordinate system of the entity.

const vec3 & getStartPoint( )

Returns the current coordinates of the start point of the collision segment.

Return value

Coordinates of the start point of the collision segment, in the coordinate system of the entity.

void setEndPoint( const vec3 & point )

Sets the coordinates of the end point of the collision segment.

Arguments

  • const vec3 & point - Coordinates of the end point of the collision segment, in the coordinate system of the entity.

const vec3 & getEndPoint( )

Returns the current coordinates of the end point of the collision segment.

void setMaterialMask( int mask )

Sets the material mask for the collision segment. This parameter specifies the environmental and cultural features to be included in or excluded from consideration for collision testing.

Arguments

  • int mask - Integer representing a bit mask, each bit of which represents a range of material code values. Setting that bit to 1 will cause the IG to register hits with materials within the corresponding range.

int getMaterialMask( )

Gets the material mask for the collision segment. This parameter specifies the environmental and cultural features to be included in or excluded from consideration for collision testing.

Return value

Integer representing a bit mask, each bit of which represents a range of material code values. Setting that bit to 1 will cause the IG to register hits with materials within the corresponding range.

void setCollisionDetectedCallback( CallbackBase * func )

Sets a callback on detecting a collision with the collision segment. This function can be used to define specific actions to be performed when a collision with the segment is detected.
Source code (C++)
/// callback function to be called when a collision with the collision segment 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 segment is detected
	ig_manager->getEntity(entity_id)->getCollisionSegment(segment_id)->setCollisionDetectedCallback(Unigine::MakeCallback( my_collision_callback );
}

Arguments

  • CallbackBase * func - Callback pointer.
Last update: 2019-04-30