IF_CollisionHandler – General Information

Overview

Type:	Interface
Available as of:	V1.0.0.0
Inherits from:	-

This chapter provides information on:

Task
Description
Method
Properties

Task

The interface for a collision handler.

Description

A collision handler is an object that helps the user in configuring and updating a collision entity that is used to represent a module of the machine. In general, given a set of parameters describing a module, a collision handler uses such parameters to automatically configure the related collision entity.

Extension: __System.IQueryInterface

Properties

Name	Data type	Accessing	Description
xUpdated	BOOL	Get	The property is set to TRUE if the latest call of the Update method was successful, FALSE otherwise. NOTE: The property needs to have a TRUE value before performing a collision or distance query involving the group.
ifCollisionEntity	IF_CollisionEntity	Get	Reference to the collision entity configured and updated by the collision handler. NOTE: This interface can be provided as input of the collision and distance queries. This interface allows to directly access the collision entity managed by the collision handler; any operation on such interface should be avoided before IF_CollisionHandler.xConfigured = TRUE.
rstBaseOrientation	REFERENCE TO ARRAY SE_Math.ST_Matrix3D	Get	The orientation of the entity with reference to a global coordinate system.
rstBasePosition	REFERENCE TO ARRAY SE_Math.ST_Matrix3D	Get	Position of the entity with reference to a global coordinate system.
etType	ET_CollisionHandlerType	Get	The type of the collision handler; this is related to the type of represented module.
xConfigured	BOOL	Get	The value of this property is TRUE if the object has been properly initialized, FALSE otherwise.