Added: Multiple doxygen @returns comments.
This commit is contained in:
@@ -51,26 +51,26 @@ public:
|
|||||||
const float &getHeight() { return _height; };
|
const float &getHeight() { return _height; };
|
||||||
const float &getDepth() { return _depth; };
|
const float &getDepth() { return _depth; };
|
||||||
const float &getWidth() { return _width; };
|
const float &getWidth() { return _width; };
|
||||||
/** Return the vector directly in middle of the bounding box. */
|
/** @returns the vector directly in middle of the bounding box. */
|
||||||
const Vector3 &getCenter() { return _centerVector; };
|
const Vector3 &getCenter() { return _centerVector; };
|
||||||
/** Return the front face (further on z-axis) */
|
/** @returns the front face (further on z-axis) */
|
||||||
const BoundingBoxFace &getFrontFace() { return _frontFace; };
|
const BoundingBoxFace &getFrontFace() { return _frontFace; };
|
||||||
/** Return the back face (nearer on z-axis) */
|
/** @returns the back face (nearer on z-axis) */
|
||||||
const BoundingBoxFace &getBackFace() { return _backFace; };
|
const BoundingBoxFace &getBackFace() { return _backFace; };
|
||||||
/** Return the left face (further on x-axis) */
|
/** @returns the left face (further on x-axis) */
|
||||||
const BoundingBoxFace &getLeftFace() { return _leftFace; };
|
const BoundingBoxFace &getLeftFace() { return _leftFace; };
|
||||||
/** Return the right face (nearer on x-axis) */
|
/** @returns the right face (nearer on x-axis) */
|
||||||
const BoundingBoxFace &getRightFace() { return _rightFace; };
|
const BoundingBoxFace &getRightFace() { return _rightFace; };
|
||||||
/** Return the top face (further on y-axis) */
|
/** @returns the top face (further on y-axis) */
|
||||||
const BoundingBoxFace &getTopFace() { return _topFace; };
|
const BoundingBoxFace &getTopFace() { return _topFace; };
|
||||||
/** Return the bottom face (nearer on y-axis) */
|
/** @returns the bottom face (nearer on y-axis) */
|
||||||
const BoundingBoxFace &getBottomFace() { return _bottomFace; };
|
const BoundingBoxFace &getBottomFace() { return _bottomFace; };
|
||||||
/**
|
/**
|
||||||
* Returns bounding box raw vertices array.
|
* @returns bounding box raw vertices array.
|
||||||
* Total length: 8
|
* Total length: 8
|
||||||
*/
|
*/
|
||||||
const Vector3 &getVertex(const u8 &i) { return _vertices[i]; };
|
const Vector3 &getVertex(const u8 &i) { return _vertices[i]; };
|
||||||
/** Returns single vertex from raw vertices array.*/
|
/** @returns single vertex from raw vertices array.*/
|
||||||
Vector3 *getVertices() { return _vertices; };
|
Vector3 *getVertices() { return _vertices; };
|
||||||
|
|
||||||
private:
|
private:
|
||||||
|
|||||||
@@ -77,19 +77,19 @@ public:
|
|||||||
MeshMaterial *getMaterials() const { return materials; };
|
MeshMaterial *getMaterials() const { return materials; };
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns bounding box (AABB).
|
* @returns bounding box (AABB).
|
||||||
* Total length: 8
|
* Total length: 8
|
||||||
*/
|
*/
|
||||||
Vector3 *getBoundingBoxVertices() { return boundingBoxObj->getVertices(); };
|
Vector3 *getBoundingBoxVertices() { return boundingBoxObj->getVertices(); };
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns bounding box (AABB) vertex.
|
* @returns bounding box (AABB) vertex.
|
||||||
* Total length: 8
|
* Total length: 8
|
||||||
*/
|
*/
|
||||||
const Vector3 &getBoundingBoxVertex(const u8 &i) { return boundingBoxObj->getVertex(i); };
|
const Vector3 &getBoundingBoxVertex(const u8 &i) { return boundingBoxObj->getVertex(i); };
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns bounding box (AABB) object pointer.
|
* @returns bounding box (AABB) object pointer.
|
||||||
*/
|
*/
|
||||||
BoundingBox *getBoundingBox() { return boundingBoxObj; };
|
BoundingBox *getBoundingBox() { return boundingBoxObj; };
|
||||||
|
|
||||||
|
|||||||
@@ -63,19 +63,19 @@ public:
|
|||||||
u32 *getNormalFaces() const { return normalFaces; };
|
u32 *getNormalFaces() const { return normalFaces; };
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns bounding box (AABB).
|
* @returns bounding box (AABB).
|
||||||
* Total length: 8
|
* Total length: 8
|
||||||
*/
|
*/
|
||||||
Vector3 *getBoundingBoxVertices() { return boundingBoxObj->getVertices(); };
|
Vector3 *getBoundingBoxVertices() { return boundingBoxObj->getVertices(); };
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns bounding box (AABB) vertex.
|
* @returns bounding box (AABB) vertex.
|
||||||
* Total length: 8
|
* Total length: 8
|
||||||
*/
|
*/
|
||||||
const Vector3 &getBoundingBoxVertex(const u8 &i) { return boundingBoxObj->getVertex(i); };
|
const Vector3 &getBoundingBoxVertex(const u8 &i) { return boundingBoxObj->getVertex(i); };
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns bounding box (AABB) object pointer.
|
* @returns bounding box (AABB) object pointer.
|
||||||
*/
|
*/
|
||||||
BoundingBox *getBoundingBox() { return boundingBoxObj; };
|
BoundingBox *getBoundingBox() { return boundingBoxObj; };
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user