0030448: Coding - add typo detection to derivation creation methods using Standard_NO...

[occt.git] / src / Geom2d / Geom2d_Geometry.hxx

// Created on: 1993-03-24
// Created by: JCV
// Copyright (c) 1993-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _Geom2d_Geometry_HeaderFile
#define _Geom2d_Geometry_HeaderFile

#include <Standard.hxx>
#include <Standard_Type.hxx>

#include <Standard_Transient.hxx>
#include <Standard_Real.hxx>
class Standard_ConstructionError;
class gp_Pnt2d;
class gp_Ax2d;
class gp_Vec2d;
class gp_Trsf2d;


class Geom2d_Geometry;
DEFINE_STANDARD_HANDLE(Geom2d_Geometry, Standard_Transient)


//! The general abstract class Geometry in 2D space describes
//! the common behaviour of all the geometric entities.
//!
//! All the objects derived from this class can be move with a
//! geometric transformation. Only the transformations which
//! doesn't modify the nature of the geometry are available in
//! this package.
//! The method Transform which defines a general transformation
//! is deferred. The other specifics transformations used the
//! method Transform.
//! All the following transformations modify the object itself.
//! Warning
//! Only transformations which do not modify the nature
//! of the geometry can be applied to Geom2d objects:
//! this is the case with translations, rotations,
//! symmetries and scales; this is also the case with
//! gp_Trsf2d composite transformations which are
//! used to define the geometric transformations applied
//! using the Transform or Transformed functions.
//! Note: Geometry defines the "prototype" of the
//! abstract method Transform which is defined for each
//! concrete type of derived object. All other
//! transformations are implemented using the Transform method.
class Geom2d_Geometry : public Standard_Transient
{

public:

  
  //! Performs the symmetrical transformation of a Geometry
  //! with respect to the point P which is the center of the
  //! symmetry and assigns the result to this geometric object.
  Standard_EXPORT void Mirror (const gp_Pnt2d& P);
  
  //! Performs the symmetrical transformation of a Geometry
  //! with respect to an axis placement which is the axis of the symmetry.
  Standard_EXPORT void Mirror (const gp_Ax2d& A);
  
  //! Rotates a Geometry. P is the center of the rotation.
  //! Ang is the angular value of the rotation in radians.
  Standard_EXPORT void Rotate (const gp_Pnt2d& P, const Standard_Real Ang);
  
  //! Scales a Geometry. S is the scaling value.
  Standard_EXPORT void Scale (const gp_Pnt2d& P, const Standard_Real S);
  
  //! Translates a Geometry.  V is the vector of the tanslation.
  Standard_EXPORT void Translate (const gp_Vec2d& V);
  
  //! Translates a Geometry from the point P1 to the point P2.
  Standard_EXPORT void Translate (const gp_Pnt2d& P1, const gp_Pnt2d& P2);
  
  //! Transformation of a geometric object. This tansformation
  //! can be a translation, a rotation, a symmetry, a scaling
  //! or a complex transformation obtained by combination of
  //! the previous elementaries transformations.
  //! (see class Transformation of the package Geom2d).
  //! The following transformations have the same properties
  //! as the previous ones but they don't modified the object
  //! itself. A copy of the object is returned.
  Standard_EXPORT virtual void Transform (const gp_Trsf2d& T) = 0;
  
  Standard_EXPORT Standard_NODISCARD Handle(Geom2d_Geometry) Mirrored (const gp_Pnt2d& P) const;
  
  Standard_EXPORT Standard_NODISCARD Handle(Geom2d_Geometry) Mirrored (const gp_Ax2d& A) const;
  
  Standard_EXPORT Standard_NODISCARD Handle(Geom2d_Geometry) Rotated (const gp_Pnt2d& P, const Standard_Real Ang) const;
  
  Standard_EXPORT Standard_NODISCARD Handle(Geom2d_Geometry) Scaled (const gp_Pnt2d& P, const Standard_Real S) const;
  
  Standard_EXPORT Standard_NODISCARD Handle(Geom2d_Geometry) Transformed (const gp_Trsf2d& T) const;
  
  Standard_EXPORT Standard_NODISCARD Handle(Geom2d_Geometry) Translated (const gp_Vec2d& V) const;
  
  Standard_EXPORT Standard_NODISCARD Handle(Geom2d_Geometry) Translated (const gp_Pnt2d& P1, const gp_Pnt2d& P2) const;
  
  Standard_EXPORT virtual Handle(Geom2d_Geometry) Copy() const = 0;




  DEFINE_STANDARD_RTTIEXT(Geom2d_Geometry,Standard_Transient)

protected:




private:




};







#endif // _Geom2d_Geometry_HeaderFile