SPlane.h

 
 
 
 
#pragma once
 
#include "RshPluginScript/RshPluginScriptDefines.h"
#include "RshPluginScript/SClass/SFeature.h"
 
#ifndef FCT_DOC
namespace rsh::ScriptBinding
{
#endif // !FCT_DOC
 
class SPlane : public SFeature
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
 
public slots: // these functions (slots) will be available in QtScript
 
 
    // TESTED
    Number GetSurface() ;
 
    // TESTED
    Number GetLength() ;
    // TESTED
     SetLength(Number iLength);
    // TESTED
    Number GetWidth() ;
    // TESTED
     SetWidth(Number iWidth);
    SVector GetXDir() ;
    SVector GetYDir() ;
 
    // TESTED
    Array Discretize(
        Number deflection, 
        Number meanPointDistance
    ) ;
 
    // TESTED
    Number Distance(SPoint iPoint 
    ) ;
 
    Array Proj3D(SPoint iPointToProject 
    ) ;
 
    Array Proj3D(SMultiline iMultilineToProject 
    ) ;
 
    Array ProjDir(
        SPoint iPointToProject, 
         SVector iProjectionVector 
    ) ;
 
    Array ProjDir(
        SMultiline iMultilineToProject, 
         SVector Direction 
    ) ;
 
    Array FitPlaneToBoundingBox3D(
        SPoint iLowerPoint, 
        SPoint iUpperPoint, 
        Boolean iMoveCenter, 
        Number iScale 
    );
 
    Array BestSymmetryPlane(
        SComp iSelComp, 
        Number iOption
    );
 
    Array IntersectionBetween2Planes(SPlane iSecondPlane 
    );
 
    String toString() ;
};
 
#pragma region SPlane
// @brief
// this class allow to wrap static function to SPlane easily
// this allow to wrap constructor more easily the constructor will be declared with the function New(...)
class SPlane
#ifndef FCT_DOC
    : public SObjectStatic
#endif // FCT_DOC
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
 
public slots:
    // TESTED
    static SPlane New();
 
    // TESTED
    static SPlane New(SPlane Other);
 
    // TESTED
    static SPlane New(
        SPoint Center, 
         SVector Normal, 
         SVector XDir, 
         Number Length, 
         Number Width 
    );
 
    // TESTED
    static SPlane New(
        SPoint Center, 
         SVector Normal 
    );
 
    // TESTED
    static SPlane New(
        SPoint FirstPt, 
        SPoint SecondPt, 
        SPoint ThirdPt 
    );
 
    static Array FromClick() { return SComp::GetFromClick<SPlane>(SV_PLANE); }
 
    // TESTED
    static Array FromName( String Name) { return SComp::GetFromName<SPlane>(Name); }
 
    // TESTED
    static Array FromSel() { return SFeature::GetFromSel<SPlane>(); }
 
    // TESTED
    static Array All(
        Number VisCrit
    )
    {
        return SComp::GetAll<SPlane>(VisCrit);
    }
 
    static String toString();
};
Q_DECLARE_METATYPE(SPlane::_SPlaneDummy);
Q_DECLARE_METATYPE(SPlane);
 
#pragma endregion
 
#ifndef FCT_DOC
} // namespace rsh::ScriptBinding
#endif // !FCT_DOC