SMatrix.h

 
 
 
 
#pragma once
 
#include "RshPluginScript/RshPluginScriptDefines.h"
#include "RshPluginScript/SClass/SObject.h"
 
#ifndef FCT_DOC
namespace rsh::ScriptBinding
{
#endif // !FCT_DOC
 
class SMatrix : public SObject
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
public:
    enum ConstraintFlag
    {
        TRANSLATION_X, 
        TRANSLATION_Y, 
        TRANSLATION_Z, 
        ROTATION_X, 
        ROTATION_Y, 
        ROTATION_Z, 
        ALL_MOVEMENT
    };
 
    enum UnitEnum
    {
        RADIAN,
        DEGREE};
 
    enum SequenceEnum
    {
        OrderXYZ, // * 0: Applied in order X->Y->Z such that R = Rz*Ry*Rx. This is the Euler convention
        //   In aerial photogrammetric measurements this transformation corresponds to the OPK sequence
        //   also called (Omega Phi Kappa) with Omega, Phi=Ry and Kappa=Rz.
        OrderYXZ, // * 1: Applied in order Y->X->Z such that R=Rz*Rx*Ry.
        //   In aerial photogrammetric measurements this transformation corresponds to the POK sequence
        //   also called (Phi Omega Kappa) with Omega, Phi=Ry and Kappa=Rz.
        OrderZXY// * 2: Applied in order Z->X->Y such that R=Ry*Rx*Rz.
        //   In terrestrial photogrammetric measurements this transformation corresponds to the POK sequence
        //   also called (Phi Omega Kappa) with Omega, Kappa=Ry and Phi=Rz.
    };
 
public slots: // these functions (slots) will be available in QtScript
    // TESTED
     ApplyTransformation( SMatrix iMatrixToMul);
 
    // TESTED
     InitIdentity();
 
     InitQuaternion(
        Number w, Number x, Number y, Number z 
    );
 
    // TESTED
    Boolean IsIdentity() ;
 
    // TESTED
    Array InitInverse(SMatrix Mat 
    );
 
    // TESTED
    Array InitRot(
        SPoint iAxisPt, 
         SVector iAxisVect, 
        Number iAngle, 
        UnitEnum iUnit 
    );
 
    Array InitRot(
        Number AngX, 
        Number AngY, 
        Number AngZ, 
        UnitEnum Unit, 
        SequenceEnum Sequence, 
        SPoint OriginPoint 
    );
 
    // TESTED
     InitScale(
        SPoint ScaleCenter, 
        Number XScale, 
        Number YScale, 
        Number ZScale 
    );
 
     InitMirrorPnt(SPoint iMirrorCenter);
 
     InitMirrorAxis(SPoint iAxisP1, SPoint iAxisP2);
 
     InitMirrorPlane(SPoint iPlanePnt,  SVector NormalVect);
 
    // TESTED
    Array InitAlign(
        SPoint iFixed_P1, 
        SPoint iFixed_P2, 
        SPoint iMobile_P1, 
        SPoint iMobile_P2 
    );
 
    // TESTED
    Array InitAlign(
        SPoint iFixed_P1, 
        SPoint iFixed_P2, 
        SPoint iFixed_P3, 
        SPoint iMobile_P1, 
        SPoint iMobile_P2, 
        SPoint iMobile_P3 
    );
 
    Array InitAutoRoughAlign(
        SComp RefComp, 
        SComp CompToAlign 
    );
 
    // TESTED
    Array InitBestAlign(
        Array<SPoint> TargetPoints, 
        Array<SPoint> SourcePoints, 
        Number Mode, 
        ConstraintFlag ConstraintBitMask, 
        SPoint FixedPoint, 
        SVector ConstraintAxis
    );
 
    // TESTED
    Array InitBestTranslate(
         Array<SPoint> TargetPoints, 
         Array<SPoint> SourcePoints 
    );
 
    // TESTED
    Array InitBestRotate(
         Array<SPoint> TargetPoints, 
         Array<SPoint> SourcePoints, 
        SPoint iFixPoint 
    );
 
    Array InitRPSAlignment(
         Array<SPoint> TargetPoints, 
         Array<SPoint> SourcePoints, 
         Array<Array<Boolean>> XYZ_Constraints, 
        Array<SCloud> AssociatedClouds, 
        Number Neighborhood
    );
 
    Number GetValue(
        Number Row, 
        Number Column 
    );
 
    Array GetEuler(UnitEnum Unit 
    );
 
     String toString() ;
 
    String ValuesToString() ;
 
    Number UpdateUCS( String Name);
 
    // @note (not in the documentation)
    // if no error occurred the ownership is taken by the DComptree
    // TESTED
    Number AddToDocAsUCS(
         String Name, 
        Boolean IsActivated
    );
};
 
// @brief
// this class allow to wrap static function to SMatrix easily
// this allow to wrap constructor more easily the constructor will be declared with the function New(...)
class SMatrix
#ifndef FCT_DOC
    : public SObjectStatic
#endif // FCT_DOC
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
 
public slots:
    // TESTED
    static SMatrix New();
 
    // TESTED
    static SMatrix New( SMatrix Other);
 
    // TESTED
    static SMatrix New(
         SVector TranslateVector);
 
    // TESTED
    static SMatrix New(
        SPoint AxisPt, 
         SVector AxisVect, 
        Number Angle, 
        UnitEnum Unit 
    );
 
    // TESTED
    static SMatrix New(
         Array<Number> Row1, 
         Array<Number> Row2, 
         Array<Number> Row3 
    );
 
    // TESTED
    static Array BestFitCompute(
         Array<SComp> CompTable, 
        Number ThresDist, 
        Number BestFitType, 
        ConstraintFlag ConstraintBitMask, 
        SPoint FixedPoint, 
        SVector ConstraintAxis, 
        Boolean iAttractReversedNormals
    );
 
    static String toString();
 
    // TESTED
    Array UpdateArmCoordinateSystem(
        Number Index, 
         SMatrix NewMatrix 
    );
 
    // TESTED
    Array SaveArmCoordinateSystem(
        Number Index, 
         SMatrix NewMatrix 
    );
 
    // TESTED
    Array GetArmCoordinateSystem(Number Index 
    );
 
    static Array FromUCS( String Name);
 
    static Array FromActiveCS();
};
Q_DECLARE_METATYPE(SMatrix::_SMatrixDummy);
Q_DECLARE_METATYPE(SMatrix);
 
#ifndef FCT_DOC
} // namespace rsh::ScriptBinding
#endif // !FCT_DOC