*
* @since 2.0
*
- * The %FloatMatrix4 class provides a @c float precision, two-dimensional matrix class.
+ * The %FloatMatrix4 class provides a @c float precision, two-dimensional matrix.
*
*/
class _OSP_EXPORT_ FloatMatrix4
public:
/**
* This is the default constructor for this class. @n
- * Constructs a 4 X 4 null matrix in which all elements are zero.
+ * Constructs a 4 X 4 null matrix in which all the elements are zero.
*
* @since 2.0
*/
*
* @since 2.0
*
- * @param[in] rhs An instance of %FloatMatrix4
+ * @param[in] rhs An instance of %FloatMatrix4 to copy
*/
FloatMatrix4(const FloatMatrix4& rhs);
FloatMatrix4(const float matrix[4][4]);
/**
- * TThis destructor overrides Tizen::Base::Object::~Object().
+ * This destructor overrides Tizen::Base::Object::~Object().
*
* @since 2.0
*/
*
* @since 2.0
*
- * @return @c true if all matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n
+ * @return @c true if all the matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n
* else @c false
* @param[in] rhs An instance of %FloatMatrix4
*/
*
* @since 2.0
*
- * @return @c true if all matrix members of the current instance are not equal to the corresponding matrix members in the specified instance, @n
+ * @return @c true if all the matrix members of the current instance are not equal to the corresponding matrix members in the specified instance, @n
* else @c false
* @param[in] rhs An instance of %FloatMatrix4
*/
*
* @since 2.0
*
- * @return The reference to this instance
- * @param[in] rhs An instance of %FloatMatrix4
+ * @return A reference to this instance
+ * @param[in] rhs An instance of %FloatMatrix4 to copy
*/
FloatMatrix4& operator =(const FloatMatrix4& rhs);
*
* @since 2.0
*
- * @return The reference to this instance
- * @param[in] value A @c float value to assign
+ * @return A reference to this instance
+ * @param[in] value The @c float value to assign
*/
FloatMatrix4& operator =(float value);
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix4 containing the resulting value of the operation
+ * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation
* @param[in] rhs An instance of %FloatMatrix4
*/
FloatMatrix4 operator *(const FloatMatrix4& rhs) const;
/**
- * Multiplies the value to each matrix members of current instance of %FloatMatrix4.
+ * Multiplies the value to each matrix member of the current instance of %FloatMatrix4.
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix4 containing the resulting value of the operation
- * @param[in] value A @c float value to multiply
+ * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation
+ * @param[in] value The @c float value to multiply
*/
FloatMatrix4 operator *(float value) const;
/**
- * Adds the value of the specified instance and the current instance of %FloatMatrix4.
+ * Adds the value of the specified instance to the current instance of %FloatMatrix4.
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix4 containing the resulting value of the operation
+ * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation
* @param[in] rhs An instance of %FloatMatrix4
*/
FloatMatrix4 operator +(const FloatMatrix4& rhs) const;
/**
- * Adds the value to each matrix members of current instance of %FloatMatrix4.
+ * Adds the value to each matrix member of the current instance of %FloatMatrix4.
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix4 containing the resulting value of the operation
- * @param[in] value A @c float value to add
+ * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation
+ * @param[in] value The @c float value to add
*/
FloatMatrix4 operator +(float value) const;
/**
- * Subtracts the value of the specified instance and the current instance of %FloatMatrix4.
+ * Subtracts the value of the specified instance from the current instance of %FloatMatrix4.
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix4 containing the resulting value of the operation
+ * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation
* @param[in] rhs An instance of %FloatMatrix4
*/
FloatMatrix4 operator -(const FloatMatrix4& rhs) const;
/**
- * Subtracts the value from each matrix members of current instance of %FloatMatrix4.
+ * Subtracts the value from each matrix member of the current instance of %FloatMatrix4.
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix4 containing the resulting value of the operation
- * @param[in] value A @c float value to subtract
+ * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation
+ * @param[in] value The @c float value to subtract
*/
FloatMatrix4 operator -(float value) const;
/**
- * Multiplies the value of the specified instance and the current instance of %FloatMatrix4.
+ * Multiplies the value of the specified instance with the current instance of %FloatMatrix4.
*
* @since 2.0
*
- * @return The reference to %FloatMatrix4 containing the resulting value of the operation
+ * @return A reference to %FloatMatrix4 that contains the resulting value of the operation
* @param[in] rhs An instance of %FloatMatrix4
*/
FloatMatrix4& operator *=(const FloatMatrix4& rhs);
/**
- * Multiplies the value to each matrix members of current instance of %FloatMatrix4.
+ * Multiplies the value to each matrix member of the current instance of %FloatMatrix4.
*
* @since 2.0
*
- * @return The reference to %FloatMatrix4 containing the resulting value of the operation
- * @param[in] value A @c float value to multiply
+ * @return A reference to %FloatMatrix4 that contains the resulting value of the operation
+ * @param[in] value The @c float value to multiply
*/
FloatMatrix4& operator *=(float value);
*
* @since 2.0
*
- * @return The reference to %FloatMatrix4 containing the resulting value of the operation
+ * @return A reference to %FloatMatrix4 that contains the resulting value of the operation
* @param[in] rhs An instance of %FloatMatrix4
*/
FloatMatrix4& operator +=(const FloatMatrix4& rhs);
/**
- * Adds the value to each matrix members of current instance of %FloatMatrix4.
+ * Adds the value to each matrix member of the current instance of %FloatMatrix4.
*
* @since 2.0
*
- * @return The reference to %FloatMatrix4 containing the resulting value of the operation
- * @param[in] value A @c float value to add
+ * @return A reference to %FloatMatrix4 that contains the resulting value of the operation
+ * @param[in] value The @c float value to add
*/
FloatMatrix4& operator +=(float value);
*
* @since 2.0
*
- * @return The reference to %FloatMatrix4 containing the resulting value of the operation
+ * @return A reference to %FloatMatrix4 that contains the resulting value of the operation
* @param[in] rhs An instance of %FloatMatrix4
*/
FloatMatrix4& operator -=(const FloatMatrix4& rhs);
/**
- * Subtracts the value from each matrix members of current instance of %FloatMatrix4.
+ * Subtracts the value from each matrix member of the current instance of %FloatMatrix4.
*
* @since 2.0
*
- * @return The reference to %FloatMatrix4 containing the resulting value of the operation
- * @param[in] value A @c float value to subtract
+ * @return A reference to %FloatMatrix4 that contains the resulting value of the operation
+ * @param[in] value The @c float value to subtract
*/
FloatMatrix4& operator -=(float value);
/**
- * Gets the instance of %FloatMatrix4 resulting from the sum of the value and the specified instance of %FloatMatrix4.
+ * Gets an instance of %FloatMatrix4 resulting from the sum of the value and the specified instance of %FloatMatrix4.
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix4 containing the resulting value of the operation
- * @param[in] value A @c float value to add
+ * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation
+ * @param[in] value The @c float value to add
* @param[in] rhs An instance of %FloatMatrix4
*/
_OSP_EXPORT_ friend FloatMatrix4 operator +(const float& value, const FloatMatrix4& rhs);
/**
- * Gets the instance of %FloatMatrix4 resulting from the product of the value and the specified instance of %FloatMatrix4.
+ * Gets an instance of %FloatMatrix4 resulting from the product of the value and the specified instance of %FloatMatrix4.
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix4 containing the resulting value of the operation
- * @param[in] value A @c float value to multiply
+ * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation
+ * @param[in] value The @c float value to multiply
* @param[in] rhs An instance of %FloatMatrix4
*/
_OSP_EXPORT_ friend FloatMatrix4 operator *(const float& value, const FloatMatrix4& rhs);
/**
- * Gets the instance of %FloatMatrix4 resulting from the difference between the value and the specified instance of %FloatMatrix4.
+ * Gets an instance of %FloatMatrix4 resulting from the difference between the value and the specified instance of %FloatMatrix4.
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix4 containing the resulting value of the operation
- * @param[in] value A @c float value to subtract
+ * @return A new instance of %FloatMatrix4 that containsg the resulting value of the operation
+ * @param[in] value The @c float value to subtract
* @param[in] rhs An instance of %FloatMatrix4
*/
_OSP_EXPORT_ friend FloatMatrix4 operator -(const float& value, const FloatMatrix4& rhs);
* @return @c true if the values of the current instance is equal to the value of the specified instance, @n
* else @c false
* @param[in] obj An instance of %FloatMatrix4
- * @remarks This method overrides Tizen::Base::Object::Equals(). This method uses the values of the Matrix components to compare the two instances.
+ * @remarks
+ * - This method overrides Tizen::Base::Object::Equals().
+ * - This method uses the values of the Matrix components to compare the two instances.
*/
virtual bool Equals(const Tizen::Base::Object& obj) const;
* @since 2.0
*
* @return The hash value of the current instance
- * @remarks Two equal instances must return the same hash value. For better performance,
- * the used hash function must generate a random distribution for all inputs.
+ * @remarks Two equal instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(void) const;
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix4 containing the resulting value of the operation
+ * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation
* @remarks This function must be called after checking whether the matrix is invertible or not.
*/
FloatMatrix4 GetInverse(void) const;
*
* @since 2.0
*
- * @return A new instance of %FloatMatrix4 containing the resulting value of the operation
+ * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation
*/
FloatMatrix4 GetTranspose(void) const;
bool IsInvertible(void) const;
/**
- * Negates the matrix members of current instance of %FloatMatrix4.
+ * Negates the matrix members of the current instance of %FloatMatrix4.
*
* @since 2.0
*/
void Transpose(void);
/**
- * Sets the matrix members of current instance of %FloatMatrix4 to zero.
+ * Sets the matrix members of the current instance of %FloatMatrix4 to zero.
*
* @since 2.0
*/