OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    Geom_SurfaceOfLinearExtrusion Class Reference

    Describes a surface of linear extrusion ("extruded surface"), e.g. a generalized cylinder. Such a surface is obtained by sweeping a curve (called the "extruded curve" or "basis") in a given direction (referred to as the "direction of extrusion" and defined by a unit vector). The u parameter is along the extruded curve. The v parameter is along the direction of extrusion. The parameter range for the u parameter is defined by the reference curve. The parameter range for the v parameter is ] - infinity, + infinity [. The position of the curve gives the origin of the v parameter. The surface is "CN" in the v parametric direction. The form of a surface of linear extrusion is generally a ruled surface (GeomAbs_RuledForm). It can be: More...

    #include <Geom_SurfaceOfLinearExtrusion.hxx>

    Inheritance diagram for Geom_SurfaceOfLinearExtrusion:

    Public Member Functions

     Geom_SurfaceOfLinearExtrusion (const occ::handle< Geom_Curve > &C, const gp_Dir &V)
     V is the direction of extrusion. C is the extruded curve. The form of a SurfaceOfLinearExtrusion can be : . ruled surface (RuledForm), . a cylindrical surface if the extruded curve is a circle or a trimmed circle (CylindricalForm), . a plane surface if the extruded curve is a Line (PlanarForm). Warnings : Degenerated surface cases are not detected. For example if the curve C is a line and V is parallel to the direction of this line.
    bool HasEvalRepresentation () const
     Returns true if an evaluation representation is attached.
    const occ::handle< GeomEval_RepSurfaceDesc::Base > & EvalRepresentation () const
     Returns the current evaluation representation descriptor (may be null).
    void SetEvalRepresentation (const occ::handle< GeomEval_RepSurfaceDesc::Base > &theDesc)
     Sets a new evaluation representation. Validates descriptor data and ensures no circular references.
    void ClearEvalRepresentation ()
     Removes the evaluation representation.
    void SetDirection (const gp_Dir &V)
     Assigns V as the "direction of extrusion" for this surface of linear extrusion.
    void SetBasisCurve (const occ::handle< Geom_Curve > &C)
     Modifies this surface of linear extrusion by redefining its "basis curve" (the "extruded curve").
    void UReverse () final
     Changes the orientation of this surface of linear extrusion in the u parametric direction. The bounds of the surface are not changed, but the given parametric direction is reversed. Hence the orientation of the surface is reversed. In the case of a surface of linear extrusion:
    double UReversedParameter (const double U) const final
     Computes the u parameter on the modified surface, produced by reversing its u parametric direction, for any point of u parameter U on this surface of linear extrusion. In the case of an extruded surface:
    void VReverse () final
     Changes the orientation of this surface of linear extrusion in the v parametric direction. The bounds of the surface are not changed, but the given parametric direction is reversed. Hence the orientation of the surface is reversed. In the case of a surface of linear extrusion:
    double VReversedParameter (const double V) const final
     Computes the v parameter on the modified surface, produced by reversing its u v parametric direction, for any point of v parameter V on this surface of linear extrusion. In the case of an extruded surface VReverse returns -V.
    void Bounds (double &U1, double &U2, double &V1, double &V2) const final
     Returns the parametric bounds U1, U2, V1 and V2 of this surface of linear extrusion. A surface of linear extrusion is infinite in the v parametric direction, so:
    bool IsUClosed () const final
     IsUClosed returns true if the "basis curve" of this surface of linear extrusion is closed.
    bool IsVClosed () const final
     IsVClosed always returns false.
    bool IsCNu (const int N) const final
     IsCNu returns true if the degree of continuity for the "basis curve" of this surface of linear extrusion is at least N. Raises RangeError if N < 0.
    bool IsCNv (const int N) const final
     IsCNv always returns true.
    bool IsUPeriodic () const final
     IsUPeriodic returns true if the "basis curve" of this surface of linear extrusion is periodic.
    bool IsVPeriodic () const final
     IsVPeriodic always returns false.
    occ::handle< Geom_Curve > UIso (const double U) const final
     Computes the U isoparametric curve of this surface of linear extrusion. This is the line parallel to the direction of extrusion, passing through the point of parameter U of the basis curve.
    occ::handle< Geom_Curve > VIso (const double V) const final
     Computes the V isoparametric curve of this surface of linear extrusion. This curve is obtained by translating the extruded curve in the direction of extrusion, with the magnitude V.
    gp_Pnt EvalD0 (const double U, const double V) const final
     Computes the point P (U, V) on the surface. The parameter U is the parameter on the extruded curve. The parametrization V is a linear parametrization, and the direction of parametrization is the direction of extrusion. If the point is on the extruded curve, V = 0.0 Raises an exception on failure.
    Geom_Surface::ResD1 EvalD1 (const double U, const double V) const final
     Computes the point and first partial derivatives at (U, V). Raises an exception if the surface continuity is not C1.
    Geom_Surface::ResD2 EvalD2 (const double U, const double V) const final
     Computes the point and partial derivatives up to 2nd order at (U, V). Raises an exception if the surface continuity is not C2.
    Geom_Surface::ResD3 EvalD3 (const double U, const double V) const final
     Computes the point and partial derivatives up to 3rd order at (U, V). Raises an exception if the surface continuity is not C3.
    gp_Vec EvalDN (const double U, const double V, const int Nu, const int Nv) const final
     Computes the derivative of order Nu in U and Nv in V at (U, V). Raises an exception on failure. Raises RangeError if Nu + Nv < 1 or Nu < 0 or Nv < 0.
    void Transform (const gp_Trsf &T) final
     Applies the transformation T to this surface of linear extrusion.
    void TransformParameters (double &U, double &V, const gp_Trsf &T) const final
     Computes the parameters on the transformed surface for the transform of the point of parameters U,V on <me>.
    gp_GTrsf2d ParametricTransformation (const gp_Trsf &T) const final
     Returns a 2d transformation used to find the new parameters of a point on the transformed surface.
    occ::handle< Geom_Geometry > Copy () const final
     Creates a new object which is a copy of this surface of linear extrusion.
    void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const final
     Dumps the content of me into the stream.
    Public Member Functions inherited from Geom_SweptSurface
    GeomAbs_Shape Continuity () const override
     returns the continuity of the surface : C0 : only geometric continuity, C1 : continuity of the first derivative all along the surface, C2 : continuity of the second derivative all along the surface, C3 : continuity of the third derivative all along the surface, G1 : tangency continuity all along the surface, G2 : curvature continuity all along the surface, CN : the order of continuity is infinite.
    const gp_Dir & Direction () const
     Returns the reference direction of the swept surface. For a surface of revolution it is the direction of the revolution axis, for a surface of linear extrusion it is the direction of extrusion.
    occ::handle< Geom_Curve > BasisCurve () const
     Returns the referenced curve of the surface. For a surface of revolution it is the revolution curve, for a surface of linear extrusion it is the extruded curve.
    void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
     Dumps the content of me into the stream.
    Public Member Functions inherited from Geom_Surface
    occ::handle< Geom_Surface > UReversed () const
     Reverses the U direction of parametrization of <me>. The bounds of the surface are not modified. A copy of <me> is returned.
    occ::handle< Geom_Surface > VReversed () const
     Reverses the V direction of parametrization of <me>. The bounds of the surface are not modified. A copy of <me> is returned.
    virtual double UPeriod () const
     Returns the period of this surface in the u parametric direction. Raises if the surface is not uperiodic.
    virtual double VPeriod () const
     Returns the period of this surface in the v parametric direction. raises if the surface is not vperiodic.
    void D0 (const double U, const double V, gp_Pnt &P) const
     Computes the point of parameter (U, V).
    void D1 (const double U, const double V, gp_Pnt &P, gp_Vec &D1U, gp_Vec &D1V) const
     Computes the point and first partial derivatives.
    void D2 (const double U, const double V, gp_Pnt &P, gp_Vec &D1U, gp_Vec &D1V, gp_Vec &D2U, gp_Vec &D2V, gp_Vec &D2UV) const
     Computes the point and partial derivatives up to 2nd order.
    void D3 (const double U, const double V, gp_Pnt &P, gp_Vec &D1U, gp_Vec &D1V, gp_Vec &D2U, gp_Vec &D2V, gp_Vec &D2UV, gp_Vec &D3U, gp_Vec &D3V, gp_Vec &D3UUV, gp_Vec &D3UVV) const
     Computes the point and partial derivatives up to 3rd order.
    gp_Vec DN (const double U, const double V, const int Nu, const int Nv) const
     Computes the derivative of order Nu in U and Nv in V.
    gp_Pnt Value (const double U, const double V) const
     Computes the point of parameter (U, V) on the surface.
    Public Member Functions inherited from Geom_Geometry
    void Mirror (const gp_Pnt &P)
     Performs the symmetrical transformation of a Geometry with respect to the point P which is the center of the symmetry.
    void Mirror (const gp_Ax1 &A1)
     Performs the symmetrical transformation of a Geometry with respect to an axis placement which is the axis of the symmetry.
    void Mirror (const gp_Ax2 &A2)
     Performs the symmetrical transformation of a Geometry with respect to a plane. The axis placement A2 locates the plane of the symmetry : (Location, XDirection, YDirection).
    void Rotate (const gp_Ax1 &A1, const double Ang)
     Rotates a Geometry. A1 is the axis of the rotation. Ang is the angular value of the rotation in radians.
    void Scale (const gp_Pnt &P, const double S)
     Scales a Geometry. S is the scaling value.
    void Translate (const gp_Vec &V)
     Translates a Geometry. V is the vector of the translation.
    void Translate (const gp_Pnt &P1, const gp_Pnt &P2)
     Translates a Geometry from the point P1 to the point P2.
    occ::handle< Geom_Geometry > Mirrored (const gp_Pnt &P) const
    occ::handle< Geom_Geometry > Mirrored (const gp_Ax1 &A1) const
    occ::handle< Geom_Geometry > Mirrored (const gp_Ax2 &A2) const
    occ::handle< Geom_Geometry > Rotated (const gp_Ax1 &A1, const double Ang) const
    occ::handle< Geom_Geometry > Scaled (const gp_Pnt &P, const double S) const
    occ::handle< Geom_Geometry > Transformed (const gp_Trsf &T) const
    occ::handle< Geom_Geometry > Translated (const gp_Vec &V) const
    occ::handle< Geom_Geometry > Translated (const gp_Pnt &P1, const gp_Pnt &P2) const
    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.

    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.
    Protected Attributes inherited from Geom_SweptSurface
    occ::handle< Geom_Curve > basisCurve
    gp_Dir direction
    GeomAbs_Shape smooth

    Detailed Description

    Describes a surface of linear extrusion ("extruded surface"), e.g. a generalized cylinder. Such a surface is obtained by sweeping a curve (called the "extruded curve" or "basis") in a given direction (referred to as the "direction of extrusion" and defined by a unit vector). The u parameter is along the extruded curve. The v parameter is along the direction of extrusion. The parameter range for the u parameter is defined by the reference curve. The parameter range for the v parameter is ] - infinity, + infinity [. The position of the curve gives the origin of the v parameter. The surface is "CN" in the v parametric direction. The form of a surface of linear extrusion is generally a ruled surface (GeomAbs_RuledForm). It can be:

    • a cylindrical surface, if the extruded curve is a circle, or a trimmed circle, with an axis parallel to the direction of extrusion (GeomAbs_CylindricalForm), or
    • a planar surface, if the extruded curve is a line (GeomAbs_PlanarForm). Note: The surface of extrusion is built from a copy of the original basis curve, so the original curve is not modified when the surface is modified. Warning Degenerate surfaces are not detected. A degenerate surface is obtained, for example, when the extruded curve is a line and the direction of extrusion is parallel to that line.

    Constructor & Destructor Documentation

    ◆ Geom_SurfaceOfLinearExtrusion()

    Geom_SurfaceOfLinearExtrusion::Geom_SurfaceOfLinearExtrusion ( const occ::handle< Geom_Curve > & C,
    const gp_Dir & V )

    V is the direction of extrusion. C is the extruded curve. The form of a SurfaceOfLinearExtrusion can be : . ruled surface (RuledForm), . a cylindrical surface if the extruded curve is a circle or a trimmed circle (CylindricalForm), . a plane surface if the extruded curve is a Line (PlanarForm). Warnings : Degenerated surface cases are not detected. For example if the curve C is a line and V is parallel to the direction of this line.

    Member Function Documentation

    ◆ Bounds()

    void Geom_SurfaceOfLinearExtrusion::Bounds ( double & U1,
    double & U2,
    double & V1,
    double & V2 ) const
    finalvirtual

    Returns the parametric bounds U1, U2, V1 and V2 of this surface of linear extrusion. A surface of linear extrusion is infinite in the v parametric direction, so:

    • V1 = double::RealFirst()
    • V2 = double::RealLast().

    Implements Geom_Surface.

    ◆ ClearEvalRepresentation()

    void Geom_SurfaceOfLinearExtrusion::ClearEvalRepresentation ( )
    inline

    Removes the evaluation representation.

    ◆ Copy()

    occ::handle< Geom_Geometry > Geom_SurfaceOfLinearExtrusion::Copy ( ) const
    finalvirtual

    Creates a new object which is a copy of this surface of linear extrusion.

    Implements Geom_Geometry.

    ◆ DumpJson()

    void Geom_SurfaceOfLinearExtrusion::DumpJson ( Standard_OStream & theOStream,
    int theDepth = -1 ) const
    finalvirtual

    Dumps the content of me into the stream.

    Reimplemented from Geom_Surface.

    ◆ EvalD0()

    gp_Pnt Geom_SurfaceOfLinearExtrusion::EvalD0 ( const double U,
    const double V ) const
    finalvirtual

    Computes the point P (U, V) on the surface. The parameter U is the parameter on the extruded curve. The parametrization V is a linear parametrization, and the direction of parametrization is the direction of extrusion. If the point is on the extruded curve, V = 0.0 Raises an exception on failure.

    Implements Geom_Surface.

    ◆ EvalD1()

    Geom_Surface::ResD1 Geom_SurfaceOfLinearExtrusion::EvalD1 ( const double U,
    const double V ) const
    finalvirtual

    Computes the point and first partial derivatives at (U, V). Raises an exception if the surface continuity is not C1.

    Implements Geom_Surface.

    ◆ EvalD2()

    Geom_Surface::ResD2 Geom_SurfaceOfLinearExtrusion::EvalD2 ( const double U,
    const double V ) const
    finalvirtual

    Computes the point and partial derivatives up to 2nd order at (U, V). Raises an exception if the surface continuity is not C2.

    Implements Geom_Surface.

    ◆ EvalD3()

    Geom_Surface::ResD3 Geom_SurfaceOfLinearExtrusion::EvalD3 ( const double U,
    const double V ) const
    finalvirtual

    Computes the point and partial derivatives up to 3rd order at (U, V). Raises an exception if the surface continuity is not C3.

    Implements Geom_Surface.

    ◆ EvalDN()

    gp_Vec Geom_SurfaceOfLinearExtrusion::EvalDN ( const double U,
    const double V,
    const int Nu,
    const int Nv ) const
    finalvirtual

    Computes the derivative of order Nu in U and Nv in V at (U, V). Raises an exception on failure. Raises RangeError if Nu + Nv < 1 or Nu < 0 or Nv < 0.

    Implements Geom_Surface.

    ◆ EvalRepresentation()

    const occ::handle< GeomEval_RepSurfaceDesc::Base > & Geom_SurfaceOfLinearExtrusion::EvalRepresentation ( ) const
    inline

    Returns the current evaluation representation descriptor (may be null).

    ◆ HasEvalRepresentation()

    bool Geom_SurfaceOfLinearExtrusion::HasEvalRepresentation ( ) const
    inline

    Returns true if an evaluation representation is attached.

    ◆ IsCNu()

    bool Geom_SurfaceOfLinearExtrusion::IsCNu ( const int N) const
    finalvirtual

    IsCNu returns true if the degree of continuity for the "basis curve" of this surface of linear extrusion is at least N. Raises RangeError if N < 0.

    Implements Geom_Surface.

    ◆ IsCNv()

    bool Geom_SurfaceOfLinearExtrusion::IsCNv ( const int N) const
    finalvirtual

    IsCNv always returns true.

    Implements Geom_Surface.

    ◆ IsUClosed()

    bool Geom_SurfaceOfLinearExtrusion::IsUClosed ( ) const
    finalvirtual

    IsUClosed returns true if the "basis curve" of this surface of linear extrusion is closed.

    Implements Geom_Surface.

    ◆ IsUPeriodic()

    bool Geom_SurfaceOfLinearExtrusion::IsUPeriodic ( ) const
    finalvirtual

    IsUPeriodic returns true if the "basis curve" of this surface of linear extrusion is periodic.

    Implements Geom_Surface.

    ◆ IsVClosed()

    bool Geom_SurfaceOfLinearExtrusion::IsVClosed ( ) const
    finalvirtual

    IsVClosed always returns false.

    Implements Geom_Surface.

    ◆ IsVPeriodic()

    bool Geom_SurfaceOfLinearExtrusion::IsVPeriodic ( ) const
    finalvirtual

    IsVPeriodic always returns false.

    Implements Geom_Surface.

    ◆ ParametricTransformation()

    gp_GTrsf2d Geom_SurfaceOfLinearExtrusion::ParametricTransformation ( const gp_Trsf & T) const
    finalvirtual

    Returns a 2d transformation used to find the new parameters of a point on the transformed surface.

    me->Transformed(T)->Value(U',V')

    is the same point as

    me->Value(U,V).Transformed(T)

    Where U',V' are obtained by transforming U,V with the 2d transformation returned by

    me->ParametricTransformation(T)

    This method returns a scale U by BasisCurve()->ParametricTransformation(T) V by T.ScaleFactor()

    Reimplemented from Geom_Surface.

    ◆ SetBasisCurve()

    void Geom_SurfaceOfLinearExtrusion::SetBasisCurve ( const occ::handle< Geom_Curve > & C)

    Modifies this surface of linear extrusion by redefining its "basis curve" (the "extruded curve").

    ◆ SetDirection()

    void Geom_SurfaceOfLinearExtrusion::SetDirection ( const gp_Dir & V)

    Assigns V as the "direction of extrusion" for this surface of linear extrusion.

    ◆ SetEvalRepresentation()

    void Geom_SurfaceOfLinearExtrusion::SetEvalRepresentation ( const occ::handle< GeomEval_RepSurfaceDesc::Base > & theDesc)

    Sets a new evaluation representation. Validates descriptor data and ensures no circular references.

    ◆ Transform()

    void Geom_SurfaceOfLinearExtrusion::Transform ( const gp_Trsf & T)
    finalvirtual

    Applies the transformation T to this surface of linear extrusion.

    Implements Geom_Geometry.

    ◆ TransformParameters()

    void Geom_SurfaceOfLinearExtrusion::TransformParameters ( double & U,
    double & V,
    const gp_Trsf & T ) const
    finalvirtual

    Computes the parameters on the transformed surface for the transform of the point of parameters U,V on <me>.

    me->Transformed(T)->Value(U',V')

    is the same point as

    me->Value(U,V).Transformed(T)

    Where U',V' are the new values of U,V after calling

    me->TransformParameters(U,V,T)

    This method multiplies: U by BasisCurve()->ParametricTransformation(T) V by T.ScaleFactor()

    Reimplemented from Geom_Surface.

    ◆ UIso()

    occ::handle< Geom_Curve > Geom_SurfaceOfLinearExtrusion::UIso ( const double U) const
    finalvirtual

    Computes the U isoparametric curve of this surface of linear extrusion. This is the line parallel to the direction of extrusion, passing through the point of parameter U of the basis curve.

    Implements Geom_Surface.

    ◆ UReverse()

    void Geom_SurfaceOfLinearExtrusion::UReverse ( )
    finalvirtual

    Changes the orientation of this surface of linear extrusion in the u parametric direction. The bounds of the surface are not changed, but the given parametric direction is reversed. Hence the orientation of the surface is reversed. In the case of a surface of linear extrusion:

    • UReverse reverses the basis curve, and
    • VReverse reverses the direction of linear extrusion.

    Implements Geom_Surface.

    ◆ UReversedParameter()

    double Geom_SurfaceOfLinearExtrusion::UReversedParameter ( const double U) const
    finalvirtual

    Computes the u parameter on the modified surface, produced by reversing its u parametric direction, for any point of u parameter U on this surface of linear extrusion. In the case of an extruded surface:

    • UReverseParameter returns the reversed parameter given by the function ReversedParameter called with U on the basis curve,

    Implements Geom_Surface.

    ◆ VIso()

    occ::handle< Geom_Curve > Geom_SurfaceOfLinearExtrusion::VIso ( const double V) const
    finalvirtual

    Computes the V isoparametric curve of this surface of linear extrusion. This curve is obtained by translating the extruded curve in the direction of extrusion, with the magnitude V.

    Implements Geom_Surface.

    ◆ VReverse()

    void Geom_SurfaceOfLinearExtrusion::VReverse ( )
    finalvirtual

    Changes the orientation of this surface of linear extrusion in the v parametric direction. The bounds of the surface are not changed, but the given parametric direction is reversed. Hence the orientation of the surface is reversed. In the case of a surface of linear extrusion:

    • UReverse reverses the basis curve, and
    • VReverse reverses the direction of linear extrusion.

    Implements Geom_Surface.

    ◆ VReversedParameter()

    double Geom_SurfaceOfLinearExtrusion::VReversedParameter ( const double V) const
    finalvirtual

    Computes the v parameter on the modified surface, produced by reversing its u v parametric direction, for any point of v parameter V on this surface of linear extrusion. In the case of an extruded surface VReverse returns -V.

    Implements Geom_Surface.


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