SCylinder.h

 
 
 
 
#pragma once
 
#include "RshPluginScript/RshPluginScriptDefines.h"
#include "RshPluginScript/SClass/SFeature.h"
 
#ifndef FCT_DOC
namespace rsh::ScriptBinding
{
#endif // !FCT_DOC
 
class SCylinder : public SFeature
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
public slots: // these functions (slots) will be available in QtScript
 
    // TESTED
    Number GetRadius() ;
    // TESTED
     SetRadius(Number Radius 
    );
 
    // TESTED
    Number GetLength() ;
    // TESTED
     SetLength(Number Length 
    );
 
    Boolean IsOuter() ;
 
     SetInner();
 
     SetOuter();
 
    // TESTED
    Number GetSurface() ;
 
    // TESTED
    Array Discretize(
        Number deflection, 
        Number meanPointDistance
    ) ;
 
    // TESTED
    SPoint GetBaseCenter() ;
    // TESTED
    SPoint GetTopCenter() ;
 
    // TESTED
    SCircle GetBaseCircle() ;
    // TESTED
    SCircle GetTopCircle() ;
 
    // TESTED
    Number Distance(SPoint iPoint 
    ) ;
 
    String toString() ;
};
 
// @brief
// This class allows to wrap static functions to SCylinder easily.
// This allows to wrap constructors more easily, constructors will be declared with the function New(...)
class SCylinder
#ifndef FCT_DOC
    : public SObjectStatic
#endif // FCT_DOC
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
public slots:
    // TESTED
    static SCylinder New();
 
    // TESTED
    static SCylinder New(SCylinder Other);
 
    // TESTED
    static SCylinder New(
        SPoint Center, 
         SVector NormalDir, 
        Number Radius, 
        Number Length 
    );
 
    // TESTED
    static SCylinder New(
        SPoint FirstPt, 
        SPoint SecondPt, 
        SPoint ThirdPt, 
        SPoint FourthPt 
    );
 
    static Array FromClick() { return SComp::GetFromClick<SCylinder>(SV_CYLINDER); }
 
    // TESTED
    static Array FromName( String Name) { return SComp::GetFromName<SCylinder>(Name); }
 
    // TESTED
    static Array FromSel() { return SFeature::GetFromSel<SCylinder>(); }
 
    // TESTED
    static Array All(
        Number VisCrit
    )
    {
        return SComp::GetAll<SCylinder>(VisCrit);
    }
 
    static String toString();
};
Q_DECLARE_METATYPE(SCylinder::_SCylinderDummy);
Q_DECLARE_METATYPE(SCylinder);
 
#ifndef FCT_DOC
} // namespace rsh::ScriptBinding
#endif // !FCT_DOC