SVector3.h

 
 
 
 
#pragma once
 
#include "RshPluginScript/RshPluginScriptDefines.h"
#include "RshPluginScript/SClass/SObject.h"
 
#ifndef FCT_DOC
namespace rsh::ScriptBinding
{
#endif // !FCT_DOC
 
class SVector : public SObject
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
 
public slots: // these functions (slots) will be available in QtScript
    // TESTED
     Number GetX() ;
    // TESTED
      SetX(Number X);
 
    // TESTED
     Number GetY() ;
    // TESTED
      SetY(Number Y);
 
    // TESTED
     Number GetZ() ;
    // TESTED
      SetZ(Number Z);
 
    // TESTED
    Number GetLength() ;
 
    // TESTED
    SVector SetNormed();
 
    // TESTED
     Normalize();
 
    // TESTED
    SVector GetNormalized();
 
    // TESTED
    Boolean IsNull() ;
 
    // TESTED
     Opposite();
 
    // TESTED
    Boolean Equals( SVector VectToCompare) ;
 
    // TESTED
    SVector Div(Number Div) ;
 
    // TESTED
    SVector Mult(Number Multiplicateur) ;
 
    // TESTED
    SVector Add( SVector Vecteur) ;
 
    // TESTED
    SVector Sub( SVector Vecteur) ;
 
    // TESTED
     ApplyTransformation( SMatrix iMatrix);
 
     String toString() ;
 
    String ValuesToString() ;
};
 
// @brief
// this class allow to wrap static function to SVector easily
// this allow to wrap constructor more easily the constructor will be declared with the function New(...)
class SVector
#ifndef FCT_DOC
    : public SObjectStatic
#endif // FCT_DOC
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
 
public slots:
    // TESTED
    static SVector New();
 
    // TESTED
    static SVector New( SVector Other);
 
    // TESTED
    static SVector New(
        Number X, 
        Number Y, 
        Number Z 
    );
 
    // TESTED
    static SVector New(SPoint StartPt, SPoint EndPt);
 
    // TESTED
    static SVector New(SPoint EndPt);
 
    // TESTED
    static Number Dot(
         SVector V1, 
         SVector V2 
    );
 
    // TESTED
    static SVector Cross(
         SVector V1,  SVector V2);
 
    // TESTED
    static Number Angle( SVector V1,  SVector V2);
 
    static String toString();
};
Q_DECLARE_METATYPE(SVector::_SVectorDummy);
Q_DECLARE_METATYPE(SVector);
 
#ifndef FCT_DOC
} // namespace rsh::ScriptBinding
#endif // !FCT_DOC