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_SphericalSurface Class Reference

    Describes a sphere. A sphere is defined by its radius, and is positioned in space by a coordinate system (a gp_Ax3 object), the origin of which is the center of the sphere. This coordinate system is the "local coordinate system" of the sphere. The following apply: More...

    #include <Geom_SphericalSurface.hxx>

    Inheritance diagram for Geom_SphericalSurface:

    Public Member Functions

     Geom_SphericalSurface (const gp_Ax3 &A3, const double Radius)
     A3 is the local coordinate system of the surface. At the creation the parametrization of the surface is defined such as the normal Vector (N = D1U ^ D1V) is directed away from the center of the sphere. The direction of increasing parametric value V is defined by the rotation around the "YDirection" of A2 in the trigonometric sense and the orientation of increasing parametric value U is defined by the rotation around the main direction of A2 in the trigonometric sense. Warnings : It is not forbidden to create a spherical surface with Radius = 0.0 Raised if Radius < 0.0.
     Geom_SphericalSurface (const gp_Sphere &S)
     Creates a SphericalSurface from a non persistent Sphere from package gp.
    void SetRadius (const double R)
     Assigns the value R to the radius of this sphere. Exceptions Standard_ConstructionError if R is less than 0.0.
    void SetSphere (const gp_Sphere &S)
     Converts the gp_Sphere S into this sphere.
    gp_Sphere Sphere () const
     Returns a non persistent sphere with the same geometric properties as <me>.
    double UReversedParameter (const double U) const final
     Computes the u parameter on the modified surface, when reversing its u parametric direction, for any point of u parameter U on this sphere. In the case of a sphere, these functions returns 2.PI - U.
    double VReversedParameter (const double V) const final
     Computes the v parameter on the modified surface, when reversing its v parametric direction, for any point of v parameter V on this sphere. In the case of a sphere, these functions returns -U.
    double Area () const
     Computes the area of the spherical surface.
    void Bounds (double &U1, double &U2, double &V1, double &V2) const final
     Returns the parametric bounds U1, U2, V1 and V2 of this sphere. For a sphere: U1 = 0, U2 = 2*PI, V1 = -PI/2, V2 = PI/2.
    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 coordinates 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.
    double Radius () const
     Computes the coefficients of the implicit equation of this quadric in the absolute Cartesian coordinate system: 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 An implicit normalization is applied (i.e. A1 = A2 = 1. in the local coordinate system of this sphere).
    double Volume () const
     Computes the volume of the spherical surface.
    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
     Computes the U isoparametric curve. The U isoparametric curves of the surface are defined by the section of the spherical surface with plane obtained by rotation of the plane (Location, XAxis, ZAxis) around ZAxis. This plane defines the origin of parametrization u. For a SphericalSurface the UIso curve is a Circle. Warnings : The radius of this circle can be zero.
    occ::handle< Geom_CurveVIso (const double V) const final
     Computes the V isoparametric curve. The V isoparametric curves of the surface are defined by the section of the spherical surface with plane parallel to the plane (Location, XAxis, YAxis). This plane defines the origin of parametrization V. Be careful if V is close to PI/2 or 3*PI/2 the radius of the circle becomes tiny. It is not forbidden in this toolkit to create circle with radius = 0.0 For a SphericalSurface the VIso curve is a Circle. Warnings : The radius of this circle can be zero.
    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 * Sin (V) * Zdir + Radius * Cos (V) * (cos (U) * XDir + sin (U) * YDir) 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 and ZDir the direction of the ZAxis.
    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 sphere.
    occ::handle< Geom_GeometryCopy () const final
     Creates a new object which is a copy of this sphere.
    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.
    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 void TransformParameters (double &U, double &V, const gp_Trsf &T) const
     Computes the parameters on the transformed surface for the transform of the point of parameters U,V on <me>.
    virtual gp_GTrsf2d ParametricTransformation (const gp_Trsf &T) const
     Returns a 2d transformation used to find the new parameters of a point on the transformed surface.
    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

    Describes a sphere. A sphere is defined by its radius, and is positioned in space by a coordinate system (a gp_Ax3 object), the origin of which is the center of the sphere. This coordinate system is the "local coordinate system" of the sphere. The following apply:

    • Rotation around its "main Axis", in the trigonometric sense given by the "X Direction" and the "Y Direction", defines the u parametric direction.
    • Its "X Axis" gives the origin for the u parameter.
    • The "reference meridian" of the sphere is a half-circle, of radius equal to the radius of the sphere. It is located in the plane defined by the origin, "X Direction" and "main Direction", centered on the origin, and positioned on the positive side of the "X Axis".
    • Rotation around the "Y Axis" gives the v parameter on the reference meridian.
    • The "X Axis" gives the origin of the v parameter on the reference meridian.
    • The v parametric direction is oriented by the "main Direction", i.e. when v increases, the Z coordinate increases. (This implies that the "Y Direction" orients the reference meridian only when the local coordinate system is indirect.)
    • The u isoparametric curve is a half-circle obtained by rotating the reference meridian of the sphere through an angle u around the "main Axis", in the trigonometric sense defined by the "X Direction" and the "Y Direction". The parametric equation of the sphere is: P(u,v) = O + R*cos(v)*(cos(u)*XDir + sin(u)*YDir)+R*sin(v)*ZDir where:
    • O, XDir, YDir and ZDir are respectively the origin, the "X Direction", the "Y Direction" and the "Z Direction" of its local coordinate system, and
    • R is the radius of the sphere. The parametric range of the two parameters is:
    • [ 0, 2.*Pi ] for u, and
    • [ - Pi/2., + Pi/2. ] for v.

    Constructor & Destructor Documentation

    ◆ Geom_SphericalSurface() [1/2]

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

    A3 is the local coordinate system of the surface. At the creation the parametrization of the surface is defined such as the normal Vector (N = D1U ^ D1V) is directed away from the center of the sphere. The direction of increasing parametric value V is defined by the rotation around the "YDirection" of A2 in the trigonometric sense and the orientation of increasing parametric value U is defined by the rotation around the main direction of A2 in the trigonometric sense. Warnings : It is not forbidden to create a spherical surface with Radius = 0.0 Raised if Radius < 0.0.

    ◆ Geom_SphericalSurface() [2/2]

    Geom_SphericalSurface::Geom_SphericalSurface ( const gp_Sphere & S)

    Creates a SphericalSurface from a non persistent Sphere from package gp.

    Member Function Documentation

    ◆ Area()

    double Geom_SphericalSurface::Area ( ) const

    Computes the area of the spherical surface.

    ◆ Bounds()

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

    Returns the parametric bounds U1, U2, V1 and V2 of this sphere. For a sphere: U1 = 0, U2 = 2*PI, V1 = -PI/2, V2 = PI/2.

    Implements Geom_Surface.

    ◆ Coefficients()

    void Geom_SphericalSurface::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 coordinates 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_SphericalSurface::Copy ( ) const
    finalvirtual

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

    Implements Geom_Geometry.

    ◆ DumpJson()

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

    Dumps the content of me into the stream.

    Reimplemented from Geom_ElementarySurface.

    ◆ EvalD0()

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

    Computes the point P (U, V) on the surface. P (U, V) = Loc + Radius * Sin (V) * Zdir + Radius * Cos (V) * (cos (U) * XDir + sin (U) * YDir) 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 and ZDir the direction of the ZAxis.

    Implements Geom_Surface.

    ◆ EvalD1()

    Geom_Surface::ResD1 Geom_SphericalSurface::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_SphericalSurface::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_SphericalSurface::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_SphericalSurface::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_SphericalSurface::IsUClosed ( ) const
    finalvirtual

    Returns True.

    Implements Geom_Surface.

    ◆ IsUPeriodic()

    bool Geom_SphericalSurface::IsUPeriodic ( ) const
    finalvirtual

    Returns True.

    Implements Geom_Surface.

    ◆ IsVClosed()

    bool Geom_SphericalSurface::IsVClosed ( ) const
    finalvirtual

    Returns False.

    Implements Geom_Surface.

    ◆ IsVPeriodic()

    bool Geom_SphericalSurface::IsVPeriodic ( ) const
    finalvirtual

    Returns False.

    Implements Geom_Surface.

    ◆ Radius()

    double Geom_SphericalSurface::Radius ( ) const

    Computes the coefficients of the implicit equation of this quadric in the absolute Cartesian coordinate system: 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 An implicit normalization is applied (i.e. A1 = A2 = 1. in the local coordinate system of this sphere).

    ◆ SetRadius()

    void Geom_SphericalSurface::SetRadius ( const double R)

    Assigns the value R to the radius of this sphere. Exceptions Standard_ConstructionError if R is less than 0.0.

    ◆ SetSphere()

    void Geom_SphericalSurface::SetSphere ( const gp_Sphere & S)

    Converts the gp_Sphere S into this sphere.

    ◆ Sphere()

    gp_Sphere Geom_SphericalSurface::Sphere ( ) const

    Returns a non persistent sphere with the same geometric properties as <me>.

    ◆ Transform()

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

    Applies the transformation T to this sphere.

    Implements Geom_Geometry.

    ◆ UIso()

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

    Computes the U isoparametric curve. The U isoparametric curves of the surface are defined by the section of the spherical surface with plane obtained by rotation of the plane (Location, XAxis, ZAxis) around ZAxis. This plane defines the origin of parametrization u. For a SphericalSurface the UIso curve is a Circle. Warnings : The radius of this circle can be zero.

    Implements Geom_Surface.

    ◆ UReversedParameter()

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

    Computes the u parameter on the modified surface, when reversing its u parametric direction, for any point of u parameter U on this sphere. In the case of a sphere, these functions returns 2.PI - U.

    Implements Geom_ElementarySurface.

    ◆ VIso()

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

    Computes the V isoparametric curve. The V isoparametric curves of the surface are defined by the section of the spherical surface with plane parallel to the plane (Location, XAxis, YAxis). This plane defines the origin of parametrization V. Be careful if V is close to PI/2 or 3*PI/2 the radius of the circle becomes tiny. It is not forbidden in this toolkit to create circle with radius = 0.0 For a SphericalSurface the VIso curve is a Circle. Warnings : The radius of this circle can be zero.

    Implements Geom_Surface.

    ◆ Volume()

    double Geom_SphericalSurface::Volume ( ) const

    Computes the volume of the spherical surface.

    ◆ VReversedParameter()

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

    Computes the v parameter on the modified surface, when reversing its v parametric direction, for any point of v parameter V on this sphere. In the case of a sphere, these functions returns -U.

    Implements Geom_ElementarySurface.


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