Documentation changes.

git-svn-id: svn://svn.code.sf.net/p/irrlicht/code/trunk@4120 dfc29bdd-3216-0410-991c-e03cc46cb475

changes.txt

@@ -1,5 +1,9 @@
 Changes in 1.8 (??.??.2011)
 
+ - added IGUIElement::setName and IGUIElement::getName (similar to ISceneNode)
+ 
+ - CSceneCollisionManager::getScreenCoordinatesFrom3DPosition uses now getCurrentRenderTargetSize instead of getScreenSize so it can work with render textures.
+
  - line2d::getClosestPoint can now also get the closest point on the line additional to only checking for closest point on the line-segment.
 
  - avoid division by zero in line2d::getClosestPoint when start- and endpoint are identical

include/IGUIEnvironment.h

@@ -204,8 +204,7 @@ public:
 	//! Returns the root gui element.
 	/** This is the first gui element, the (direct or indirect) parent of all
 	other gui elements. It is a valid IGUIElement, with dimensions the same
-	size as the screen. You should not need to use this method directly, unless
-	you wish to reparent GUI elements to the top level.
+	size as the screen. 
 	\return Pointer to the root element of the GUI. The returned pointer
 	should not be dropped. See IReferenceCounted::drop() for more
 	information. */

include/ISceneNode.h

@@ -184,7 +184,12 @@ namespace scene
 
 
 		//! Get the absolute transformation of the node. Is recalculated every OnAnimate()-call.
-		//! \return The absolute transformation matrix.
+		/** NOTE: For speed reasons the absolute transformation is not 
+		automatically recalculated on each change of the relative 
+		transformation or by a transformation change of an parent. Instead the
+		update usually happens once per frame in OnAnimate. You can enforce 
+		an update with updateAbsolutePosition().
+		\return The absolute transformation matrix. */
 		virtual const core::matrix4& getAbsoluteTransformation() const
 		{
 			return AbsoluteTransformation;
@@ -508,7 +513,12 @@ namespace scene
 		//! Gets the absolute position of the node in world coordinates.
 		/** If you want the position of the node relative to its parent,
 		use getPosition() instead.
-		\return The current absolute position of the scene node. */
+		/** NOTE: For speed reasons the absolute position is not 
+		automatically recalculated on each change of the relative 
+		position or by a position change of an parent. Instead the 
+		update usually happens once per frame in OnAnimate. You can enforce 
+		an update with updateAbsolutePosition().
+		\return The current absolute position of the scene node (updated on last call of updateAbsolutePosition). */
 		virtual core::vector3df getAbsolutePosition() const
 		{
 			return AbsoluteTransformation.getTranslation();