PhysicalTrigger Class
Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
| Inherits: | Physical |
Physical triggers fire callbacks when a physical object gets inside or outside of them. To be detected by the trigger, physical objects are required to have at the same time both:
- Bodies (with matching Physical Mask)
NoticeFor BodyDummy to trigger PhysicalTrigger, you need to call updateContacts() first.
- Shapes (with matching Collision mask)
To force update of the physical trigger updateContacts() can be called. After that, you can access all updated data about the contacts in the same frame. However, callback functions will still be executed only when the next engine function is called: that is, before updatePhysics() (in the current frame), or before the update() (in the next frame) — whatever comes first.
Notice
If you have moved some nodes and want to get callbacks based on changed positions in the same frame, you need to call engine.world.updateSpatial() first.
See Also#
- A C++ API sample located in the <UnigineSDK>/source/samples/Api/Nodes/PhysicalTrigger folder
- A C# API sample located in the <UnigineSDK>/source/csharp/samples/Api/Nodes/PhysicalTrigger folder
- A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/physicals/ folder:
- trigger_00
- trigger_01
- trigger_02
Usage Example#
In this example a physical trigger and two boxes, each with a body and a shape, are created. When a box with matching physical mask enters the physical trigger the trigger_enter() function is called, when it leaves the trigger - the trigger_leave() function is called.
Source code (UnigineScript)
#include <core/scripts/primitives.h>
/* .. */
PhysicalTrigger trigger;
ObjectMeshDynamic box1;
ObjectMeshDynamic box2;
// callback function to be fired when a physical object enters the trigger
void trigger_enter(Body body)
{
// trying to get an object from the body
Object obj = body.getObject();
if (obj == NULL)
return;
// enabling material emission for all object's surfaces
for (int i = 0; i < obj.getNumSurfaces(); i++)
obj.setMaterialState("emission", 1, i);
// displaying the name of the object entering trigger area
log.message("\n %s has entered the trigger area!", body.getObject().getName());
}
// callback function to be fired when a physical object leaves the trigger
void trigger_leave(Body body)
{
// trying to get an object from the body
Object obj = body.getObject();
if (obj == NULL)
return;
// disabling material emission for all object's surfaces
for (int i = 0; i < obj.getNumSurfaces(); i++)
obj.setMaterialState("emission", 0, i);
// displaying the name of the object leaving trigger area
log.message("\n %s has left the trigger area!", body.getObject().getName());
}
// function creating a named box having a specified size, color and transformation with a body and a shape
ObjectMeshDynamic createBodyBox(string name, Vec3 size, float mass, Vec4 color, Mat4 transform, int physical_mask)
{
// creating geometry and setting up its parameters (name, material and transformation)
ObjectMeshDynamic box = Unigine::createBox(size);
box.setWorldTransform(transform);
box.setMaterial("mesh_base", "*");
box.setMaterialParameterFloat4("albedo_color", color, 0);
box.setName(name);
// adding physics, i.e. a rigid body and a box shape with specified mass
BodyRigid body = class_remove(new BodyRigid(box));
ShapeBox shape = class_remove(new ShapeBox(size));
shape.setMass(mass);
body.addShape(shape, translate(0.0f, 0.0f, 0.0f));
body.setPhysicalMask(physical_mask);
body.setFreezable(0);
return box;
}
/* .. */
int init() {
// setting up a player
Player player = new PlayerSpectator();
player.setPosition(Vec3(0.0f,-3.401f,1.5f));
player.setDirection(Vec3(0.0f,1.0f,-0.4f));
engine.game.setPlayer(player);
// enabling visualizer to render bounds of the physical trigger
engine.console.run("show_visualizer 1");
// creating a physical trigger and passing it to the Editor
trigger = new PhysicalTrigger(3,vec3(2.0f, 2.0f, 1.0f));
// setting trigger's position
trigger.setPosition(Vec3(0.0f, 0.0f, 1.0f));
// setting trigger's physical mask equal to 1
trigger.setPhysicalMask(1);
// retrieving trigger size
vec3 size = trigger.getSize();
// displaying trigger size and shape type
log.message("\n Trigger parameters size(%f, %f , %f) type: %d", size.x, size.y, size.z, trigger.getShapeType());
// setting trigger enter callback function
trigger.setEnterCallback("trigger_enter");
// setting trigger leave callback function
trigger.setLeaveCallback("trigger_leave");
// creating a box with a body and physical mask value equal to 2 to be ignored by the trigger
box1 = createBodyBox("Box1", vec3(0.2f), 5.0f, vec4(1.0f, 0.0f, 0.0f, 1.0f), translate(Vec3(0.0f, 0.0f, 2.22f)),2);
// creating a box with a body and physical mask value equal to 1 to affect the trigger
box2 = createBodyBox("Box2", vec3(0.2f), 0.0f, vec4(1.0f, 1.0f, 0.0f, 1.0f), translate(Vec3(3.5f, 0.0f, 1.2f)),1);
// displaying physical masks of both boxes and the trigger
log.message("\n Box1 Physical mask: %d", box1.getBody().getPhysicalMask());
log.message("\n Box2 Physical mask: %d", box2.getBody().getPhysicalMask());
log.message("\n Trigger Physical mask: %d", trigger.getPhysicalMask());
return 1;
}
int update() {
/* .. */
// showing the bounds of the physical trigger
trigger.renderVisualizer();
// changing the position of the second box
box2.setWorldPosition(box2.getWorldPosition() - Vec3(0.5f * engine.game.getIFps(), 0.0f, 0.0f));
return 1;
}
/* .. */
int updatePhysics() {
// updating information on trigger contacts
trigger.updateContacts();
return 1;
}PhysicalTrigger Class
Members
static PhysicalTrigger ( int type, vec3 size ) #
Constructor. Creates a physical trigger of the specified shape and size.Arguments
- int type - Shape of the physical trigger:
- 0 = Sphere
- 1 = Capsule
- 2 = Cylinder
- 3 = Box
- vec3 size - Size of the physical trigger:
- Radius, in case of a sphere
- Radius and height, in case of a capsule or a cylinder
- Dimensions, in case of the box
Body getBody ( int num ) #
Returns the specified body with which a physical trigger intersects.Arguments
- int num - Body number.
Return value
Intersected body.void setCollisionMask ( int mask ) #
Sets the collision bit mask for the trigger:- the trigger will be activated if the entered body will have a matching Physical Mask and at the same time its shape will have a matching Collision Mask.
Arguments
- int mask - Integer, each bit of which is a mask.
int getCollisionMask ( ) #
Returns the collision bit mask for the trigger:- the trigger will be activated if the entered body will have a matching Physical Mask and at the same time its shape will have a matching Collision Mask.
Return value
Integer, each bit of which is a mask.float getContactDepth ( int contact ) #
Returns penetration depth by the given contact.Arguments
- int contact - Contact number.
Return value
Penetration depth.vec3 getContactNormal ( int contact ) #
Returns a normal of the contact point, in world coordinates.Arguments
- int contact - Contact number.
Return value
Normal of the contact point.Object getContactObject ( int contact ) #
Returns an object participating in the contact with a physical trigger .Arguments
- int contact - Contact number.
Return value
Object in contact.Vec3 getContactPoint ( int contact ) #
Returns world coordinates of the contact point.Arguments
- int contact - Contact number.
Return value
Contact point.Shape getContactShape ( int contact ) #
Returns a shape that collided with a physical trigger.Arguments
- int contact - Contact number.
Return value
Shape in contact.int getContactSurface ( int contact ) #
Returns the surface of the current object, which is in contact .Arguments
- int contact - Contact number.
Return value
Surface number.void setEnterCallback ( int func ) #
Sets a callback function to be fired when a body enters the physical trigger. The callback function must receive a Body as its first argument. In addition, it can also take 2 arguments of any type.Source code (UnigineScript)
// implement the enter callback
void enter_callback(Body body) {
log.message("\nA body named %s has entered the trigger\n", body.getName());
}
}
PhysicalTrigger trigger;
int init() {
// create a box-type physical trigger
trigger = new PhysicalTrigger(3, vec3(3.0f));
// set the enter callback to be fired when a body enters the physical trigger
trigger.setEnterCallback(functionid(enter_callback));
return 1;
}Arguments
- int func - Callback function identifier.
void setEnterCallbackName ( string name ) #
Sets a callback function to be fired on entering the physical trigger.- Unlike setEnterCallback(), this callback function accepts a body that entered the physical trigger and physical trigger itself as arguments.
Arguments
- string name - Name of the callback function.
string getEnterCallbackName ( ) #
Returns the name of the callback function fired on entering the physical trigger. This callback function is set via setEnterCallbackName() .Return value
Name of the callback function.void setExclusionMask ( int mask ) #
Sets an bit mask to prevent detecting collisions with shapes and bodies. This mask is independent of the collision mask. To avoid detecting collisions by a physical trigger for bodies and shapes with matching collision masks, at least one bit in exclusion masks should match. 0 is to collide with all bodies and shapes with a matching collision mask.Arguments
- int mask - Integer, each bit of which is a mask.
int getExclusionMask ( ) #
Returns the bit mask that prevent detecting collisions with shapes and bodies. This mask is independent of the collision mask. To avoid detecting collisions by a physical trigger for bodies and shapes with matching collision masks, at least one bit in exclusion masks should match.Return value
Integer, each bit of which is a mask.void setLeaveCallback ( int func ) #
Sets a callback function to be fired when a body enters the physical trigger. The callback function must receive a Body as its first argument. In addition, it can also take 2 arguments of any type.Source code (UnigineScript)
// implement the leave callback
void leave_callback(Body body) {
log.message("\nA body named %s has left the trigger\n", body.getName());
}
}
PhysicalTrigger trigger;
int init() {
// create a box-type physical trigger
trigger = new PhysicalTrigger(3, vec3(3.0f));
// set the leave callback to be fired when a body leaves the physical trigger
trigger.setLeaveCallback(functionid(leave_callback));
return 1;
}Arguments
- int func - Callback function identifier.
void setLeaveCallbackName ( string name ) #
Sets the name of a callback function to be fired on leaving the physical trigger.- Unlike setLeaveCallback() , this callback function accepts a body that left the physical trigger and physical trigger itself as arguments.
Arguments
- string name - Name of the callback function.
string getLeaveCallbackName ( ) #
Returns the name of the callback function fired on leaving the physical trigger. This callback function is set via setLeaveCallbackName() .Return value
Name of the callback function.int getNumBodies ( ) #
Returns the total number of bodies intersecting with the physical trigger.Return value
Number of bodies.int getNumContacts ( ) #
Returns the total number of contacts with bodies, shapes and colliding surfaces in which a physical trigger participated.Return value
Number of contacts.void setShapeType ( int type ) #
Sets the shape type of the physical trigger.Arguments
- int type - Shape type of the physical trigger:
- 0 - Sphere
- 1 - Capsule
- 2 - Cylinder
- 3 - Box
int getShapeType ( ) #
Returns the shape type of the physical trigger.Return value
Shape type of the physical trigger:- 0 - Sphere
- 1 - Capsule
- 2 - Cylinder
- 3 - Box
void setSize ( vec3 size ) #
Sets the size of the physical trigger.Arguments
- vec3 size - New size of the physical trigger:
- Radius, in case of a sphere (pass the radius in the first element of the vector).
- Radius and height, in case of a capsule or a cylinder (pass the radius as the first vector element and the height as the second element).
- Dimensions along the X, Y and Z axes, in case of the box.
vec3 getSize ( ) #
Returns the current size of the physical trigger:- Radius, in case of a sphere (pass the radius in the first element of the vector).
- Radius and height, in case of a capsule or a cylinder (pass the radius as the first vector element and the height as the second element).
- Dimensions along the X, Y and Z axes, in case of the box.
Return value
Size of the physical trigger.static int type ( ) #
Returns the type of the node.Return value
Physical trigger type identifier.void updateContacts ( ) #
Forces a physical trigger to be updated, i.e. to recalculate its intersections with physical objects and colliders. After that, you can access all updated data; however, callback functions themselves will be executed only when physics flush is over.Last update:
2020-07-31
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)