include/opencascade/AIS_CameraFrustum.hxx

0001 // Created on: 2018-12-12
0002 // Created by: Olga SURYANINOVA
0003 // Copyright (c) 2018 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _AIS_CameraFrustum_HeaderFile
0017 #define _AIS_CameraFrustum_HeaderFile
0018
0019 #include <AIS_InteractiveObject.hxx>
0020
0021 class Graphic3d_ArrayOfSegments;
0022 class Graphic3d_ArrayOfTriangles;
0023
0024 //! Presentation for drawing camera frustum.
0025 //! Default configuration is built with filling and some transparency.
0026 class AIS_CameraFrustum : public AIS_InteractiveObject
0027 {
0028   DEFINE_STANDARD_RTTIEXT(AIS_CameraFrustum, AIS_InteractiveObject)
0029 public:
0030   //! Selection modes supported by this object
0031   enum SelectionMode
0032   {
0033     SelectionMode_Edges  = 0, //!< detect by edges (default)
0034     SelectionMode_Volume = 1, //!< detect by volume
0035   };
0036
0037 public:
0038   //! Constructs camera frustum with default configuration.
0039   Standard_EXPORT AIS_CameraFrustum();
0040
0041   //! Sets camera frustum.
0042   Standard_EXPORT void SetCameraFrustum(const Handle(Graphic3d_Camera)& theCamera);
0043
0044   //! Setup custom color.
0045   Standard_EXPORT virtual void SetColor(const Quantity_Color& theColor) Standard_OVERRIDE;
0046
0047   //! Restore default color.
0048   Standard_EXPORT virtual void UnsetColor() Standard_OVERRIDE;
0049
0050   //! Restore transparency setting.
0051   Standard_EXPORT virtual void UnsetTransparency() Standard_OVERRIDE;
0052
0053   //! Return true if specified display mode is supported.
0054   Standard_EXPORT virtual Standard_Boolean AcceptDisplayMode(const Standard_Integer theMode) const
0055     Standard_OVERRIDE;
0056
0057 protected:
0058   //! Computes presentation of camera frustum.
0059   Standard_EXPORT virtual void Compute(const Handle(PrsMgr_PresentationManager)& thePrsMgr,
0060                                        const Handle(Prs3d_Presentation)&         thePrs,
0061                                        const Standard_Integer theMode) Standard_OVERRIDE;
0062
0063   //! Compute selection.
0064   Standard_EXPORT virtual void ComputeSelection(const Handle(SelectMgr_Selection)& theSelection,
0065                                                 const Standard_Integer theMode) Standard_OVERRIDE;
0066
0067 private:
0068   //! Fills triangles primitive array for camera frustum filling.
0069   void fillTriangles();
0070
0071   //! Fills polylines primitive array for camera frustum borders.
0072   void fillBorders();
0073
0074 protected:
0075   NCollection_Array1<Graphic3d_Vec3d> myPoints;    //!< Array of points
0076   Handle(Graphic3d_ArrayOfTriangles)  myTriangles; //!< Triangles for camera frustum filling
0077   Handle(Graphic3d_ArrayOfSegments)   myBorders;   //!< Segments for camera frustum borders
0078 };
0079
0080 #endif // _AIS_CameraFrustum_HeaderFile