//! - Its "main Direction" is the v parametric direction of the cone.
//! - Its origin is the origin of the v parameter.
//! The parametric range of the two parameters is:
-//! - [ 0, 2.*Pi ] for u, and - ] -infinity, +infinity [ for v
-//! The parametric equation of the cone is: P(u, v) =
-//! O + (R + v*sin(Ang)) * (cos(u)*XDir + sin(u)*YDir) + v*cos(Ang)*ZDir where:
+//! @code
+//! - [ 0, 2.*Pi ] for u, and
+//! - ] -infinity, +infinity [ for v
+//! @endcode
+//! The parametric equation of the cone is:
+//! @code
+//! P(u, v) = O + (R + v*sin(Ang)) * (cos(u)*XDir + sin(u)*YDir) + v*cos(Ang)*ZDir
+//! @endcode
+//! where:
//! - O, XDir, YDir and ZDir are respectively
//! the origin, the "X Direction", the "Y Direction" and
//! the "Z Direction" of the cone's local coordinate system,
Standard_EXPORT Geom_ConicalSurface(const gp_Ax3& A3, const Standard_Real Ang, const Standard_Real Radius);
- //! Creates a ConicalSurface from a non transient Cone from
- //! package gp.
+ //! Creates a ConicalSurface from a non transient gp_Cone.
Standard_EXPORT Geom_ConicalSurface(const gp_Cone& C);
-
//! Set <me> so that <me> has the same geometric properties as C.
Standard_EXPORT void SetCone (const gp_Cone& C);
-
- //! Changes the radius of the conical surface in the placement
- //! plane (Z = 0, V = 0). The local coordinate system is not
- //! modified.
+ //! Changes the radius of the conical surface in the placement plane (Z = 0, V = 0).
+ //! The local coordinate system is not modified.
//! Raised if R < 0.0
Standard_EXPORT void SetRadius (const Standard_Real R);
-
//! Changes the semi angle of the conical surface.
//! Semi-angle can be negative. Its absolute value
//! Raises ConstructionError if Abs(Ang) < Resolution from gp or
//! Abs(Ang) >= PI/2 - Resolution
Standard_EXPORT void SetSemiAngle(const Standard_Real Ang);
-
- //! returns a non transient cone with the same geometric properties
- //! as <me>.
+ //! Returns a non transient cone with the same geometric properties as <me>.
Standard_EXPORT gp_Cone Cone() const;
-
- //! return 2.PI - U.
+
+ //! Eeturn 2.PI - U.
Standard_EXPORT Standard_Real UReversedParameter (const Standard_Real U) const Standard_OVERRIDE;
-
- //! Computes the u (or v) parameter on the modified
- //! surface, when reversing its u (or v) parametric
- //! direction, for any point of u parameter U (or of v
- //! parameter V) on this cone.
+
+ //! Computes the u (or v) parameter on the modified surface,
+ //! when reversing its u (or v) parametric direction,
+ //! for any point of u parameter U (or of v parameter V) on this cone.
//! In the case of a cone, these functions return respectively:
//! - 2.*Pi - U, -V.
Standard_EXPORT Standard_Real VReversedParameter (const Standard_Real V) const Standard_OVERRIDE;
- //! Changes the orientation of this cone in the v
- //! parametric direction. The bounds of the surface are
- //! not changed but the v parametric direction is reversed.
+ //! Changes the orientation of this cone in the v parametric direction.
+ //! The bounds of the surface are not changed but the v parametric direction is reversed.
//! As a consequence, for a cone:
//! - the "main Direction" of the local coordinate system
//! is reversed, and
//! - the half-angle at the apex is inverted.
Standard_EXPORT virtual void VReverse() Standard_OVERRIDE;
-
- //! Computes the parameters on the transformed surface for
+
+ //! 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')
- //!
+ //! @code
+ //! me->Transformed(T)->Value(U',V')
+ //! @endcode
//! is the same point as
- //!
- //! me->Value(U,V).Transformed(T)
- //!
+ //! @code
+ //! me->Value(U,V).Transformed(T)
+ //! @endcode
//! Where U',V' are the new values of U,V after calling
- //!
- //! me->TranformParameters(U,V,T)
- //!
- //! This methods multiplies V by T.ScaleFactor()
+ //! @code
+ //! me->TransformParameters(U,V,T)
+ //! @endcode
+ //! This method multiplies V by T.ScaleFactor()
Standard_EXPORT virtual void TransformParameters (Standard_Real& U, Standard_Real& V, const gp_Trsf& T) const Standard_OVERRIDE;
-
- //! Returns a 2d transformation used to find the new
+
+ //! Returns a 2d transformation used to find the new
//! parameters of a point on the transformed surface.
- //!
- //! me->Transformed(T)->Value(U',V')
- //!
+ //! @code
+ //! me->Transformed(T)->Value(U',V')
+ //! @endcode
//! is the same point as
- //!
- //! me->Value(U,V).Transformed(T)
- //!
- //! Where U',V' are obtained by transforming U,V with
- //! th 2d transformation returned by
- //!
- //! me->ParametricTransformation(T)
- //!
- //! This methods returns a scale centered on the
- //! U axis with T.ScaleFactor
+ //! @code
+ //! me->Value(U,V).Transformed(T)
+ //! @endcode
+ //! Where U',V' are obtained by transforming U,V with the 2d transformation returned by
+ //! @code
+ //! me->ParametricTransformation(T)
+ //! @endcode
+ //! This method returns a scale centered on the U axis with T.ScaleFactor
Standard_EXPORT virtual gp_GTrsf2d ParametricTransformation (const gp_Trsf& T) const Standard_OVERRIDE;
-
+
//! Computes the apex of this cone. It is on the negative
//! side of the axis of revolution of this cone if the
//! half-angle at the apex is positive, and on the positive
//! side of the "main Axis" if the half-angle is negative.
Standard_EXPORT gp_Pnt Apex() const;
-
//! The conical surface is infinite in the V direction so
//! V1 = Realfirst from Standard and V2 = RealLast.
//! U1 = 0 and U2 = 2*PI.
Standard_EXPORT void Bounds (Standard_Real& U1, Standard_Real& U2, Standard_Real& V1, Standard_Real& V2) const Standard_OVERRIDE;
-
//! 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
+ //! @code
+ //! 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
+ //! @endcode
Standard_EXPORT void Coefficients (Standard_Real& A1, Standard_Real& A2, Standard_Real& A3, Standard_Real& B1, Standard_Real& B2, Standard_Real& B3, Standard_Real& C1, Standard_Real& C2, Standard_Real& C3, Standard_Real& D) const;
-
+
//! Returns the reference radius of this cone.
//! The reference radius is the radius of the circle formed
//! by the intersection of this cone and its reference
//! If the apex of this cone is on the origin of the local
//! coordinate system of this cone, the returned value is 0.
Standard_EXPORT Standard_Real RefRadius() const;
-
//! Returns the semi-angle at the apex of this cone.
//! Attention! Semi-angle can be negative.
Standard_EXPORT Standard_Real SemiAngle() const;
-
+
//! returns True.
Standard_EXPORT Standard_Boolean IsUClosed() const Standard_OVERRIDE;
-
+
//! returns False.
Standard_EXPORT Standard_Boolean IsVClosed() const Standard_OVERRIDE;
-
+
//! Returns True.
Standard_EXPORT Standard_Boolean IsUPeriodic() const Standard_OVERRIDE;
-
+
//! Returns False.
Standard_EXPORT Standard_Boolean IsVPeriodic() const Standard_OVERRIDE;
-
- //! Builds the U isoparametric line of this cone. The
- //! origin of this line is on the reference plane of this
- //! cone (i.e. the plane defined by the origin, "X Direction"
+
+ //! Builds the U isoparametric line of this cone.
+ //! The origin of this line is on the reference plane of this cone
+ //! (i.e. the plane defined by the origin, "X Direction"
//! and "Y Direction" of the local coordinate system of this cone).
Standard_EXPORT Handle(Geom_Curve) UIso (const Standard_Real U) const Standard_OVERRIDE;
-
- //! Builds the V isoparametric circle of this cone. It is the
- //! circle on this cone, located in the plane of Z
- //! coordinate V*cos(Semi-Angle) in the local coordinate system of this
- //! cone. The "Axis" of this circle is the axis of revolution
- //! of this cone. Its starting point is defined by the "X
- //! Direction" of this cone.
+
+ //! Builds the V isoparametric circle of this cone.
+ //! It is the circle on this cone, located in the plane of Z
+ //! coordinate V*cos(Semi-Angle) in the local coordinate system of this cone.
+ //! The "Axis" of this circle is the axis of revolution of this cone.
+ //! Its starting point is defined by the "X Direction" of this cone.
//! Warning
//! If the V isoparametric circle is close to the apex of
//! this cone, the radius of the circle becomes very small.
//! It is possible to have a circle with radius equal to 0.0.
Standard_EXPORT Handle(Geom_Curve) VIso (const Standard_Real V) const Standard_OVERRIDE;
-
- //! Computes the point P (U, V) on the surface.
- //! P (U, V) = Loc +
- //! (RefRadius + V * sin (Semi-Angle)) * (cos (U) * XDir + sin (U) * YDir) +
- //! V * cos (Semi-Angle) * ZDir
+ //! Computes the point P (U, V) on the surface.
+ //! @code
+ //! P (U, V) = Loc +
+ //! (RefRadius + V * sin (Semi-Angle)) * (cos (U) * XDir + sin (U) * YDir) +
+ //! V * cos (Semi-Angle) * ZDir
+ //! @endcode
//! 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.
+ //! XDir is the direction of the XAxis and YDir the direction of the YAxis.
Standard_EXPORT void D0 (const Standard_Real U, const Standard_Real V, gp_Pnt& P) const Standard_OVERRIDE;
-
- //! Computes the current point and the first derivatives in the
- //! directions U and V.
+ //! Computes the current point and the first derivatives in the directions U and V.
Standard_EXPORT void D1 (const Standard_Real U, const Standard_Real V, gp_Pnt& P, gp_Vec& D1U, gp_Vec& D1V) const Standard_OVERRIDE;
-
- //! Computes the current point, the first and the second derivatives
- //! in the directions U and V.
+ //! Computes the current point, the first and the second derivatives in the directions U and V.
Standard_EXPORT void D2 (const Standard_Real U, const Standard_Real V, gp_Pnt& P, gp_Vec& D1U, gp_Vec& D1V, gp_Vec& D2U, gp_Vec& D2V, gp_Vec& D2UV) const Standard_OVERRIDE;
-
//! Computes the current point, the first,the second and the third
//! derivatives in the directions U and V.
Standard_EXPORT void D3 (const Standard_Real U, const Standard_Real 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 Standard_OVERRIDE;
-
+
//! Computes the derivative of order Nu in the u
//! parametric direction, and Nv in the v parametric
//! direction at the point of parameters (U, V) of this cone.
//! - Nu + Nv is less than 1,
//! - Nu or Nv is negative.
Standard_EXPORT gp_Vec DN (const Standard_Real U, const Standard_Real V, const Standard_Integer Nu, const Standard_Integer Nv) const Standard_OVERRIDE;
-
+
//! Applies the transformation T to this cone.
Standard_EXPORT void Transform (const gp_Trsf& T) Standard_OVERRIDE;
-
+
//! Creates a new object which is a copy of this cone.
Standard_EXPORT Handle(Geom_Geometry) Copy() const Standard_OVERRIDE;
-
//! Dumps the content of me into the stream
Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
-
-
-
DEFINE_STANDARD_RTTIEXT(Geom_ConicalSurface,Geom_ElementarySurface)
-protected:
-
-
-
-
private:
-
Standard_Real radius;
Standard_Real semiAngle;
-
};
-
-
-
-
-
-
#endif // _Geom_ConicalSurface_HeaderFile
projects / occt.git / blobdiff