How to use sensors? « cocos2d for iPhone

cocos2d for iPhone » Programming » physics

How to use sensors?

(18 posts) (5 voices)

Started 2 years ago by XyrisKenn
Latest reply from eshirt

Tags:

XyrisKenn
Member

Hello forum,

I'm a Canadian in the Czech Republic, and new to the forum and Cocos2D.

I've a small game running in which the player tries to score a goal like in a football game.

The sensors are boxes in place where the goals would be, but I can't figure out how to detect when they are hit by the ball, as in scoring a goal.

I've checked the sensorTest file and searched the forum and web, and Box2D's forum, but have not found anything I understand.

Any help appreciated, thank you.

---------------------------
//Sensor creation:
// player one goal
CGSize screenSize = [Director sharedDirector].winSize;

b2BodyDef goalOneBodyDef;
goalOneBodyDef.position.Set(((screenSize.width/PTM_RATIO)/2), 0.15);
goalOne = _world->CreateBody(&goalOneBodyDef);

// add dynamic box for goal
b2PolygonShape goalOneShapeDef;
goalOneShapeDef.SetAsBox(2.0f, 0.05f);

b2FixtureDef goalOneFixtureDef;
goalOneFixtureDef.shape = &goalOneShapeDef;
goalOneFixtureDef.isSensor = true;

// add to body
goalOne->CreateFixture(&goalOneFixtureDef);

--------------------------------------------

//tick checks:
-(void)tick:(ccTime) dt{
_world->Step(dt, 10, 8);
for(b2Body* b = _world->GetBodyList();b;b=b->GetNext())
{
if(b->GetUserData()!=NULL)
{
Sprite* puckData = (Sprite*)b->GetUserData();

puckData.position = CGPointMake(b->GetPosition().x * PTM_RATIO, b->GetPosition().y * PTM_RATIO);
}
}
}

Posted 2 years ago #
bradparks
Member

You have to implement a b2ContactListener to "listen" for collisions... this needs to be done for sensors too....

This discussion talks about it... careful when you're looking at samples, as the function parameters have changed a bit... I think this discussion points them out correctly near the bottom:

http://www.cocos2d-iphone.org/forum/topic/2057#post-12939

Also, if you haven't checked it out, the latest svn version of cocos has it in it in one of the samples (b2ContactListener)

http://www.google.com/codesearch/p?hl=en&sa=N&cd=5&ct=rc#PWa7F9gP7VU/trunk/tests/Box2DTestBed-Cocos2dIntegration/iPhoneTest.h&q=b2contactlistener%20package:http://cocos2d-iphone\.googlecode\.com

Posted 2 years ago #
XyrisKenn
Member

Thank you bradparks. I've spent hours going through these examples and the reference post you list. The problems I'm encountering as a newbie to Box2d in cocos2d is that the contactListener has just been revised in a way that breaks earlier tutorials, and the testbed files are actually a large collection of different effects. The techniques are buried in there, but difficult to isolate as a simple example of contacts and callbacks because of the testbed's complexity.

It looks in the testbed/ iPhoneTest.h as if the public b2ContactListener is wrapped around variables to do with entire game parameters, while the examples kindly displayed in the link are more focused and refined, but missing included super or subclasses. Or it seems so to me.

I came across an example of a technique to customize the contact information in a game-friendly way, i.e. if contact is ball and tree, then tree explode, but again incorporates super and subclasses not available to study.

As an early learner, finding a straightfoward, focused example of contactListener and callbacks would be extremely helpful.
My experience is in actionscript OOP, where the listener/callbacks seem a bit easier to assign.
Box2D is excellent complex and free software, but getting started with listeners and multitouch is a bit difficult.

Thanks again for sharing your time with the links above.

Posted 2 years ago #
bradparks
Member

Hey there... Glad it helped... and I'm sure you found it through your browsing around, but here's a specific test from the Box2d test bed that addresses sensors... I thought that I'd linked to that before, but when I tried, it didn't get to it... I've tinyurl'd it to make sure it gets through this time!

http://tinyurl.com/box2dsensortest

Posted 2 years ago #

Hi, thanks for this link. I'd seen that in the testbed, but this example seems clearer. I'll try it for the sensor use after integrating ContactListener.

Also, I looked at the source kindly provided by the 'Luke' at Metal Fish Eggs, in the first thread link: http://blog.zincroe.com/2009/05/iphone-and-box2d/
..which gave me an understanding of the 'Actors' approach being used by others in thread http://www.cocos2d-iphone.org/forum/topic/2057#post-12939.

However Luke's example uses the regular UIKit framework and I'd like to use Cocos2D and OpenGLes.

So I started synthesizing the two approaches, integrating Luke's Actor.m and ContactListener.m(m) with pabloruiz55's/Rolando's notes, and updating to what I understand of the newest Box2d API in Cocos2d 0.8.02 .

ContactListener isn't throwing compile errors which is a success, but the simulator is freezing on first contact.
I think it's because I'm only half-way integrated right now.

Here are the changes I made so far, using the cocos2d-iphone-0.8.2-rc0 source. Next I'll continue integrating the physics setup and timing.
Caution, the GameLayer code is incomplete and shows only relevant excerpts from my work, built up from the Cocos Box2d template.

1. Actor.h and .m are the same as in Luke's example on blog.zincroe.com.

--------------------------------
2a. ContactListener.h

#include "Box2D.h"

class ContactListener : public b2ContactListener {
public:
	void BeginContact(b2Contact *contact);
	void EndContact(b2Contact *contact);
};

--------------------------------------

2b. ContactListener.mm

#import "ContactListener.h"
#import "Actor.h"

void ContactListener::BeginContact(b2Contact *contact) {
	Actor *actor1 = (Actor *)contact->GetFixtureA()->GetBody()->GetUserData();
	Actor *actor2 = (Actor *)contact->GetFixtureB()->GetBody()->GetUserData();
	if(actor1 && actor2) {
		[actor1 addContact:actor2];
		[actor2 addContact:actor1];
	}
}

void ContactListener::EndContact(b2Contact *contact) {
	Actor *actor1 = (Actor *)contact->GetFixtureA()->GetBody()->GetUserData();
	Actor *actor2 = (Actor *)contact->GetFixtureB()->GetBody()->GetUserData();
	if(actor1 && actor2) {
		[actor1 removeContact:actor2];
		[actor2 removeContact:actor1];
	}
}

----------------------

3a. GameLayer.h (derived from HelloWorld.h / Cocos2d 0.8.2 Box2D template and instead of Luke's MyGameViewController.h)

...

@class Actor;

@interface GameLayer : Layer {
	NSMutableSet *actorSet;
	b2ContactListener *contactListener;

        b2World *world;

...
}

-(void)addActor:(Actor *)anActor;
-(void)removeActor:(Actor *)anActor;
-(void)removeAllActors;

...
// returns a Scene
+(id) scene;

@end

-----------------------

3b. GameLayer.mm

#import "GameLayer.h"
#import "Actor.h"
#import "ContactListener.h"

@interface GameLayer()

#pragma mark Actor Properties
@property (nonatomic, retain) NSMutableSet *actorSet;

#pragma mark Physics Properties
@property (nonatomic, readwrite) b2ContactListener *contactListener;
@property (nonatomic, readwrite) b2World *world; 

@end
...
#pragma mark Actor Accessors

@synthesize actorSet;

#pragma mark Actor Methods

-(void)addActor:(Actor *)anActor {
	if (anActor && ![[self actorSet] containsObject:anActor]) {
		[anActor setGame:self];
		[[self actorSet] addObject:anActor];
		[anActor actorDidAppear];
	}
}

-(void)removeActor:(Actor *)anActor {
	if(anActor && [[self actorSet] containsObject:anActor]) {
		[anActor retain];
		[anActor actorWillDisappear];
		[[self actorSet] removeObject:anActor];
		[anActor setGame:nil];
		[anActor release];
	}
}

-(void)removeAllActors {
	for(Actor *anActor in [NSSet setWithSet:[self actorSet]]) {
		[self removeActor:anActor];
	}
}

#pragma mark Physics Accessors
@synthesize contactListener;
@synthesize world;

-(id) init
{
	if( (self=[super init])) {
        mainLayer = self;
...
// set contactListener
	contactListener = new ContactListener;
	world->SetContactListener(contactListener);
...
    }
	return self;
}

Posted 2 years ago #

eshirt
Member

XyrisKenn - did you ever get sensors working? I've implemented the ContactListener successfully using your suggestions above and some other posts here. After having so much trouble with some other aspects of Box2d, I was amazed how easy it was to get a simple collision detection. :)

But now I'm not able to get my sensor to trigger. Can anyone tell me what I might be doing wrong? I looked at the test bed and SensorTest, but I can't find my error.

In ContactListener.mm

void ContactListener::BeginContact(b2Contact *contact) {
	b2Fixture *actor1 = contact->GetFixtureA();
	b2Fixture *actor2 = contact->GetFixtureB();

	if([(AtlasSprite *)actor1->GetUserData() isEqual:@"mySpriteSel"] && [(AtlasSprite *)actor2->GetUserData() isEqual:@"yourSprite"]) {
			// mySpriteSel and yourSprite are set as UserData in MyGame.mm
			NSLog(@"CONTACT!!!!");  // this works
		}

	if ([(AtlasSprite *)actor1->GetUserData() isEqual:@"mySpriteSel"] && [actor2->GetUserData() isEqual:@"mySensor"]) {
		NSLog(@"Sensor activated!!!!");  // this doesn't
	}

and in MyGame.mm

// Set contact listener in -(void)init
ContactListener *contactListener = new ContactListener;
world->SetContactListener(contactListener);

// Create sensor body and fixture
b2BodyDef sensorBd;
sensorBd.position.Set(-5.5,5);
b2Body *mySensor = world->CreateBody(&sensorBd);
b2PolygonShape sensorShape;
sensorShape.SetAsBox(0.9, 6.4);
b2FixtureDef sensorFd;
sensorFd.shape = &htEndZoneShape;
sensorFd.isSensor = true;
b2Fixture *fixture = mySensor->CreateFixture(&sensorFd);
fixture->SetUserData(@"mySensor");

I think that should be all the relevant code.

Posted 2 years ago #

eshirt
Member

Aren't sensors just supposed to act like any other object in the collision listener? I can't get them to register, even though solid bodies trigger contacts perfectly. I'm guessing that my sensor is just being created incorrectly, but I'm looking at SensorTest and I don't see much difference (except that I'm adding UserData).

I can't find any other examples on the web either... anyone have this working?

Posted 2 years ago #

bradparks
Member

Here's the routine I'm using to add sensors.... I just pass "isSensor:YES", and it works for me....

-(void) addStaticShapeAtCoords:(CocosNode *) node pos:(CGPoint)pos width:(int) width height:(int) height isSensor:(BOOL)isSensor
  {
    // Define the body.
    b2BodyDef staticBodyDef;
    staticBodyDef.position.Set(pos.x/tileSize, pos.y/tileSize);
    staticBodyDef.userData = node;

    // Define the box shape.
    b2PolygonShape staticBox;

    // The extents are the half-widths of the box.
    staticBox.SetAsBox(.5f * (width / tileSize) , .5f * (height / tileSize));

    // Define the fixture. This binds a shape (geometry) to a
    // body (dynamics).
    b2FixtureDef staticFixtureDef;
    staticFixtureDef.shape = &staticBox;
    staticFixtureDef.friction = 2.0f;
    staticFixtureDef.isSensor = isSensor;

    // Add the fixture to the body.
    b2Body* staticBody = world->CreateBody(&staticBodyDef);
    staticBody->CreateFixture(&staticFixtureDef);
    if (node != nil)
      node.userData = staticBody;
  }

Posted 2 years ago #

eshirt
Member

Looks like you're doing something pretty similar. The only difference is your userData property... I haven't seen it done that way, can you elaborate? It looks like you're doing this the way the box2d documentation suggests - assigning userData to an object and a body, creating a circular reference. I just haven't been able to figure that one out for myself yet .

I'll try to get it to work with isSensor, but I actually have 2 sensors that need to trigger different actions, so I have applied user data to them. I think now my trouble is accessing that user data appropriately. I'm assuming that I need to apply the UserData to my Fixture, not the Body - in order to get the returned fixture isSensor to work?

Posted 2 years ago #
Lam
Member

Userdata could be applied to the body. I've done that and it works for me. I've seen your thread on user data issue. I'm not quite sure why you were having problems so I didn't know how to respond to help.

Posted 2 years ago #
eshirt
Member

Given a body with UserData of myData...

Would I use

[actor2->GetBody()->GetUserData() isEqual:myData];

?

Posted 2 years ago #
Lam
Member

What's the context of that if statement?

What are you trying to do that needs access to UserData again?

Because maybe there's another alternative to what you are attempting.
Other than that, the if statement you used is the same as mine. That's the problem with code sometimes. The simplest statements make sense and the idea is right but there's always some logical error that's hard to detect in the actual code that breaks it. =/

Posted 2 years ago #
eshirt
Member
So, I just typed up a really long reply that explained what I was trying to do, and in the process, I realized that I had always been testing contact->GetFixtureB() as my sensor. As soon as I put this in my ContactListener
```
b2Fixture *actor1 = contact->GetFixtureA();

if (actor1->IsSensor()) {
// log contact
}
```
It worked. Is there a consistent rule for contact->fixture A & B - like "a sensor is always fixtureA()"? Or do I need to write these if() statements assuming that either could be a sensor?

I'll work on integrating my userData back into the sensors and try to get it to work, knowing that FixtureA() is the sensor.
Posted 2 years ago #
eshirt
Member

Yep, that was it - I'm able to check for UserData and distinguish between multiple sensors. Looking in the class declaration, I can't see any clear rule about which contacts get labeled FixtureA() and FixtureB(). But my C++ is beginner level, at best, so maybe it's in there and I don't see it. :)

Posted 2 years ago #
blackmouth
Member

eshirt,

You'll need to check both fixtureA and fixtureB due to the way the contact listener works.

XrisKenn has a good blog post that helped me implement my contact listener.
http://blog.xyris.ca/?p=40

Thanks Xyris!

Posted 2 years ago #
bradparks
Member

good to hear it worked out! as for my circular reference stuff, all it does is let me always get a sprite from a body, or body from a sprite, whichever I happen to be using at the time.... i honestly can't say if I use it that way or not though! I just copied this from the Box2d examples and it seemed to work ;-) But I've found finding how the Box2d stuff works hard, especially since we're out of sync with the public release....

Posted 2 years ago #
XyrisKenn
Member

@blackmouth, you're welcome, glad the post was useful. Thanks for mentioning it. @eshirt and bradparks, I'll be learning from your posts when I start adding sensors :)

Posted 2 years ago #
eshirt
Member

@blackmouth & XyrisKenn - somehow I completely overlooked your reply yesterday. I do have it working, but I will be sure to read through that excellent post. It looks like it will clear up a lot of loose ends for me on the whole contact listener topic.

Thanks for your help - all of you. @bradparks is right, this has been difficult with so little documentation on the current build of box2d. I'm glad I found you guys on here or I would have been completely lost! :)

Posted 2 years ago #

RSS feed for this topic

Reply

You must log in to post.