0031044: Coding - Standard_NODISCARD should be placed before Standard_EXPORT

[occt.git] / src / Geom / Geom_Axis1Placement.hxx

// Created on: 1993-03-09
// 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 _Geom_Axis1Placement_HeaderFile
#define _Geom_Axis1Placement_HeaderFile

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

#include <Geom_AxisPlacement.hxx>
class gp_Ax1;
class gp_Pnt;
class gp_Dir;
class gp_Trsf;
class Geom_Geometry;


class Geom_Axis1Placement;
DEFINE_STANDARD_HANDLE(Geom_Axis1Placement, Geom_AxisPlacement)

//! Describes an axis in 3D space.
//! An axis is defined by:
//! - its origin, also termed the "Location point" of the axis,
//! - its unit vector, termed the "Direction" of the axis.
//! Note: Geom_Axis1Placement axes provide the
//! same kind of "geometric" services as gp_Ax1 axes
//! but have more complex data structures. The
//! geometric objects provided by the Geom package
//! use gp_Ax1 objects to include axes in their data
//! structures, or to define an axis of symmetry or axis of rotation.
//! Geom_Axis1Placement axes are used in a context
//! where they can be shared by several objects
//! contained inside a common data structure.
class Geom_Axis1Placement : public Geom_AxisPlacement
{

public:

  
  //! Returns a transient copy of A1.
  Standard_EXPORT Geom_Axis1Placement(const gp_Ax1& A1);
  

  //! P is the origin of the axis placement and V is the direction
  //! of the axis placement.
  Standard_EXPORT Geom_Axis1Placement(const gp_Pnt& P, const gp_Dir& V);
  
  //! Returns a non transient copy of <me>.
  Standard_EXPORT const gp_Ax1& Ax1() const;
  
  //! Reverses the direction of the axis placement.
  Standard_EXPORT void Reverse();
  
  //! Returns a copy of <me> reversed.
  Standard_NODISCARD Standard_EXPORT Handle(Geom_Axis1Placement) Reversed() const;
  
  //! Assigns V to the unit vector of this axis.
  Standard_EXPORT void SetDirection (const gp_Dir& V) Standard_OVERRIDE;
  
  //! Applies the transformation T to this axis.
  Standard_EXPORT void Transform (const gp_Trsf& T) Standard_OVERRIDE;
  
  //! Creates a new object, which is a copy of this axis.
  Standard_EXPORT Handle(Geom_Geometry) Copy() const Standard_OVERRIDE;




  DEFINE_STANDARD_RTTIEXT(Geom_Axis1Placement,Geom_AxisPlacement)

protected:




private:




};







#endif // _Geom_Axis1Placement_HeaderFile