Browse Source

Travis CI: API documentation update at 2014-04-05 14:23:24 UTC.
[ci package]

urho3d-travis-ci 11 years ago
parent
commit
2349b6e119
3 changed files with 59 additions and 39 deletions
  1. 21 14
      Docs/AngelScriptAPI.h
  2. 17 11
      Docs/LuaScriptAPI.dox
  3. 21 14
      Docs/ScriptAPI.dox

+ 21 - 14
Docs/AngelScriptAPI.h

@@ -5146,8 +5146,8 @@ bool Load(File, bool = false);
 bool LoadXML(const XMLElement&, bool = false);
 Vector3 LocalToWorld(const Vector3&) const;
 Vector3 LocalToWorld(const Vector4&) const;
-bool LookAt(const Vector3&, const Vector3& = Vector3 ( 0 , 1 , 0 ));
-void Pitch(float, bool = false);
+bool LookAt(const Vector3&, const Vector3& = Vector3 ( 0 , 1 , 0 ), TransformSpace = TS_WORLD);
+void Pitch(float, TransformSpace = TS_LOCAL);
 void Remove();
 void RemoveAllChildren();
 void RemoveAllComponents();
@@ -5158,8 +5158,9 @@ void RemoveComponent(const String&);
 void RemoveComponents(bool, bool);
 void RemoveInstanceDefault();
 void ResetToDefault();
-void Roll(float, bool = false);
-void Rotate(const Quaternion&, bool = false);
+void Roll(float, TransformSpace = TS_LOCAL);
+void Rotate(const Quaternion&, TransformSpace = TS_LOCAL);
+void RotateAround(const Vector3&, const Quaternion&, TransformSpace = TS_LOCAL);
 bool Save(File) const;
 bool SaveXML(File);
 bool SaveXML(XMLElement&) const;
@@ -5175,11 +5176,10 @@ void SetTransform(const Vector3&, const Quaternion&, float);
 void SetWorldTransform(const Vector3&, const Quaternion&);
 void SetWorldTransform(const Vector3&, const Quaternion&, const Vector3&);
 void SetWorldTransform(const Vector3&, const Quaternion&, float);
-void Translate(const Vector3&);
-void TranslateRelative(const Vector3&);
+void Translate(const Vector3&, TransformSpace = TS_LOCAL);
 Vector3 WorldToLocal(const Vector3&) const;
 Vector3 WorldToLocal(const Vector4&) const;
-void Yaw(float, bool = false);
+void Yaw(float, TransformSpace = TS_LOCAL);
 
 // Properties:
 /* readonly */
@@ -6417,8 +6417,8 @@ bool LoadXML(File);
 bool LoadXML(const XMLElement&, bool = false);
 Vector3 LocalToWorld(const Vector3&) const;
 Vector3 LocalToWorld(const Vector4&) const;
-bool LookAt(const Vector3&, const Vector3& = Vector3 ( 0 , 1 , 0 ));
-void Pitch(float, bool = false);
+bool LookAt(const Vector3&, const Vector3& = Vector3 ( 0 , 1 , 0 ), TransformSpace = TS_WORLD);
+void Pitch(float, TransformSpace = TS_LOCAL);
 void RegisterVar(const String&);
 void Remove();
 void RemoveAllChildren();
@@ -6430,8 +6430,9 @@ void RemoveComponent(const String&);
 void RemoveComponents(bool, bool);
 void RemoveInstanceDefault();
 void ResetToDefault();
-void Roll(float, bool = false);
-void Rotate(const Quaternion&, bool = false);
+void Roll(float, TransformSpace = TS_LOCAL);
+void Rotate(const Quaternion&, TransformSpace = TS_LOCAL);
+void RotateAround(const Vector3&, const Quaternion&, TransformSpace = TS_LOCAL);
 bool Save(File) const;
 bool SaveXML(File);
 bool SaveXML(XMLElement&) const;
@@ -6448,14 +6449,13 @@ void SetWorldTransform(const Vector3&, const Quaternion&, const Vector3&);
 void SetWorldTransform(const Vector3&, const Quaternion&, float);
 void StopAsyncLoading();
 const String& GetVarName(ShortStringHash) const;
-void Translate(const Vector3&);
-void TranslateRelative(const Vector3&);
+void Translate(const Vector3&, TransformSpace = TS_LOCAL);
 void UnregisterAllVars(const String&);
 void UnregisterVar(const String&);
 void Update(float);
 Vector3 WorldToLocal(const Vector3&) const;
 Vector3 WorldToLocal(const Vector4&) const;
-void Yaw(float, bool = false);
+void Yaw(float, TransformSpace = TS_LOCAL);
 
 // Properties:
 /* readonly */
@@ -10453,6 +10453,13 @@ TEXTURE_RENDERTARGET,
 TEXTURE_DEPTHSTENCIL,
 };
 
+enum TransformSpace
+{
+TS_LOCAL,
+TS_PARENT,
+TS_WORLD,
+};
+
 enum TraversalMode
 {
 TM_BREADTH_FIRST,

+ 17 - 11
Docs/LuaScriptAPI.dox

@@ -2782,18 +2782,18 @@ Methods:
 - void SetWorldTransform(const Vector3& position, const Quaternion& rotation)
 - void SetWorldTransform(const Vector3& position, const Quaternion& rotation, float scale)
 - void SetWorldTransform(const Vector3& position, const Quaternion& rotation, const Vector3& scale)
-- void Translate(const Vector3& delta)
-- void TranslateXYZ(float x, float y, float z)
-- void TranslateRelative(const Vector3& delta)
-- void TranslateRelativeXYZ(float x, float y, float z)
-- void Rotate(const Quaternion& delta, bool fixedAxis = false)
-- void RotateXYZ(float x, float y, float z, bool fixedAxis = false)
-- void Pitch(float angle, bool fixedAxis = false)
-- void Yaw(float angle, bool fixedAxis = false)
-- void Roll(float angle, bool fixedAxis = false)
+- void Translate(const Vector3& delta, TransformSpace space = TS_LOCAL)
+- void TranslateXYZ(float x, float y, float z, TransformSpace space = TS_LOCAL)
+- void Rotate(const Quaternion& delta, TransformSpace space = TS_LOCAL)
+- void RotateXYZ(float x, float y, float z, TransformSpace space = TS_LOCAL)
+- void RotateAround(const Vector3& point, const Quaternion& delta, TransformSpace space = TS_LOCAL)
+- void RotateAroundXYZ(float pX, float pY, float pZ, float dX, float dY, float dZ, TransformSpace space = TS_LOCAL)
+- void Pitch(float angle, TransformSpace space = TS_LOCAL)
+- void Yaw(float angle, TransformSpace space = TS_LOCAL)
+- void Roll(float angle, TransformSpace space = TS_LOCAL)
 - bool LookAt(const Vector3& target)
-- bool LookAt(const Vector3& target, const Vector3& upAxis)
-- bool LookAtXYZ(float x, float y, float z, float upX = 0.0f, float upY = 1.0f, float upZ = 0.0f)
+- bool LookAt(const Vector3& target, const Vector3& upAxis, TransformSpace space = TS_WORLD)
+- bool LookAtXYZ(float x, float y, float z, float upX = 0.0f, float upY = 1.0f, float upZ = 0.0f, TransformSpace space = TS_WORLD)
 - void Scale(float scale)
 - void Scale(const Vector3& scale)
 - void ScaleXYZ(float x, float y, float z)
@@ -6157,6 +6157,12 @@ Properties:
 - int TEXTURE_RENDERTARGET
 - int TEXTURE_DEPTHSTENCIL
 
+### TransformSpace
+
+- int TS_LOCAL
+- int TS_PARENT
+- int TS_WORLD
+
 ### TraversalMode
 
 - int TM_BREADTH_FIRST

+ 21 - 14
Docs/ScriptAPI.dox

@@ -4273,8 +4273,8 @@ Methods:
 - bool LoadXML(const XMLElement&, bool = false)
 - Vector3 LocalToWorld(const Vector3&) const
 - Vector3 LocalToWorld(const Vector4&) const
-- bool LookAt(const Vector3&, const Vector3& = Vector3 ( 0 , 1 , 0 ))
-- void Pitch(float, bool = false)
+- bool LookAt(const Vector3&, const Vector3& = Vector3 ( 0 , 1 , 0 ), TransformSpace = TS_WORLD)
+- void Pitch(float, TransformSpace = TS_LOCAL)
 - void Remove()
 - void RemoveAllChildren()
 - void RemoveAllComponents()
@@ -4285,8 +4285,9 @@ Methods:
 - void RemoveComponents(bool, bool)
 - void RemoveInstanceDefault()
 - void ResetToDefault()
-- void Roll(float, bool = false)
-- void Rotate(const Quaternion&, bool = false)
+- void Roll(float, TransformSpace = TS_LOCAL)
+- void Rotate(const Quaternion&, TransformSpace = TS_LOCAL)
+- void RotateAround(const Vector3&, const Quaternion&, TransformSpace = TS_LOCAL)
 - bool Save(File@) const
 - bool SaveXML(File@)
 - bool SaveXML(XMLElement&) const
@@ -4302,11 +4303,10 @@ Methods:
 - void SetWorldTransform(const Vector3&, const Quaternion&)
 - void SetWorldTransform(const Vector3&, const Quaternion&, const Vector3&)
 - void SetWorldTransform(const Vector3&, const Quaternion&, float)
-- void Translate(const Vector3&)
-- void TranslateRelative(const Vector3&)
+- void Translate(const Vector3&, TransformSpace = TS_LOCAL)
 - Vector3 WorldToLocal(const Vector3&) const
 - Vector3 WorldToLocal(const Vector4&) const
-- void Yaw(float, bool = false)
+- void Yaw(float, TransformSpace = TS_LOCAL)
 
 Properties:
 
@@ -5363,8 +5363,8 @@ Methods:
 - bool LoadXML(const XMLElement&, bool = false)
 - Vector3 LocalToWorld(const Vector3&) const
 - Vector3 LocalToWorld(const Vector4&) const
-- bool LookAt(const Vector3&, const Vector3& = Vector3 ( 0 , 1 , 0 ))
-- void Pitch(float, bool = false)
+- bool LookAt(const Vector3&, const Vector3& = Vector3 ( 0 , 1 , 0 ), TransformSpace = TS_WORLD)
+- void Pitch(float, TransformSpace = TS_LOCAL)
 - void RegisterVar(const String&)
 - void Remove()
 - void RemoveAllChildren()
@@ -5376,8 +5376,9 @@ Methods:
 - void RemoveComponents(bool, bool)
 - void RemoveInstanceDefault()
 - void ResetToDefault()
-- void Roll(float, bool = false)
-- void Rotate(const Quaternion&, bool = false)
+- void Roll(float, TransformSpace = TS_LOCAL)
+- void Rotate(const Quaternion&, TransformSpace = TS_LOCAL)
+- void RotateAround(const Vector3&, const Quaternion&, TransformSpace = TS_LOCAL)
 - bool Save(File@) const
 - bool SaveXML(File@)
 - bool SaveXML(XMLElement&) const
@@ -5394,14 +5395,13 @@ Methods:
 - void SetWorldTransform(const Vector3&, const Quaternion&, float)
 - void StopAsyncLoading()
 - const String& GetVarName(ShortStringHash) const
-- void Translate(const Vector3&)
-- void TranslateRelative(const Vector3&)
+- void Translate(const Vector3&, TransformSpace = TS_LOCAL)
 - void UnregisterAllVars(const String&)
 - void UnregisterVar(const String&)
 - void Update(float)
 - Vector3 WorldToLocal(const Vector3&) const
 - Vector3 WorldToLocal(const Vector4&) const
-- void Yaw(float, bool = false)
+- void Yaw(float, TransformSpace = TS_LOCAL)
 
 Properties:
 
@@ -8787,6 +8787,13 @@ Properties:
 - TEXTURE_DEPTHSTENCIL
 
 
+### TransformSpace
+
+- TS_LOCAL
+- TS_PARENT
+- TS_WORLD
+
+
 ### TraversalMode
 
 - TM_BREADTH_FIRST