liboce-foundation-dev 0.18.2-2build1 / usr / include / oce / gp_Parab2d.hxx

// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _gp_Parab2d_HeaderFile
#define _gp_Parab2d_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Macro.hxx>

#include <gp_Ax22d.hxx>
#include <Standard_Real.hxx>
#include <Standard_Storable.hxx>
#include <Standard_Boolean.hxx>
#include <gp_Ax2d.hxx>
#include <gp_Pnt2d.hxx>
#include <Standard_PrimitiveTypes.hxx>
class Standard_ConstructionError;
class gp_Ax2d;
class gp_Ax22d;
class gp_Pnt2d;
class gp_Trsf2d;
class gp_Vec2d;


Standard_EXPORT const Handle(Standard_Type)& STANDARD_TYPE(gp_Parab2d);

//! Describes a parabola in the plane (2D space).
//! A parabola is defined by its focal length (that is, the
//! distance between its focus and apex) and positioned in
//! the plane with a coordinate system (a gp_Ax22d object) where:
//! -   the origin of the coordinate system is on the apex of
//! the parabola, and
//! -   the "X Axis" of the coordinate system is the axis of
//! symmetry; the parabola is on the positive side of this axis.
//! This coordinate system is the "local coordinate system"
//! of the parabola. Its orientation (direct or indirect sense)
//! gives an implicit orientation to the parabola.
//! In this coordinate system, the equation for the parabola is:
//! Y**2 = (2*P) * X.
//! where P, referred to as the parameter of the parabola, is
//! the distance between the focus and the directrix (P is
//! twice the focal length).
//! See Also
//! GCE2d_MakeParab2d which provides functions for
//! more complex parabola constructions
//! Geom2d_Parabola which provides additional functions
//! for constructing parabolas and works, in particular, with
//! the parametric equations of parabolas
class gp_Parab2d 
{

public:

  DEFINE_STANDARD_ALLOC

  
  //! Creates an indefinite parabola.
    gp_Parab2d();
  

  //! Creates a parabola with its vertex point, its axis of symmetry
  //! ("XAxis") and its focal length.
  //! The sense of parametrization is given by Sense.
  //! Warnings : It is possible to have Focal = 0.
  //! Raises ConstructionError if Focal < 0.0
    gp_Parab2d(const gp_Ax2d& MirrorAxis, const Standard_Real Focal, const Standard_Boolean Sense = Standard_True);
  

  //! Creates a parabola with its vertex point, its axis of symmetry
  //! ("XAxis") and its focal length.
  //! The sense of parametrization is given by A.
  //! Warnings : It is possible to have Focal = 0.
  //! Raises ConstructionError if Focal < 0.0
    gp_Parab2d(const gp_Ax22d& A, const Standard_Real Focal);
  

  //! Creates a parabola with the directrix and the focus point.
  //! The sense of parametrization is given by Sense.
  Standard_EXPORT gp_Parab2d(const gp_Ax2d& D, const gp_Pnt2d& F, const Standard_Boolean Sense = Standard_True);
  

  //! Creates a parabola with the directrix and the focus point.
  //! The Sense of parametrization is given by D.
  Standard_EXPORT gp_Parab2d(const gp_Ax22d& D, const gp_Pnt2d& F);
  

  //! Changes the focal distance of the parabola
  //! Warnings : It is possible to have Focal = 0.
  //! Raises ConstructionError if Focal < 0.0
      void SetFocal (const Standard_Real Focal) ;
  

  //! Changes the "Location" point of the parabola. It is the
  //! vertex of the parabola.
      void SetLocation (const gp_Pnt2d& P) ;
  
  //! Modifies this parabola, by redefining its local coordinate system so that
  //! its origin and "X Direction" become those of the axis
  //! MA. The "Y Direction" of the local coordinate system is
  //! then recomputed. The orientation of the local
  //! coordinate system is not modified.
      void SetMirrorAxis (const gp_Ax2d& A) ;
  

  //! Changes the local coordinate system of the parabola.
  //! The "Location" point of A becomes the vertex of the parabola.
      void SetAxis (const gp_Ax22d& A) ;
  

  //! Computes the coefficients of the implicit equation of the parabola.
  //! A * (X**2) + B * (Y**2) + 2*C*(X*Y) + 2*D*X + 2*E*Y + F = 0.
  Standard_EXPORT   void Coefficients (Standard_Real& A, Standard_Real& B, Standard_Real& C, Standard_Real& D, Standard_Real& E, Standard_Real& F)  const;
  

  //! Computes the directrix of the parabola.
  //! The directrix is:
  //! -   a line parallel to the "Y Direction" of the local
  //! coordinate system of this parabola, and
  //! -   located on the negative side of the axis of symmetry,
  //! at a distance from the apex which is equal to the focal  length of this parabola.
  //! The directrix is returned as an axis (a gp_Ax2d object),
  //! the origin of which is situated on the "X Axis" of this parabola.
      gp_Ax2d Directrix()  const;
  

  //! Returns the distance between the vertex and the focus
  //! of the parabola.
      Standard_Real Focal()  const;
  
  //! Returns the focus of the parabola.
      gp_Pnt2d Focus()  const;
  
  //! Returns the vertex of the parabola.
      gp_Pnt2d Location()  const;
  

  //! Returns the symmetry axis of the parabola.
  //! The "Location" point of this axis is the vertex of the parabola.
      gp_Ax2d MirrorAxis()  const;
  

  //! Returns the local coordinate system of the parabola.
  //! The "Location" point of this axis is the vertex of the parabola.
      gp_Ax22d Axis()  const;
  

  //! Returns the distance between the focus and the
  //! directrix of the parabola.
      Standard_Real Parameter()  const;
  
      void Reverse() ;
  

  //! Reverses the orientation of the local coordinate system
  //! of this parabola (the "Y Direction" is reversed).
  //! Therefore, the implicit orientation of this parabola is reversed.
  //! Note:
  //! -   Reverse assigns the result to this parabola, while
  //! -   Reversed creates a new one.
      gp_Parab2d Reversed()  const;
  
  //! Returns true if the local coordinate system is direct
  //! and false in the other case.
      Standard_Boolean IsDirect()  const;
  
  Standard_EXPORT   void Mirror (const gp_Pnt2d& P) ;
  

  //! Performs the symmetrical transformation of a parabola with respect
  //! to the point P which is the center of the symmetry
  Standard_EXPORT   gp_Parab2d Mirrored (const gp_Pnt2d& P)  const;
  
  Standard_EXPORT   void Mirror (const gp_Ax2d& A) ;
  

  //! Performs the symmetrical transformation of a parabola with respect
  //! to an axis placement which is the axis of the symmetry.
  Standard_EXPORT   gp_Parab2d Mirrored (const gp_Ax2d& A)  const;
  
      void Rotate (const gp_Pnt2d& P, const Standard_Real Ang) ;
  

  //! Rotates a parabola. P is the center of the rotation.
  //! Ang is the angular value of the rotation in radians.
      gp_Parab2d Rotated (const gp_Pnt2d& P, const Standard_Real Ang)  const;
  
      void Scale (const gp_Pnt2d& P, const Standard_Real S) ;
  

  //! Scales a parabola. S is the scaling value.
  //! If S is negative the direction of the symmetry axis
  //! "XAxis" is reversed and the direction of the "YAxis" too.
      gp_Parab2d Scaled (const gp_Pnt2d& P, const Standard_Real S)  const;
  
      void Transform (const gp_Trsf2d& T) ;
  

  //! Transforms an parabola with the transformation T from class Trsf2d.
      gp_Parab2d Transformed (const gp_Trsf2d& T)  const;
  
      void Translate (const gp_Vec2d& V) ;
  

  //! Translates a parabola in the direction of the vector V.
  //! The magnitude of the translation is the vector's magnitude.
      gp_Parab2d Translated (const gp_Vec2d& V)  const;
  
      void Translate (const gp_Pnt2d& P1, const gp_Pnt2d& P2) ;
  

  //! Translates a parabola from the point P1 to the point P2.
      gp_Parab2d Translated (const gp_Pnt2d& P1, const gp_Pnt2d& P2)  const;
    const gp_Ax22d& _CSFDB_Getgp_Parab2dpos() const { return pos; }
    Standard_Real _CSFDB_Getgp_Parab2dfocalLength() const { return focalLength; }
    void _CSFDB_Setgp_Parab2dfocalLength(const Standard_Real p) { focalLength = p; }



protected:




private: 


  gp_Ax22d pos;
  Standard_Real focalLength;


};


#include <gp_Parab2d.lxx>





#endif // _gp_Parab2d_HeaderFile