Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
EventListenerPhysicsContact Class Reference

Contact listener. More...

Inherits EventListenerCustom.

Inherited by EventListenerPhysicsContactWithBodies, EventListenerPhysicsContactWithGroup, and EventListenerPhysicsContactWithShapes.

Public Member Functions

virtual bool checkAvailable () override
 Check the listener is available. More...
 
virtual
EventListenerPhysicsContact
clone () override
 Clone an object from this listener. More...
 
var clone ()
 Clone an object from this listener. More...
 
- Public Member Functions inherited from EventListener
virtual ~EventListener ()
 Destructor.
 
local ~EventListener ()
 Destructor.
 
void setEnabled (bool enabled)
 Enables or disables the listener. More...
 
local setEnabled ( local enabled)
 Enables or disables the listener. More...
 
bool isEnabled () const
 Checks whether the listener is enabled. More...
 
local isEnabled ()
 Checks whether the listener is enabled. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
local release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
local getReferenceCount ()
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor. More...
 

Static Public Member Functions

static
EventListenerPhysicsContact
create ()
 Create the listener. More...
 
var create ()
 Create the listener. More...
 
local create ()
 Create the listener. More...
 
- Static Public Member Functions inherited from EventListenerCustom
static EventListenerCustomcreate (const std::string &eventName, const std::function< void(EventCustom *)> &callback)
 Creates an event listener with type and callback. More...
 
local create ( local eventName, local callback)
 Creates an event listener with type and callback. More...
 

Public Attributes

std::function< bool(PhysicsContact
&contact)> 
onContactBegin
 It will called at two shapes start to contact, and only call it once.
 
std::function< bool(PhysicsContact
&contact,
PhysicsContactPreSolve &solve)> 
onContactPreSolve
 Two shapes are touching during this step. More...
 
std::function< void(PhysicsContact
&contact, const
PhysicsContactPostSolve &solve)> 
onContactPostSolve
 Two shapes are touching and their collision response has been processed. More...
 
std::function< void(PhysicsContact
&contact)> 
onContactSeparate
 It will called at two shapes separated, and only call it once. More...
 
- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
local _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
local _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
local _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
local _rooted
 When true, it means that the object was already rooted.
 

Additional Inherited Members

- Public Types inherited from EventListener
enum  Type
 Type Event type. More...
 
- Protected Member Functions inherited from EventListenerCustom
 EventListenerCustom ()
 Constructor.
 
 EventListenerCustom ()
 Constructor.
 
 EventListenerCustom ()
 Constructor.
 
bool init (const ListenerID &listenerId, const std::function< void(EventCustom *)> &callback)
 Initializes event with type and callback function.
 
var init ( var listenerId, var callback)
 Initializes event with type and callback function.
 
local init ( local listenerId, local callback)
 Initializes event with type and callback function.
 
- Protected Member Functions inherited from EventListener
 EventListener ()
 Constructor. More...
 
bool init (Type t, const ListenerID &listenerID, const std::function< void(Event *)> &callback)
 Initializes event with type and callback function. More...
 
local init ( local t, local listenerID, local callback)
 Initializes event with type and callback function. More...
 

Detailed Description

Contact listener.

It will receive all the contact callbacks.

Member Function Documentation

static
EventListenerPhysicsContact*
create
( )
static

Create the listener.

var create ( )
static

Create the listener.

local create ( )
static

Create the listener.

virtual bool checkAvailable ( )
overridevirtual

Check the listener is available.

Returns
True if there's one available callback function at least, false if there's no one.

Reimplemented from EventListenerCustom.

var checkAvailable ( )
overridevirtual

Check the listener is available.

Returns
True if there's one available callback function at least, false if there's no one.

Reimplemented from EventListenerCustom.

local checkAvailable ( )
overridevirtual

Check the listener is available.

Returns
True if there's one available callback function at least, false if there's no one.

Reimplemented from EventListenerCustom.

virtual
EventListenerPhysicsContact*
clone
( )
overridevirtual
var clone ( )
overridevirtual
local clone ( )
overridevirtual

Member Data Documentation

std::function<bool(PhysicsContact&
contact,
PhysicsContactPreSolve& solve)>
onContactPreSolve

Two shapes are touching during this step.

Return false from the callback to make world ignore the collision this step or true to process it normally. Additionally, you may override collision values, restitution, or surface velocity values.

var onContactPreSolve

Two shapes are touching during this step.

Return false from the callback to make world ignore the collision this step or true to process it normally. Additionally, you may override collision values, restitution, or surface velocity values.

local onContactPreSolve

Two shapes are touching during this step.

Return false from the callback to make world ignore the collision this step or true to process it normally. Additionally, you may override collision values, restitution, or surface velocity values.

std::function<void(PhysicsContact&
contact, const
PhysicsContactPostSolve& solve)>
onContactPostSolve

Two shapes are touching and their collision response has been processed.

You can retrieve the collision impulse or kinetic energy at this time if you want to use it to calculate sound volumes or damage amounts. See cpArbiter for more info

var onContactPostSolve

Two shapes are touching and their collision response has been processed.

You can retrieve the collision impulse or kinetic energy at this time if you want to use it to calculate sound volumes or damage amounts. See cpArbiter for more info

local onContactPostSolve

Two shapes are touching and their collision response has been processed.

You can retrieve the collision impulse or kinetic energy at this time if you want to use it to calculate sound volumes or damage amounts. See cpArbiter for more info

std::function<void(PhysicsContact&
contact)> onContactSeparate

It will called at two shapes separated, and only call it once.

onContactBegin and onContactSeparate will called in pairs.

var onContactSeparate

It will called at two shapes separated, and only call it once.

onContactBegin and onContactSeparate will called in pairs.

local onContactSeparate

It will called at two shapes separated, and only call it once.

onContactBegin and onContactSeparate will called in pairs.


The documentation for this class was generated from the following file: