Commit cf445855 authored by cutealien's avatar cutealien

Documenation clarification in IEventReceiver (thx teto) and ISceneCollisionManager (thx aanderse).


git-svn-id: svn://svn.code.sf.net/p/irrlicht/code/trunk@3008 dfc29bdd-3216-0410-991c-e03cc46cb475
parent e5bcc470
...@@ -431,7 +431,11 @@ public: ...@@ -431,7 +431,11 @@ public:
virtual ~IEventReceiver() {} virtual ~IEventReceiver() {}
//! Called if an event happened. //! Called if an event happened.
/** \return True if the event was processed. */ /** Please take care that you should only return 'true' when you want to _prevent_ Irrlicht
* from processing the event any further. So 'true' does mean that an event is completely done.
* Therefore your return value for all unprocessed events should be 'false'.
\return True if the event was processed.
*/
virtual bool OnEvent(const SEvent& event) = 0; virtual bool OnEvent(const SEvent& event) = 0;
}; };
......
...@@ -25,14 +25,14 @@ namespace scene ...@@ -25,14 +25,14 @@ namespace scene
{ {
public: public:
//! Finds the collision point of a line and lots of triangles, if there is one. //! Finds the nearest collision point of a line and lots of triangles, if there is one.
/** \param ray: Line with which collisions are tested. /** \param ray: Line with which collisions are tested.
\param selector: TriangleSelector containing the triangles. It \param selector: TriangleSelector containing the triangles. It
can be created for example using can be created for example using
ISceneManager::createTriangleSelector() or ISceneManager::createTriangleSelector() or
ISceneManager::createTriangleOctTreeSelector(). ISceneManager::createTriangleOctTreeSelector().
\param outCollisionPoint: If a collision is detected, this will \param outCollisionPoint: If a collision is detected, this will
contain the position of the nearest collision. contain the position of the nearest collision to the line-start.
\param outTriangle: If a collision is detected, this will \param outTriangle: If a collision is detected, this will
contain the triangle with which the ray collided. contain the triangle with which the ray collided.
\param outNode: If a collision is detected, this will contain \param outNode: If a collision is detected, this will contain
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment