0031939: Coding - correction of spelling errors in comments [part 4]
[occt.git] / src / IGESGeom / IGESGeom_OffsetSurface.hxx
CommitLineData
42cf5bc1 1// Created on: 1993-01-09
2// Created by: CKY / Contract Toubro-Larsen ( TCD )
3// Copyright (c) 1993-1999 Matra Datavision
4// Copyright (c) 1999-2014 OPEN CASCADE SAS
5//
6// This file is part of Open CASCADE Technology software library.
7//
8// This library is free software; you can redistribute it and/or modify it under
9// the terms of the GNU Lesser General Public License version 2.1 as published
10// by the Free Software Foundation, with special exception defined in the file
11// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12// distribution for complete text of the license and disclaimer of any warranty.
13//
14// Alternatively, this file may be used under the terms of Open CASCADE
15// commercial license or contractual agreement.
16
17#ifndef _IGESGeom_OffsetSurface_HeaderFile
18#define _IGESGeom_OffsetSurface_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_Type.hxx>
22
23#include <gp_XYZ.hxx>
24#include <Standard_Real.hxx>
25#include <IGESData_IGESEntity.hxx>
26class IGESData_IGESEntity;
27class gp_XYZ;
28class gp_Vec;
29
30
31class IGESGeom_OffsetSurface;
32DEFINE_STANDARD_HANDLE(IGESGeom_OffsetSurface, IGESData_IGESEntity)
33
34//! defines IGESOffsetSurface, Type <140> Form <0>
35//! in package IGESGeom
36//! An offset surface is a surface defined in terms of an
37//! already existing surface.If S(u, v) is a parametrised
38//! regular surface and N(u, v) is a differential field of
39//! unit normal vectors defined on the whole surface, and
40//! "d" a fixed non zero real number, then offset surface
41//! to S is a parametrised surface S(u, v) given by
42//! O(u, v) = S(u, v) + d * N(u, v);
43//! u1 <= u <= u2; v1 <= v <= v2;
44class IGESGeom_OffsetSurface : public IGESData_IGESEntity
45{
46
47public:
48
49
50 Standard_EXPORT IGESGeom_OffsetSurface();
51
52 //! This method is used to set the fields of the class
53 //! OffsetSurface
54 //! - anIndicator : Offset indicator
55 //! - aDistance : Offset distance
56 //! - aSurface : Surface that is offset
57 Standard_EXPORT void Init (const gp_XYZ& anIndicatoR, const Standard_Real aDistance, const Handle(IGESData_IGESEntity)& aSurface);
58
59 //! returns the offset indicator
60 Standard_EXPORT gp_Vec OffsetIndicator() const;
61
62 //! returns the offset indicator after applying Transf. Matrix
63 Standard_EXPORT gp_Vec TransformedOffsetIndicator() const;
64
65 //! returns the distance by which surface is offset
66 Standard_EXPORT Standard_Real Distance() const;
67
68 //! returns the surface that has been offset
69 Standard_EXPORT Handle(IGESData_IGESEntity) Surface() const;
70
71
72
73
92efcf78 74 DEFINE_STANDARD_RTTIEXT(IGESGeom_OffsetSurface,IGESData_IGESEntity)
42cf5bc1 75
76protected:
77
78
79
80
81private:
82
83
84 gp_XYZ theIndicator;
85 Standard_Real theDistance;
86 Handle(IGESData_IGESEntity) theSurface;
87
88
89};
90
91
92
93
94
95
96
97#endif // _IGESGeom_OffsetSurface_HeaderFile