include/opencascade/Geom_Axis1Placement.hxx

0001 // Created on: 1993-03-09
0002 // Created by: JCV
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _Geom_Axis1Placement_HeaderFile
0018 #define _Geom_Axis1Placement_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Geom_AxisPlacement.hxx>
0023 class gp_Ax1;
0024 class gp_Pnt;
0025 class gp_Dir;
0026 class gp_Trsf;
0027 class Geom_Geometry;
0028
0029 //! Describes an axis in 3D space.
0030 //! An axis is defined by:
0031 //! - its origin, also termed the "Location point" of the axis,
0032 //! - its unit vector, termed the "Direction" of the axis.
0033 //! Note: Geom_Axis1Placement axes provide the
0034 //! same kind of "geometric" services as gp_Ax1 axes
0035 //! but have more complex data structures. The
0036 //! geometric objects provided by the Geom package
0037 //! use gp_Ax1 objects to include axes in their data
0038 //! structures, or to define an axis of symmetry or axis of rotation.
0039 //! Geom_Axis1Placement axes are used in a context
0040 //! where they can be shared by several objects
0041 //! contained inside a common data structure.
0042 class Geom_Axis1Placement : public Geom_AxisPlacement
0043 {
0044
0045 public:
0046   //! Returns a transient copy of A1.
0047   Standard_EXPORT Geom_Axis1Placement(const gp_Ax1& A1);
0048
0049   //! P is the origin of the axis placement and V is the direction
0050   //! of the axis placement.
0051   Standard_EXPORT Geom_Axis1Placement(const gp_Pnt& P, const gp_Dir& V);
0052
0053   //! Returns a non transient copy of <me>.
0054   Standard_EXPORT const gp_Ax1& Ax1() const;
0055
0056   //! Reverses the direction of the axis placement.
0057   Standard_EXPORT void Reverse();
0058
0059   //! Returns a copy of <me> reversed.
0060   [[nodiscard]] Standard_EXPORT occ::handle<Geom_Axis1Placement> Reversed() const;
0061
0062   //! Assigns V to the unit vector of this axis.
0063   Standard_EXPORT void SetDirection(const gp_Dir& V) override;
0064
0065   //! Applies the transformation T to this axis.
0066   Standard_EXPORT void Transform(const gp_Trsf& T) override;
0067
0068   //! Creates a new object, which is a copy of this axis.
0069   Standard_EXPORT occ::handle<Geom_Geometry> Copy() const override;
0070
0071   DEFINE_STANDARD_RTTIEXT(Geom_Axis1Placement, Geom_AxisPlacement)
0072 };
0073
0074 #endif // _Geom_Axis1Placement_HeaderFile