Browse Source

Travis CI: API documentation update at 2015-04-27 07:37:18 UTC.
[ci package]

urho3d-travis-ci 10 years ago
parent
commit
3591990e24
4 changed files with 333 additions and 8 deletions
  1. 125 3
      Docs/AngelScriptAPI.h
  2. 100 1
      Docs/LuaScriptAPI.dox
  3. 107 3
      Docs/ScriptAPI.dox
  4. 1 1
      Source/Urho3D/.soversion

+ 125 - 3
Docs/AngelScriptAPI.h

@@ -4305,6 +4305,49 @@ Frustum Transformed(const Matrix3x4&) const;
 Array<Vector3> vertices;
 };
 
+class Geometry
+{
+// Methods:
+void SendEvent(const String&, VariantMap& = VariantMap ( ));
+bool SetDrawRange(PrimitiveType, uint, uint, bool = true);
+bool SetDrawRange(PrimitiveType, uint, uint, uint, uint, bool = true);
+void SetIndexBuffer(IndexBuffer);
+bool SetVertexBuffer(uint, VertexBuffer, uint = MASK_DEFAULT);
+
+// Properties:
+/* readonly */
+StringHash baseType;
+/* readonly */
+String category;
+/* readonly */
+bool empty;
+IndexBuffer indexBuffer;
+/* readonly */
+uint indexCount;
+/* readonly */
+uint indexStart;
+float lodDistance;
+uint numVertexBuffers;
+/* readonly */
+PrimitiveType primitiveType;
+/* readonly */
+int refs;
+/* readonly */
+StringHash type;
+/* readonly */
+String typeName;
+/* readonly */
+Array<VertexBuffer> vertexBuffers;
+/* readonly */
+uint vertexCount;
+/* readonly */
+Array<uint> vertexElementMasks;
+/* readonly */
+uint vertexStart;
+/* readonly */
+int weakRefs;
+};
+
 class Graphics
 {
 // Methods:
@@ -4522,6 +4565,37 @@ int weakRefs;
 int width;
 };
 
+class IndexBuffer
+{
+// Methods:
+VectorBuffer GetData();
+void SendEvent(const String&, VariantMap& = VariantMap ( ));
+bool SetData(VectorBuffer&);
+bool SetDataRange(VectorBuffer&, uint, uint, bool = false);
+void SetSize(uint, bool, bool = false);
+
+// Properties:
+/* readonly */
+StringHash baseType;
+/* readonly */
+String category;
+/* readonly */
+bool dynamic;
+/* readonly */
+uint indexCount;
+/* readonly */
+uint indexSize;
+/* readonly */
+int refs;
+bool shadowed;
+/* readonly */
+StringHash type;
+/* readonly */
+String typeName;
+/* readonly */
+int weakRefs;
+};
+
 class Input
 {
 // Methods:
@@ -5748,25 +5822,25 @@ class Model
 {
 // Methods:
 Model Clone(const String& = String ( )) const;
+Geometry GetGeometry(uint, uint) const;
 bool Load(File);
 bool Load(VectorBuffer&);
 bool Save(File) const;
 bool Save(VectorBuffer&) const;
 void SendEvent(const String&, VariantMap& = VariantMap ( ));
+bool SetGeometry(uint, uint, Geometry);
 
 // Properties:
 /* readonly */
 StringHash baseType;
-/* readonly */
 BoundingBox boundingBox;
 /* readonly */
 String category;
+Array<Vector3> geometryCenters;
 /* readonly */
 uint memoryUse;
 String name;
-/* readonly */
 uint numGeometries;
-/* readonly */
 Array<uint> numGeometryLodLevels;
 /* readonly */
 uint numMorphs;
@@ -11354,6 +11428,39 @@ uint position;
 uint size;
 };
 
+class VertexBuffer
+{
+// Methods:
+VectorBuffer GetData();
+void SendEvent(const String&, VariantMap& = VariantMap ( ));
+bool SetData(VectorBuffer&);
+bool SetDataRange(VectorBuffer&, uint, uint, bool = false);
+void SetSize(uint, uint, bool = false);
+
+// Properties:
+/* readonly */
+StringHash baseType;
+/* readonly */
+String category;
+/* readonly */
+bool dynamic;
+/* readonly */
+uint elementMask;
+/* readonly */
+int refs;
+bool shadowed;
+/* readonly */
+StringHash type;
+/* readonly */
+String typeName;
+/* readonly */
+uint vertexCount;
+/* readonly */
+uint vertexSize;
+/* readonly */
+int weakRefs;
+};
+
 class View3D
 {
 // Methods:
@@ -12790,6 +12897,21 @@ int LOG_INFO;
 int LOG_NONE;
 int LOG_WARNING;
 Color MAGENTA;
+uint MASK_BLENDINDICES;
+uint MASK_BLENDWEIGHTS;
+uint MASK_COLOR;
+uint MASK_CUBETEXCOORD1;
+uint MASK_CUBETEXCOORD2;
+uint MASK_DEFAULT;
+uint MASK_INSTANCEMATRIX1;
+uint MASK_INSTANCEMATRIX2;
+uint MASK_INSTANCEMATRIX3;
+uint MASK_NONE;
+uint MASK_NORMAL;
+uint MASK_POSITION;
+uint MASK_TANGENT;
+uint MASK_TEXCOORD1;
+uint MASK_TEXCOORD2;
 int MOUSEB_LEFT;
 int MOUSEB_MIDDLE;
 int MOUSEB_RIGHT;

+ 100 - 1
Docs/LuaScriptAPI.dox

@@ -81,9 +81,11 @@ namespace Urho3D
 <a href="#Class_FocusParameters"><b>FocusParameters</b></a>
 <a href="#Class_Font"><b>Font</b></a>
 <a href="#Class_Frustum"><b>Frustum</b></a>
+<a href="#Class_Geometry"><b>Geometry</b></a>
 <a href="#Class_Graphics"><b>Graphics</b></a>
 <a href="#Class_HttpRequest"><b>HttpRequest</b></a>
 <a href="#Class_Image"><b>Image</b></a>
+<a href="#Class_IndexBuffer"><b>IndexBuffer</b></a>
 <a href="#Class_Input"><b>Input</b></a>
 <a href="#Class_IntRect"><b>IntRect</b></a>
 <a href="#Class_IntVector2"><b>IntVector2</b></a>
@@ -191,6 +193,7 @@ namespace Urho3D
 <a href="#Class_Vector3"><b>Vector3</b></a>
 <a href="#Class_Vector4"><b>Vector4</b></a>
 <a href="#Class_VectorBuffer"><b>VectorBuffer</b></a>
+<a href="#Class_VertexBuffer"><b>VertexBuffer</b></a>
 <a href="#Class_View3D"><b>View3D</b></a>
 <a href="#Class_Viewport"><b>Viewport</b></a>
 <a href="#Class_Window"><b>Window</b></a>
@@ -2184,6 +2187,44 @@ Methods:
 - Rect Projected(const Matrix4& transform) const
 - void UpdatePlanes()
 
+<a name="Class_Geometry"></a>
+### Geometry : Object
+
+Methods:
+
+- Geometry() (GC)
+- Geometry* new()
+- void delete()
+- bool SetNumVertexBuffers(unsigned num)
+- bool SetVertexBuffer(unsigned index, VertexBuffer* buffer, unsigned elementMask = MASK_DEFAULT)
+- void SetIndexBuffer(IndexBuffer* buffer)
+- bool SetDrawRange(PrimitiveType type, unsigned indexStart, unsigned indexCount, bool getUsedVertexRange = true)
+- bool SetDrawRange(PrimitiveType type, unsigned indexStart, unsigned indexCount, unsigned vertexStart, unsigned vertexCount, bool checkIllegal = true)
+- void SetLodDistance(float distance)
+- unsigned GetNumVertexBuffers() const
+- VertexBuffer* GetVertexBuffer(unsigned index) const
+- unsigned GetVertexElementMask(unsigned index) const
+- IndexBuffer* GetIndexBuffer() const
+- PrimitiveType GetPrimitiveType() const
+- unsigned GetIndexStart() const
+- unsigned GetIndexCount() const
+- unsigned GetVertexStart() const
+- unsigned GetVertexCount() const
+- float GetLodDistance()
+- bool IsEmpty() const
+
+Properties:
+
+- unsigned numVertexBuffers
+- IndexBuffer* indexBuffer
+- PrimitiveType primitiveType (readonly)
+- unsigned indexStart (readonly)
+- unsigned indexCount (readonly)
+- unsigned vertexStart (readonly)
+- unsigned vertexCount (readonly)
+- float lodDistance
+- bool empty (readonly)
+
 <a name="Class_Graphics"></a>
 ### Graphics : Object
 
@@ -2359,6 +2400,31 @@ Properties:
 - CompressedFormat compressedFormat (readonly)
 - unsigned numCompressedLevels (readonly)
 
+<a name="Class_IndexBuffer"></a>
+### IndexBuffer : Object
+
+Methods:
+
+- IndexBuffer() (GC)
+- IndexBuffer* new()
+- void delete()
+- void SetShadowed(bool enable)
+- bool SetSize(unsigned indexCount, bool largeIndices, bool dynamic = false)
+- bool SetData(VectorBuffer& data)
+- bool SetDataRange(VectorBuffer& data, unsigned start, unsigned count, bool discard = false)
+- VectorBuffer GetData()
+- bool IsShadowed() const
+- bool IsDynamic() const
+- unsigned GetIndexCount() const
+- unsigned GetIndexSize() const
+
+Properties:
+
+- bool shadowed
+- bool dynamic (readonly)
+- unsigned indexCount (readonly)
+- unsigned indexSize (readonly)
+
 <a name="Class_Input"></a>
 ### Input : Object
 
@@ -3118,11 +3184,17 @@ Properties:
 Methods:
 
 - Model* Clone(const String cloneName = String::EMPTY) const
+- void SetBoundingBox(const BoundingBox& box)
+- void SetNumGeometries(unsigned num)
+- bool SetNumGeometryLodLevels(unsigned index, unsigned num)
+- bool SetGeometry(unsigned index, unsigned lodLevel, Geometry* geometry)
+- bool SetGeometryCenter(unsigned index, const Vector3& center)
 - const BoundingBox& GetBoundingBox() const
 - Skeleton& GetSkeleton()
 - unsigned GetNumGeometries() const
 - unsigned GetNumGeometryLodLevels(unsigned index) const
 - Geometry* GetGeometry(unsigned index, unsigned lodLevel) const
+- const Vector3& GetGeometryCenter(unsigned index) const
 - unsigned GetNumMorphs() const
 - const ModelMorph* GetMorph(const String name) const
 - const ModelMorph* GetMorph(StringHash nameHash) const
@@ -3132,7 +3204,7 @@ Methods:
 
 Properties:
 
-- BoundingBox& boundingBox (readonly)
+- BoundingBox& boundingBox
 - Skeleton skeleton (readonly)
 - unsigned numGeometries (readonly)
 - unsigned numMorphs (readonly)
@@ -6528,6 +6600,33 @@ Properties:
 - unsigned size (readonly)
 - bool eof (readonly)
 
+<a name="Class_VertexBuffer"></a>
+### VertexBuffer : Object
+
+Methods:
+
+- VertexBuffer() (GC)
+- VertexBuffer* new()
+- void delete()
+- void SetShadowed(bool enable)
+- bool SetSize(unsigned vertexCount, unsigned elementMask, bool dynamic = false)
+- bool SetData(VectorBuffer& data)
+- bool SetDataRange(VectorBuffer& data, unsigned start, unsigned count, bool discard = false)
+- VectorBuffer GetData()
+- bool IsShadowed() const
+- bool IsDynamic() const
+- unsigned GetVertexCount() const
+- unsigned GetVertexSize() const
+- unsigned GetElementMask() const
+
+Properties:
+
+- bool shadowed
+- bool dynamic (readonly)
+- unsigned vertexCount (readonly)
+- unsigned vertexSize (readonly)
+- unsigned elementMask (readonly)
+
 <a name="Class_View3D"></a>
 ### View3D : Window
 

+ 107 - 3
Docs/ScriptAPI.dox

@@ -2128,9 +2128,11 @@ namespace Urho3D
 <a href="#Class_FocusParameters"><b>FocusParameters</b></a>
 <a href="#Class_Font"><b>Font</b></a>
 <a href="#Class_Frustum"><b>Frustum</b></a>
+<a href="#Class_Geometry"><b>Geometry</b></a>
 <a href="#Class_Graphics"><b>Graphics</b></a>
 <a href="#Class_HttpRequest"><b>HttpRequest</b></a>
 <a href="#Class_Image"><b>Image</b></a>
+<a href="#Class_IndexBuffer"><b>IndexBuffer</b></a>
 <a href="#Class_Input"><b>Input</b></a>
 <a href="#Class_IntRect"><b>IntRect</b></a>
 <a href="#Class_IntVector2"><b>IntVector2</b></a>
@@ -2244,6 +2246,7 @@ namespace Urho3D
 <a href="#Class_Vector3"><b>Vector3</b></a>
 <a href="#Class_Vector4"><b>Vector4</b></a>
 <a href="#Class_VectorBuffer"><b>VectorBuffer</b></a>
+<a href="#Class_VertexBuffer"><b>VertexBuffer</b></a>
 <a href="#Class_View3D"><b>View3D</b></a>
 <a href="#Class_Viewport"><b>Viewport</b></a>
 <a href="#Class_WeakHandle"><b>WeakHandle</b></a>
@@ -5968,6 +5971,38 @@ Properties:
 
 - Vector3[] vertices // readonly
 
+<a name="Class_Geometry"></a>
+
+### Geometry
+
+Methods:
+
+- void SendEvent(const String&, VariantMap& = VariantMap ( ))
+- bool SetDrawRange(PrimitiveType, uint, uint, bool = true)
+- bool SetDrawRange(PrimitiveType, uint, uint, uint, uint, bool = true)
+- void SetIndexBuffer(IndexBuffer@)
+- bool SetVertexBuffer(uint, VertexBuffer@, uint = MASK_DEFAULT)
+
+Properties:
+
+- StringHash baseType // readonly
+- String category // readonly
+- bool empty // readonly
+- IndexBuffer@ indexBuffer
+- uint indexCount // readonly
+- uint indexStart // readonly
+- float lodDistance
+- uint numVertexBuffers
+- PrimitiveType primitiveType // readonly
+- int refs // readonly
+- StringHash type // readonly
+- String typeName // readonly
+- VertexBuffer@[] vertexBuffers // readonly
+- uint vertexCount // readonly
+- uint[] vertexElementMasks // readonly
+- uint vertexStart // readonly
+- int weakRefs // readonly
+
 <a name="Class_Graphics"></a>
 
 ### Graphics
@@ -6136,6 +6171,31 @@ Properties:
 - int weakRefs // readonly
 - int width // readonly
 
+<a name="Class_IndexBuffer"></a>
+
+### IndexBuffer
+
+Methods:
+
+- VectorBuffer GetData()
+- void SendEvent(const String&, VariantMap& = VariantMap ( ))
+- bool SetData(VectorBuffer&)
+- bool SetDataRange(VectorBuffer&, uint, uint, bool = false)
+- void SetSize(uint, bool, bool = false)
+
+Properties:
+
+- StringHash baseType // readonly
+- String category // readonly
+- bool dynamic // readonly
+- uint indexCount // readonly
+- uint indexSize // readonly
+- int refs // readonly
+- bool shadowed
+- StringHash type // readonly
+- String typeName // readonly
+- int weakRefs // readonly
+
 <a name="Class_Input"></a>
 
 ### Input
@@ -7213,21 +7273,24 @@ Properties:
 Methods:
 
 - Model@ Clone(const String& = String ( )) const
+- Geometry@ GetGeometry(uint, uint) const
 - bool Load(File@)
 - bool Load(VectorBuffer&)
 - bool Save(File@) const
 - bool Save(VectorBuffer&) const
 - void SendEvent(const String&, VariantMap& = VariantMap ( ))
+- bool SetGeometry(uint, uint, Geometry@)
 
 Properties:
 
 - StringHash baseType // readonly
-- BoundingBox boundingBox // readonly
+- BoundingBox boundingBox
 - String category // readonly
+- Vector3[] geometryCenters
 - uint memoryUse // readonly
 - String name
-- uint numGeometries // readonly
-- uint[] numGeometryLodLevels // readonly
+- uint numGeometries
+- uint[] numGeometryLodLevels
 - uint numMorphs // readonly
 - int refs // readonly
 - Skeleton@ skeleton // readonly
@@ -12078,6 +12141,32 @@ Properties:
 - uint position // readonly
 - uint size // readonly
 
+<a name="Class_VertexBuffer"></a>
+
+### VertexBuffer
+
+Methods:
+
+- VectorBuffer GetData()
+- void SendEvent(const String&, VariantMap& = VariantMap ( ))
+- bool SetData(VectorBuffer&)
+- bool SetDataRange(VectorBuffer&, uint, uint, bool = false)
+- void SetSize(uint, uint, bool = false)
+
+Properties:
+
+- StringHash baseType // readonly
+- String category // readonly
+- bool dynamic // readonly
+- uint elementMask // readonly
+- int refs // readonly
+- bool shadowed
+- StringHash type // readonly
+- String typeName // readonly
+- uint vertexCount // readonly
+- uint vertexSize // readonly
+- int weakRefs // readonly
+
 <a name="Class_View3D"></a>
 
 ### View3D
@@ -13430,6 +13519,21 @@ Properties:
 - int LOG_NONE
 - int LOG_WARNING
 - Color MAGENTA
+- uint MASK_BLENDINDICES
+- uint MASK_BLENDWEIGHTS
+- uint MASK_COLOR
+- uint MASK_CUBETEXCOORD1
+- uint MASK_CUBETEXCOORD2
+- uint MASK_DEFAULT
+- uint MASK_INSTANCEMATRIX1
+- uint MASK_INSTANCEMATRIX2
+- uint MASK_INSTANCEMATRIX3
+- uint MASK_NONE
+- uint MASK_NORMAL
+- uint MASK_POSITION
+- uint MASK_TANGENT
+- uint MASK_TEXCOORD1
+- uint MASK_TEXCOORD2
 - int MOUSEB_LEFT
 - int MOUSEB_MIDDLE
 - int MOUSEB_RIGHT

+ 1 - 1
Source/Urho3D/.soversion

@@ -1 +1 @@
-0.0.91
+0.0.92