OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    ProjLib_ProjectOnPlane Class Reference

    Class used to project a 3d curve on a plane. The result will be a 3d curve. More...

    #include <ProjLib_ProjectOnPlane.hxx>

    Inheritance diagram for ProjLib_ProjectOnPlane:

    Public Member Functions

     ProjLib_ProjectOnPlane ()
     Empty constructor.
     ProjLib_ProjectOnPlane (const gp_Ax3 &Pl)
     The projection will be normal to the Plane defined by the Ax3 <Pl>.
     ProjLib_ProjectOnPlane (const gp_Ax3 &Pl, const gp_Dir &D)
     The projection will be along the direction <D> on the plane defined by the Ax3 <Pl>. raises if the direction <D> is parallel to the plane <Pl>.
    occ::handle< Adaptor3d_Curve > ShallowCopy () const override
     Shallow copy of adaptor.
    void Load (const occ::handle< Adaptor3d_Curve > &C, const double Tolerance, const bool KeepParametrization=true)
     Sets the Curve and perform the projection. if <KeepParametrization> is true, the parametrization of the Projected Curve <PC> will be the same as the parametrization of the initial curve . It means: proj(C(u)) = PC(u) for each u. Otherwise, the parametrization may change.
    const gp_Ax3 & GetPlane () const
    const gp_Dir & GetDirection () const
    const occ::handle< Adaptor3d_Curve > & GetCurve () const
    const occ::handle< GeomAdaptor_Curve > & GetResult () const
    double FirstParameter () const override
    double LastParameter () const override
    GeomAbs_Shape Continuity () const override
    int NbIntervals (const GeomAbs_Shape S) const override
     If necessary, breaks the curve in intervals of continuity . And returns the number of intervals.
    void Intervals (NCollection_Array1< double > &T, const GeomAbs_Shape S) const override
     Stores in <T> the parameters bounding the intervals of continuity .
    occ::handle< Adaptor3d_Curve > Trim (const double First, const double Last, const double Tol) const override
     Returns a curve equivalent of <me> between parameters <First> and <Last>. <Tol> is used to test for 3d points confusion. If <First> >= <Last>.
    bool IsClosed () const override
    bool IsPeriodic () const override
    double Period () const override
    gp_Pnt EvalD0 (const double theU) const final
     Computes the point of parameter theU on the curve.
    Geom_Curve::ResD1 EvalD1 (const double theU) const final
     Computes the point of parameter theU on the curve with its first derivative. Raised if the continuity of the current interval is not C1.
    Geom_Curve::ResD2 EvalD2 (const double theU) const final
     Returns the point and the first and second derivatives at parameter theU. Raised if the continuity of the current interval is not C2.
    Geom_Curve::ResD3 EvalD3 (const double theU) const final
     Returns the point and the first, second and third derivatives at parameter theU. Raised if the continuity of the current interval is not C3.
    gp_Vec EvalDN (const double theU, const int theN) const final
     Returns the derivative of order theN at parameter theU. Raised if the continuity of the current interval is not CN. Raised if theN < 1.
    double Resolution (const double R3d) const override
     Returns the parametric resolution corresponding to the real space resolution <R3d>.
    GeomAbs_CurveType GetType () const override
     Returns the type of the curve in the current interval: Line, Circle, Ellipse, Hyperbola, Parabola, BezierCurve, BSplineCurve, OtherCurve.
    gp_Lin Line () const override
    gp_Circ Circle () const override
    gp_Elips Ellipse () const override
    gp_Hypr Hyperbola () const override
    gp_Parab Parabola () const override
    int Degree () const override
    bool IsRational () const override
    int NbPoles () const override
    int NbKnots () const override
    occ::handle< Geom_BezierCurve > Bezier () const override
     Warning ! this will NOT make a copy of the Bezier Curve : If you want to modify the Curve please make a copy yourself Also it will NOT trim the surface to myFirst/Last.
    occ::handle< Geom_BSplineCurve > BSpline () const override
     Warning ! this will NOT make a copy of the BSpline Curve : If you want to modify the Curve please make a copy yourself Also it will NOT trim the surface to myFirst/Last.
    Public Member Functions inherited from Adaptor3d_Curve
    gp_Pnt Value (const double theU) const
     Computes the point of parameter U on the curve.
    void D0 (const double theU, gp_Pnt &theP) const
     Computes the point of parameter U on the curve.
    void D1 (const double theU, gp_Pnt &theP, gp_Vec &theV) const
     Computes the point of parameter U on the curve with its first derivative. Raised if the continuity of the current interval is not C1.
    void D2 (const double theU, gp_Pnt &theP, gp_Vec &theV1, gp_Vec &theV2) const
     Returns the point P of parameter U, the first and second derivatives V1 and V2. Raised if the continuity of the current interval is not C2.
    void D3 (const double theU, gp_Pnt &theP, gp_Vec &theV1, gp_Vec &theV2, gp_Vec &theV3) const
     Returns the point P of parameter U, the first, the second and the third derivative. Raised if the continuity of the current interval is not C3.
    gp_Vec DN (const double theU, const int theN) const
     The returned vector gives the value of the derivative for the order of derivation N. Raised if the continuity of the current interval is not CN. Raised if N < 1.
    virtual occ::handle< Geom_OffsetCurve > OffsetCurve () const
     ~Adaptor3d_Curve () override
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transient & operator= (const Standard_Transient &)
     Assignment operator, needed to avoid copying reference counter.
    virtual ~Standard_Transient ()=default
     Destructor must be virtual.
    virtual const opencascade::handle< Standard_Type > & DynamicType () const
     Returns a type descriptor about this object.
    bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
     Returns a true value if this is an instance of Type.
    bool IsInstance (const char *const theTypeName) const
     Returns a true value if this is an instance of TypeName.
    bool IsKind (const opencascade::handle< Standard_Type > &theType) const
     Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
    bool IsKind (const char *const theTypeName) const
     Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
    Standard_Transient * This () const
     Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
    int GetRefCount () const noexcept
     Get the reference counter of this object.
    void IncrementRefCounter () noexcept
     Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
    int DecrementRefCounter () noexcept
     Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
    virtual void Delete () const
     Memory deallocator for transient classes.

    Protected Member Functions

    void GetTrimmedResult (const occ::handle< Geom_Curve > &theProjCurve)
    bool BuildParabolaByApex (occ::handle< Geom_Curve > &theGeomParabolaPtr)
    bool BuildHyperbolaByApex (occ::handle< Geom_Curve > &theGeomParabolaPtr)
    void BuildByApprox (const double theLimitParameter)

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    static constexpr const char * get_type_name ()
     Returns a type descriptor about this object.
    static const opencascade::handle< Standard_Type > & get_type_descriptor ()
     Returns type descriptor of Standard_Transient class.

    Detailed Description

    Class used to project a 3d curve on a plane. The result will be a 3d curve.

    You can ask the projected curve to have the same parametrization as the original curve.

    The projection can be done along every direction not parallel to the plane.

    Constructor & Destructor Documentation

    ◆ ProjLib_ProjectOnPlane() [1/3]

    ProjLib_ProjectOnPlane::ProjLib_ProjectOnPlane ( )

    Empty constructor.

    ◆ ProjLib_ProjectOnPlane() [2/3]

    ProjLib_ProjectOnPlane::ProjLib_ProjectOnPlane ( const gp_Ax3 & Pl)

    The projection will be normal to the Plane defined by the Ax3 <Pl>.

    ◆ ProjLib_ProjectOnPlane() [3/3]

    ProjLib_ProjectOnPlane::ProjLib_ProjectOnPlane ( const gp_Ax3 & Pl,
    const gp_Dir & D )

    The projection will be along the direction <D> on the plane defined by the Ax3 <Pl>. raises if the direction <D> is parallel to the plane <Pl>.

    Member Function Documentation

    ◆ Bezier()

    occ::handle< Geom_BezierCurve > ProjLib_ProjectOnPlane::Bezier ( ) const
    overridevirtual

    Warning ! this will NOT make a copy of the Bezier Curve : If you want to modify the Curve please make a copy yourself Also it will NOT trim the surface to myFirst/Last.

    Reimplemented from Adaptor3d_Curve.

    ◆ BSpline()

    occ::handle< Geom_BSplineCurve > ProjLib_ProjectOnPlane::BSpline ( ) const
    overridevirtual

    Warning ! this will NOT make a copy of the BSpline Curve : If you want to modify the Curve please make a copy yourself Also it will NOT trim the surface to myFirst/Last.

    Reimplemented from Adaptor3d_Curve.

    ◆ BuildByApprox()

    void ProjLib_ProjectOnPlane::BuildByApprox ( const double theLimitParameter)
    protected

    ◆ BuildHyperbolaByApex()

    bool ProjLib_ProjectOnPlane::BuildHyperbolaByApex ( occ::handle< Geom_Curve > & theGeomParabolaPtr)
    protected

    ◆ BuildParabolaByApex()

    bool ProjLib_ProjectOnPlane::BuildParabolaByApex ( occ::handle< Geom_Curve > & theGeomParabolaPtr)
    protected

    ◆ Circle()

    gp_Circ ProjLib_ProjectOnPlane::Circle ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ Continuity()

    GeomAbs_Shape ProjLib_ProjectOnPlane::Continuity ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ Degree()

    int ProjLib_ProjectOnPlane::Degree ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ Ellipse()

    gp_Elips ProjLib_ProjectOnPlane::Ellipse ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ EvalD0()

    gp_Pnt ProjLib_ProjectOnPlane::EvalD0 ( const double theU) const
    nodiscardfinalvirtual

    Computes the point of parameter theU on the curve.

    Reimplemented from Adaptor3d_Curve.

    ◆ EvalD1()

    Geom_Curve::ResD1 ProjLib_ProjectOnPlane::EvalD1 ( const double theU) const
    nodiscardfinalvirtual

    Computes the point of parameter theU on the curve with its first derivative. Raised if the continuity of the current interval is not C1.

    Reimplemented from Adaptor3d_Curve.

    ◆ EvalD2()

    Geom_Curve::ResD2 ProjLib_ProjectOnPlane::EvalD2 ( const double theU) const
    nodiscardfinalvirtual

    Returns the point and the first and second derivatives at parameter theU. Raised if the continuity of the current interval is not C2.

    Reimplemented from Adaptor3d_Curve.

    ◆ EvalD3()

    Geom_Curve::ResD3 ProjLib_ProjectOnPlane::EvalD3 ( const double theU) const
    nodiscardfinalvirtual

    Returns the point and the first, second and third derivatives at parameter theU. Raised if the continuity of the current interval is not C3.

    Reimplemented from Adaptor3d_Curve.

    ◆ EvalDN()

    gp_Vec ProjLib_ProjectOnPlane::EvalDN ( const double theU,
    const int theN ) const
    nodiscardfinalvirtual

    Returns the derivative of order theN at parameter theU. Raised if the continuity of the current interval is not CN. Raised if theN < 1.

    Reimplemented from Adaptor3d_Curve.

    ◆ FirstParameter()

    double ProjLib_ProjectOnPlane::FirstParameter ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ GetCurve()

    const occ::handle< Adaptor3d_Curve > & ProjLib_ProjectOnPlane::GetCurve ( ) const

    ◆ GetDirection()

    const gp_Dir & ProjLib_ProjectOnPlane::GetDirection ( ) const

    ◆ GetPlane()

    const gp_Ax3 & ProjLib_ProjectOnPlane::GetPlane ( ) const

    ◆ GetResult()

    const occ::handle< GeomAdaptor_Curve > & ProjLib_ProjectOnPlane::GetResult ( ) const

    ◆ GetTrimmedResult()

    void ProjLib_ProjectOnPlane::GetTrimmedResult ( const occ::handle< Geom_Curve > & theProjCurve)
    protected

    ◆ GetType()

    GeomAbs_CurveType ProjLib_ProjectOnPlane::GetType ( ) const
    overridevirtual

    Returns the type of the curve in the current interval: Line, Circle, Ellipse, Hyperbola, Parabola, BezierCurve, BSplineCurve, OtherCurve.

    Reimplemented from Adaptor3d_Curve.

    ◆ Hyperbola()

    gp_Hypr ProjLib_ProjectOnPlane::Hyperbola ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ Intervals()

    void ProjLib_ProjectOnPlane::Intervals ( NCollection_Array1< double > & T,
    const GeomAbs_Shape S ) const
    overridevirtual

    Stores in <T> the parameters bounding the intervals of continuity .

    The array must provide enough room to accommodate for the parameters. i.e. T.Length() > NbIntervals()

    Reimplemented from Adaptor3d_Curve.

    ◆ IsClosed()

    bool ProjLib_ProjectOnPlane::IsClosed ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ IsPeriodic()

    bool ProjLib_ProjectOnPlane::IsPeriodic ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ IsRational()

    bool ProjLib_ProjectOnPlane::IsRational ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ LastParameter()

    double ProjLib_ProjectOnPlane::LastParameter ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ Line()

    gp_Lin ProjLib_ProjectOnPlane::Line ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ Load()

    void ProjLib_ProjectOnPlane::Load ( const occ::handle< Adaptor3d_Curve > & C,
    const double Tolerance,
    const bool KeepParametrization = true )

    Sets the Curve and perform the projection. if <KeepParametrization> is true, the parametrization of the Projected Curve <PC> will be the same as the parametrization of the initial curve . It means: proj(C(u)) = PC(u) for each u. Otherwise, the parametrization may change.

    ◆ NbIntervals()

    int ProjLib_ProjectOnPlane::NbIntervals ( const GeomAbs_Shape S) const
    overridevirtual

    If necessary, breaks the curve in intervals of continuity . And returns the number of intervals.

    Reimplemented from Adaptor3d_Curve.

    ◆ NbKnots()

    int ProjLib_ProjectOnPlane::NbKnots ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ NbPoles()

    int ProjLib_ProjectOnPlane::NbPoles ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ Parabola()

    gp_Parab ProjLib_ProjectOnPlane::Parabola ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ Period()

    double ProjLib_ProjectOnPlane::Period ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ Resolution()

    double ProjLib_ProjectOnPlane::Resolution ( const double R3d) const
    overridevirtual

    Returns the parametric resolution corresponding to the real space resolution <R3d>.

    Reimplemented from Adaptor3d_Curve.

    ◆ ShallowCopy()

    occ::handle< Adaptor3d_Curve > ProjLib_ProjectOnPlane::ShallowCopy ( ) const
    overridevirtual

    Shallow copy of adaptor.

    Reimplemented from Adaptor3d_Curve.

    ◆ Trim()

    occ::handle< Adaptor3d_Curve > ProjLib_ProjectOnPlane::Trim ( const double First,
    const double Last,
    const double Tol ) const
    overridevirtual

    Returns a curve equivalent of <me> between parameters <First> and <Last>. <Tol> is used to test for 3d points confusion. If <First> >= <Last>.

    Reimplemented from Adaptor3d_Curve.


    The documentation for this class was generated from the following file: