include/opencascade/StepVisual_ViewVolume.hxx

0001 // Created on: 1995-12-01
0002 // Created by: EXPRESS->CDL V0.2 Translator
0003 // Copyright (c) 1995-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 _StepVisual_ViewVolume_HeaderFile
0018 #define _StepVisual_ViewVolume_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <StepVisual_CentralOrParallel.hxx>
0024 #include <Standard_Transient.hxx>
0025 class StepGeom_CartesianPoint;
0026 class StepVisual_PlanarBox;
0027
0028 class StepVisual_ViewVolume : public Standard_Transient
0029 {
0030
0031 public:
0032   //! Returns a ViewVolume
0033   Standard_EXPORT StepVisual_ViewVolume();
0034
0035   Standard_EXPORT void Init(const StepVisual_CentralOrParallel          aProjectionType,
0036                             const occ::handle<StepGeom_CartesianPoint>& aProjectionPoint,
0037                             const double                                aViewPlaneDistance,
0038                             const double                                aFrontPlaneDistance,
0039                             const bool                                  aFrontPlaneClipping,
0040                             const double                                aBackPlaneDistance,
0041                             const bool                                  aBackPlaneClipping,
0042                             const bool                                  aViewVolumeSidesClipping,
0043                             const occ::handle<StepVisual_PlanarBox>&    aViewWindow);
0044
0045   Standard_EXPORT void SetProjectionType(const StepVisual_CentralOrParallel aProjectionType);
0046
0047   Standard_EXPORT StepVisual_CentralOrParallel ProjectionType() const;
0048
0049   Standard_EXPORT void SetProjectionPoint(
0050     const occ::handle<StepGeom_CartesianPoint>& aProjectionPoint);
0051
0052   Standard_EXPORT occ::handle<StepGeom_CartesianPoint> ProjectionPoint() const;
0053
0054   Standard_EXPORT void SetViewPlaneDistance(const double aViewPlaneDistance);
0055
0056   Standard_EXPORT double ViewPlaneDistance() const;
0057
0058   Standard_EXPORT void SetFrontPlaneDistance(const double aFrontPlaneDistance);
0059
0060   Standard_EXPORT double FrontPlaneDistance() const;
0061
0062   Standard_EXPORT void SetFrontPlaneClipping(const bool aFrontPlaneClipping);
0063
0064   Standard_EXPORT bool FrontPlaneClipping() const;
0065
0066   Standard_EXPORT void SetBackPlaneDistance(const double aBackPlaneDistance);
0067
0068   Standard_EXPORT double BackPlaneDistance() const;
0069
0070   Standard_EXPORT void SetBackPlaneClipping(const bool aBackPlaneClipping);
0071
0072   Standard_EXPORT bool BackPlaneClipping() const;
0073
0074   Standard_EXPORT void SetViewVolumeSidesClipping(const bool aViewVolumeSidesClipping);
0075
0076   Standard_EXPORT bool ViewVolumeSidesClipping() const;
0077
0078   Standard_EXPORT void SetViewWindow(const occ::handle<StepVisual_PlanarBox>& aViewWindow);
0079
0080   Standard_EXPORT occ::handle<StepVisual_PlanarBox> ViewWindow() const;
0081
0082   DEFINE_STANDARD_RTTIEXT(StepVisual_ViewVolume, Standard_Transient)
0083
0084 private:
0085   StepVisual_CentralOrParallel         projectionType;
0086   occ::handle<StepGeom_CartesianPoint> projectionPoint;
0087   double                               viewPlaneDistance;
0088   double                               frontPlaneDistance;
0089   bool                                 frontPlaneClipping;
0090   double                               backPlaneDistance;
0091   bool                                 backPlaneClipping;
0092   bool                                 viewVolumeSidesClipping;
0093   occ::handle<StepVisual_PlanarBox>    viewWindow;
0094 };
0095
0096 #endif // _StepVisual_ViewVolume_HeaderFile