OCCT3D 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_CylindricalSurface Class Reference

    This class defines the infinite cylindrical surface. More...

    #include <Geom_CylindricalSurface.hxx>

    Inheritance diagram for Geom_CylindricalSurface:

    Public Member Functions

     Geom_CylindricalSurface (const gp_Ax3 &A3, const double Radius)
     A3 defines the local coordinate system of the cylindrical surface. The "ZDirection" of A3 defines the direction of the surface's axis of symmetry. At the creation the parametrization of the surface is defined such that the normal Vector (N = D1U ^ D1V) is oriented towards the "outside region" of the surface. Warnings: It is not forbidden to create a cylindrical surface with Radius = 0.0 Raised if Radius < 0.0.
     Geom_CylindricalSurface (const gp_Cylinder &C)
     Creates a CylindricalSurface from a non transient gp_Cylinder.
    void SetCylinder (const gp_Cylinder &C)
     Set <me> so that <me> has the same geometric properties as C.
    void SetRadius (const double R)
     Changes the radius of the cylinder. Raised if R < 0.0.
    gp_Cylinder Cylinder () const
     returns a non transient cylinder with the same geometric properties as <me>.
    double UReversedParameter (const double U) const final
     Return the parameter on the Ureversed surface for the point of parameter U on <me>. Return 2.PI - U.
    double VReversedParameter (const double V) const final
     Return the parameter on the Vreversed surface for the point of parameter V on <me>. Return -V.
    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.
    void Bounds (double &U1, double &U2, double &V1, double &V2) const final
     The CylindricalSurface is infinite in the V direction so V1 = Realfirst, V2 = RealLast from package Standard. U1 = 0 and U2 = 2*PI.
    void Coefficients (double &A1, double &A2, double &A3, double &B1, double &B2, double &B3, double &C1, double &C2, double &C3, double &D) const
     Returns the coefficients of the implicit equation of the quadric in the absolute cartesian coordinate system : These coefficients are normalized.
    double Radius () const
     Returns the radius of this cylinder.
    bool IsUClosed () const final
     Returns True.
    bool IsVClosed () const final
     Returns False.
    bool IsUPeriodic () const final
     Returns True.
    bool IsVPeriodic () const final
     Returns False.
    occ::handle< Geom_CurveUIso (const double U) const final
     The UIso curve is a Line. The location point of this line is on the placement plane (XAxis, YAxis) of the surface. This line is parallel to the axis of symmetry of the surface.
    occ::handle< Geom_CurveVIso (const double V) const final
     The VIso curve is a circle. The start point of this circle (U = 0) is defined with the "XAxis" of the surface. The center of the circle is on the symmetry axis.
    gp_Pnt EvalD0 (const double U, const double V) const final
     Computes the point P (U, V) on the surface. P (U, V) = Loc + Radius * (cos (U) * XDir + sin (U) * YDir) + V * ZDir where Loc is the origin of the placement plane (XAxis, YAxis) XDir is the direction of the XAxis and YDir the direction of the YAxis.
    Geom_Surface::ResD1 EvalD1 (const double U, const double V) const final
     Computes the current point and the first derivatives in the directions U and V.
    Geom_Surface::ResD2 EvalD2 (const double U, const double V) const final
     Computes the current point, the first and the second derivatives in the directions U and V.
    Geom_Surface::ResD3 EvalD3 (const double U, const double V) const final
     Computes the current point, the first, the second and the third derivatives in the directions U and V.
    gp_Vec EvalDN (const double U, const double V, const int Nu, const int Nv) const final
     Computes the derivative of order Nu in the direction u and Nv in the direction v. Raised if Nu + Nv < 1 or Nu < 0 or Nv < 0.
    void Transform (const gp_Trsf &T) final
     Applies the transformation T to this cylinder.
    occ::handle< Geom_GeometryCopy () const final
     Creates a new object which is a copy of this cylinder.
    void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const final
     Dumps the content of me into the stream.
    Public Member Functions inherited from Geom_ElementarySurface
    void SetAxis (const gp_Ax1 &theA1)
     Changes the main axis (ZAxis) of the elementary surface.
    void SetLocation (const gp_Pnt &theLoc)
     Changes the location of the local coordinates system of the surface.
    void SetPosition (const gp_Ax3 &theAx3)
     Changes the local coordinates system of the surface.
    const gp_Ax1Axis () const
     Returns the main axis of the surface (ZAxis).
    const gp_PntLocation () const
     Returns the location point of the local coordinate system of the surface.
    const gp_Ax3Position () const
     Returns the local coordinates system of the surface.
    void UReverse () override
     Reverses the U parametric direction of the surface.
    void VReverse () override
     Reverses the V parametric direction of the surface.
    GeomAbs_Shape Continuity () const override
     Returns GeomAbs_CN, the global continuity of any elementary surface.
    bool IsCNu (const int N) const override
     Returns True.
    bool IsCNv (const int N) const override
     Returns True.
    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_SurfaceUReversed () 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_SurfaceVReversed () 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.
    void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
     Dumps the content of me into the stream.
    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_GeometryMirrored (const gp_Pnt &P) const
    occ::handle< Geom_GeometryMirrored (const gp_Ax1 &A1) const
    occ::handle< Geom_GeometryMirrored (const gp_Ax2 &A2) const
    occ::handle< Geom_GeometryRotated (const gp_Ax1 &A1, const double Ang) const
    occ::handle< Geom_GeometryScaled (const gp_Pnt &P, const double S) const
    occ::handle< Geom_GeometryTransformed (const gp_Trsf &T) const
    occ::handle< Geom_GeometryTranslated (const gp_Vec &V) const
    occ::handle< Geom_GeometryTranslated (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_Transientoperator= (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_TransientThis () 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_ElementarySurface
    gp_Ax3 pos

    Detailed Description

    This class defines the infinite cylindrical surface.

    Every cylindrical surface is set by the following equation:

    S(U,V) = Location + R*cos(U)*XAxis + R*sin(U)*YAxis + V*ZAxis,
    const gp_Pnt & Location() const
    Returns the location point of the local coordinate system of the surface.
    Definition Geom_ElementarySurface.hxx:81

    where R is cylinder radius.

    The local coordinate system of the CylindricalSurface is defined with an axis placement (see class ElementarySurface).

    The "ZAxis" is the symmetry axis of the CylindricalSurface, it gives the direction of increasing parametric value V.

    The parametrization range is :

    U [0, 2*PI], V ]- infinite, + infinite[

    The "XAxis" and the "YAxis" define the placement plane of the surface (Z = 0, and parametric value V = 0) perpendicular to the symmetry axis. The "XAxis" defines the origin of the parameter U = 0. The trigonometric sense gives the positive orientation for the parameter U.

    When you create a CylindricalSurface the U and V directions of parametrization are such that at each point of the surface the normal is oriented towards the "outside region".

    The methods UReverse VReverse change the orientation of the surface.

    Constructor & Destructor Documentation

    ◆ Geom_CylindricalSurface() [1/2]

    Geom_CylindricalSurface::Geom_CylindricalSurface ( const gp_Ax3 & A3,
    const double Radius )

    A3 defines the local coordinate system of the cylindrical surface. The "ZDirection" of A3 defines the direction of the surface's axis of symmetry. At the creation the parametrization of the surface is defined such that the normal Vector (N = D1U ^ D1V) is oriented towards the "outside region" of the surface. Warnings: It is not forbidden to create a cylindrical surface with Radius = 0.0 Raised if Radius < 0.0.

    ◆ Geom_CylindricalSurface() [2/2]

    Geom_CylindricalSurface::Geom_CylindricalSurface ( const gp_Cylinder & C)

    Creates a CylindricalSurface from a non transient gp_Cylinder.

    Member Function Documentation

    ◆ Bounds()

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

    The CylindricalSurface is infinite in the V direction so V1 = Realfirst, V2 = RealLast from package Standard. U1 = 0 and U2 = 2*PI.

    Implements Geom_Surface.

    ◆ Coefficients()

    void Geom_CylindricalSurface::Coefficients ( double & A1,
    double & A2,
    double & A3,
    double & B1,
    double & B2,
    double & B3,
    double & C1,
    double & C2,
    double & C3,
    double & D ) const

    Returns the coefficients of the implicit equation of the quadric in the absolute cartesian coordinate system : These coefficients are normalized.

    A1.X**2 + A2.Y**2 + A3.Z**2 + 2.(B1.X.Y + B2.X.Z + B3.Y.Z) + 2.(C1.X + C2.Y + C3.Z) + D = 0.0

    ◆ Copy()

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

    Creates a new object which is a copy of this cylinder.

    Implements Geom_Geometry.

    ◆ Cylinder()

    gp_Cylinder Geom_CylindricalSurface::Cylinder ( ) const

    returns a non transient cylinder with the same geometric properties as <me>.

    ◆ DumpJson()

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

    Dumps the content of me into the stream.

    Reimplemented from Geom_Geometry.

    ◆ EvalD0()

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

    Computes the point P (U, V) on the surface. P (U, V) = Loc + Radius * (cos (U) * XDir + sin (U) * YDir) + V * ZDir where Loc is the origin of the placement plane (XAxis, YAxis) XDir is the direction of the XAxis and YDir the direction of the YAxis.

    Implements Geom_Surface.

    ◆ EvalD1()

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

    Computes the current point and the first derivatives in the directions U and V.

    Implements Geom_Surface.

    ◆ EvalD2()

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

    Computes the current point, the first and the second derivatives in the directions U and V.

    Implements Geom_Surface.

    ◆ EvalD3()

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

    Computes the current point, the first, the second and the third derivatives in the directions U and V.

    Implements Geom_Surface.

    ◆ EvalDN()

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

    Computes the derivative of order Nu in the direction u and Nv in the direction v. Raised if Nu + Nv < 1 or Nu < 0 or Nv < 0.

    Implements Geom_Surface.

    ◆ IsUClosed()

    bool Geom_CylindricalSurface::IsUClosed ( ) const
    finalvirtual

    Returns True.

    Implements Geom_Surface.

    ◆ IsUPeriodic()

    bool Geom_CylindricalSurface::IsUPeriodic ( ) const
    finalvirtual

    Returns True.

    Implements Geom_Surface.

    ◆ IsVClosed()

    bool Geom_CylindricalSurface::IsVClosed ( ) const
    finalvirtual

    Returns False.

    Implements Geom_Surface.

    ◆ IsVPeriodic()

    bool Geom_CylindricalSurface::IsVPeriodic ( ) const
    finalvirtual

    Returns False.

    Implements Geom_Surface.

    ◆ ParametricTransformation()

    gp_GTrsf2d Geom_CylindricalSurface::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 centered on the U axis with T.ScaleFactor

    Reimplemented from Geom_Surface.

    ◆ Radius()

    double Geom_CylindricalSurface::Radius ( ) const

    Returns the radius of this cylinder.

    ◆ SetCylinder()

    void Geom_CylindricalSurface::SetCylinder ( const gp_Cylinder & C)

    Set <me> so that <me> has the same geometric properties as C.

    ◆ SetRadius()

    void Geom_CylindricalSurface::SetRadius ( const double R)

    Changes the radius of the cylinder. Raised if R < 0.0.

    ◆ Transform()

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

    Applies the transformation T to this cylinder.

    Implements Geom_Geometry.

    ◆ TransformParameters()

    void Geom_CylindricalSurface::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 V by T.ScaleFactor()

    Reimplemented from Geom_Surface.

    ◆ UIso()

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

    The UIso curve is a Line. The location point of this line is on the placement plane (XAxis, YAxis) of the surface. This line is parallel to the axis of symmetry of the surface.

    Implements Geom_Surface.

    ◆ UReversedParameter()

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

    Return the parameter on the Ureversed surface for the point of parameter U on <me>. Return 2.PI - U.

    Implements Geom_ElementarySurface.

    ◆ VIso()

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

    The VIso curve is a circle. The start point of this circle (U = 0) is defined with the "XAxis" of the surface. The center of the circle is on the symmetry axis.

    Implements Geom_Surface.

    ◆ VReversedParameter()

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

    Return the parameter on the Vreversed surface for the point of parameter V on <me>. Return -V.

    Implements Geom_ElementarySurface.


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