include/opencascade/Draw_Display.hxx

0001 // Created on: 1991-07-15
0002 // Created by: Arnaud BOUZY
0003 // Copyright (c) 1991-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 _Draw_Display_HeaderFile
0018 #define _Draw_Display_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <Standard_Integer.hxx>
0024 #include <Draw_MarkerShape.hxx>
0025 class Draw_Color;
0026 class gp_Pnt;
0027 class gp_Pnt2d;
0028 class gp_Circ;
0029 class gp_Circ2d;
0030
0031
0032 //! Use to  draw in a 3d or a 2d view.
0033 //!
0034 //! * The  3d methods draw in the 3d  system,  in a 2d
0035 //! view the drawing is projected on X,Y.
0036 //!
0037 //! * The 2d methods draw in the projection plane.
0038 //!
0039 //! * To draw in screen coordinates the length must be
0040 //! divided by the zoom.
0041 class Draw_Display
0042 {
0043 public:
0044
0045   DEFINE_STANDARD_ALLOC
0046
0047
0048   Standard_EXPORT Draw_Display();
0049
0050   //! Following drawings will use this color.
0051   Standard_EXPORT void SetColor (const Draw_Color& col) const;
0052
0053   //! Set the drawing mode, 3 = copy, 6 = xor
0054   Standard_EXPORT void SetMode (const Standard_Integer M) const;
0055
0056   Standard_EXPORT void Flush() const;
0057
0058   Standard_EXPORT void MoveTo (const gp_Pnt& pt);
0059
0060   Standard_EXPORT void DrawTo (const gp_Pnt& pt);
0061
0062   Standard_EXPORT void MoveTo (const gp_Pnt2d& pt);
0063
0064   Standard_EXPORT void DrawTo (const gp_Pnt2d& pt);
0065
0066   Standard_EXPORT void Draw (const gp_Pnt& p1, const gp_Pnt& p2);
0067
0068   Standard_EXPORT void Draw (const gp_Pnt2d& p1, const gp_Pnt2d& p2);
0069
0070   //! Draw  a  circle   <C> from  angle <A1>   to  <A2>
0071   //! (Radians). if ModifyWithZoom  = 0,  then
0072   //! rayon of circle is convert to Integer.
0073   Standard_EXPORT void Draw (const gp_Circ& C, const Standard_Real A1, const Standard_Real A2, const Standard_Boolean ModifyWithZoom = Standard_True);
0074
0075   //! Draw  a 2D circle  <C>  from angle   <A1> to <A2>
0076   //! (Radians). if ModifyWithZoom  = 0,  then
0077   //! rayon of circle is convert to Integer.
0078   Standard_EXPORT void Draw (const gp_Circ2d& C, const Standard_Real A1, const Standard_Real A2, const Standard_Boolean ModifyWithZoom = Standard_True);
0079
0080   Standard_EXPORT void DrawMarker (const gp_Pnt& pt, const Draw_MarkerShape S, const Standard_Integer Size = 5);
0081
0082   Standard_EXPORT void DrawMarker (const gp_Pnt2d& pt, const Draw_MarkerShape S, const Standard_Integer Size = 5);
0083
0084   Standard_EXPORT void DrawMarker (const gp_Pnt& pt, const Draw_MarkerShape S, const Standard_Real Size);
0085
0086   Standard_EXPORT void DrawMarker (const gp_Pnt2d& pt, const Draw_MarkerShape S, const Standard_Real Size);
0087
0088   Standard_EXPORT void DrawString (const gp_Pnt& pt, const Standard_CString S);
0089
0090   Standard_EXPORT void DrawString (const gp_Pnt2d& pt, const Standard_CString S);
0091
0092   Standard_EXPORT void DrawString (const gp_Pnt& pt, const Standard_CString S, const Standard_Real moveX, const Standard_Real moveY);
0093
0094   Standard_EXPORT void DrawString (const gp_Pnt2d& pt, const Standard_CString S, const Standard_Real moveX, const Standard_Real moveY);
0095
0096   //! Returns the 2D projection of a 3D point.
0097   Standard_EXPORT gp_Pnt2d Project (const gp_Pnt& pt) const;
0098
0099   //! Returns the 2D projection of a 3D point.
0100   Standard_EXPORT void Project (const gp_Pnt& pt, gp_Pnt2d& pt2d) const;
0101
0102   //! Returns the current Zoom value.
0103   Standard_EXPORT Standard_Real Zoom() const;
0104
0105   //! Returns the   identifier  of the  view   where the
0106   //! display is drawing.
0107   Standard_EXPORT Standard_Integer ViewId() const;
0108
0109   //! Returns  True  if  the  last   drawing   operations
0110   //! generated  a pick hit.  When HasPicked is True the
0111   //! Drawing should be resumed.
0112   //!
0113   //! This function is used to shorten the  drawing when
0114   //! picking and to save the picked sub-parts.
0115   Standard_EXPORT Standard_Boolean HasPicked() const;
0116
0117
0118
0119
0120 protected:
0121
0122
0123
0124
0125
0126 private:
0127
0128
0129
0130
0131
0132 };
0133
0134
0135
0136
0137
0138
0139
0140 #endif // _Draw_Display_HeaderFile