0028215: Visualization - define EMPTY type line for consistenct with Interior Style
[occt.git] / src / ViewerTest / ViewerTest.hxx
1 // Copyright (c) 1997-1999 Matra Datavision
2 // Copyright (c) 1999-2015 OPEN CASCADE SAS
3 //
4 // This file is part of Open CASCADE Technology software library.
5 //
6 // This library is free software; you can redistribute it and/or modify it under
7 // the terms of the GNU Lesser General Public License version 2.1 as published
8 // by the Free Software Foundation, with special exception defined in the file
9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
10 // distribution for complete text of the license and disclaimer of any warranty.
11 //
12 // Alternatively, this file may be used under the terms of Open CASCADE
13 // commercial license or contractual agreement.
14
15 #ifndef _ViewerTest_HeaderFile
16 #define _ViewerTest_HeaderFile
17
18 #include <Standard.hxx>
19 #include <Standard_DefineAlloc.hxx>
20 #include <Standard_Macro.hxx>
21
22 #include <Draw_Interpretor.hxx>
23 #include <Standard_Integer.hxx>
24 #include <Standard_CString.hxx>
25 #include <Standard_Boolean.hxx>
26 #include <TopAbs_ShapeEnum.hxx>
27 #include <TopTools_HArray1OfShape.hxx>
28 #include <AIS_KindOfInteractive.hxx>
29 #include <Aspect_TypeOfLine.hxx>
30 #include <TColStd_HArray1OfTransient.hxx>
31 #include <Quantity_NameOfColor.hxx>
32
33
34 class TCollection_AsciiString;
35 class V3d_View;
36 class MMgt_TShared;
37 class TopoDS_Shape;
38 class AIS_InteractiveObject;
39 class V3d_Viewer;
40 class AIS_InteractiveContext;
41 class ViewerTest_EventManager;
42 class ViewerTest_EventManager;
43 class Quantity_Color;
44
45 class ViewerTest
46 {
47 public:
48
49   DEFINE_STANDARD_ALLOC
50
51   //! Loads all Draw commands of  V2d & V3d. Used for plugin.
52   Standard_EXPORT static void Factory (Draw_Interpretor& theDI);
53
54   //! Creates view with default or custom name
55   //! and add this name in map to manage muliple views
56   //! implemented in ViewerTest_ViewerCommands.cxx
57   Standard_EXPORT static TCollection_AsciiString ViewerInit (const Standard_Integer thePxLeft   = 0,
58                                                              const Standard_Integer thePxTop    = 0,
59                                                              const Standard_Integer thePxWidth  = 0,
60                                                              const Standard_Integer thePxHeight = 0,
61                                                              const Standard_CString theViewName = "",
62                                                              const Standard_CString theDisplayName = "");
63
64   Standard_EXPORT static void RemoveViewName (const TCollection_AsciiString& theName);
65
66   Standard_EXPORT static void InitViewName (const TCollection_AsciiString& theName,
67                                             const Handle(V3d_View)&        theView);
68
69   Standard_EXPORT static TCollection_AsciiString GetCurrentViewName();
70
71   //! Removes view and clear all maps
72   //! with information about its resources if necessary
73   Standard_EXPORT static void RemoveView (const TCollection_AsciiString& theViewName,
74                                           const Standard_Boolean         theToRemoveContext = Standard_True);
75
76   //! Removes view and clear all maps
77   //! with information about its resources if necessary
78   Standard_EXPORT static void RemoveView (const Handle(V3d_View)& theView,
79                                           const Standard_Boolean  theToRemoveContext = Standard_True);
80
81   //! Display AIS object in active Viewer and register it in the map of Interactive Objects with specified name.
82   //! @param theName            key to be associated to displayed interactive object
83   //! @param theObject          object to display
84   //! @param theToUpdate        redraw viewer after displaying object
85   //! @param theReplaceIfExists replace the object assigned to specified key
86   //! @return true if new object has been displayed
87   Standard_EXPORT static Standard_Boolean Display (const TCollection_AsciiString&       theName,
88                                                    const Handle(AIS_InteractiveObject)& theObject,
89                                                    const Standard_Boolean               theToUpdate = Standard_True,
90                                                    const Standard_Boolean               theReplaceIfExists = Standard_True);
91
92   //! waits until a shape of type <aType> is picked in the AIS Viewer and returns it.
93   //! if <aType> == TopAbs_Shape, any shape can be picked...
94   //! MaxPick  is the Max number before exiting, if no pick is successful
95   Standard_EXPORT static TopoDS_Shape PickShape (const TopAbs_ShapeEnum aType,
96                                                  const Standard_Integer MaxPick = 5);
97
98   //! wait until the array is filled with picked shapes.
99   //! returns True if the array is filled.
100   //! exit if number of unsuccessful picks =  <MaxPick>
101   Standard_EXPORT static Standard_Boolean PickShapes (const TopAbs_ShapeEnum           aType,
102                                                       Handle(TopTools_HArray1OfShape)& thepicked,
103                                                       const Standard_Integer           MaxPick = 5);
104
105   //! waits until an interactive object of a given Type
106   //! and signature is picked (default values authorize
107   //! selection of any Interactive Object)
108   //! exit if number of unsuccessful picks =  <MaxPick>
109   Standard_EXPORT static Handle(AIS_InteractiveObject) PickObject (const AIS_KindOfInteractive Type      = AIS_KOI_None,
110                                                                    const Standard_Integer      Signature = -1,
111                                                                    const Standard_Integer      MaxPick   = 5);
112
113   //! selection of several interactive objects.
114   //! Number is given by the size of <thepicked>
115   //! exit if number of unsuccesfull picks =  <MaxPick>
116   Standard_EXPORT static Standard_Boolean PickObjects (Handle(TColStd_HArray1OfTransient)& thepicked,
117                                                        const AIS_KindOfInteractive         Type = AIS_KOI_None,
118                                                        const Standard_Integer              Signature = -1,
119                                                        const Standard_Integer              MaxPick = 5);
120
121   Standard_EXPORT static void Commands (Draw_Interpretor& theCommands);
122
123   Standard_EXPORT static void ViewerCommands (Draw_Interpretor& theCommands);
124
125   Standard_EXPORT static void MyCommands (Draw_Interpretor& theCommands);
126
127   Standard_EXPORT static void RelationCommands (Draw_Interpretor& theCommands);
128
129   Standard_EXPORT static void ObjectCommands (Draw_Interpretor& theCommands);
130
131   Standard_EXPORT static void FilletCommands (Draw_Interpretor& theCommands);
132
133   Standard_EXPORT static void OpenGlCommands (Draw_Interpretor& theCommands);
134
135   Standard_EXPORT static void GetMousePosition (Standard_Integer& xpix, Standard_Integer& ypix);
136
137   Standard_EXPORT static Handle(V3d_Viewer) GetViewerFromContext();
138
139   Standard_EXPORT static Handle(V3d_Viewer) GetCollectorFromContext();
140
141   Standard_EXPORT static const Handle(AIS_InteractiveContext)& GetAISContext();
142
143   Standard_EXPORT static void SetAISContext (const Handle(AIS_InteractiveContext)& aContext);
144
145   Standard_EXPORT static const Handle(V3d_View)& CurrentView();
146
147   Standard_EXPORT static void CurrentView (const Handle(V3d_View)& aViou);
148
149   Standard_EXPORT static void Clear();
150
151   //! puts theMgr as current eventmanager (the move,select,...will be applied to theMgr)
152   Standard_EXPORT static void SetEventManager (const Handle(ViewerTest_EventManager)& theMgr);
153
154   //! removes the last EventManager from the list.
155   Standard_EXPORT static void UnsetEventManager();
156
157   //! clear the list of EventManagers and
158   //! sets the default EventManager as current
159   Standard_EXPORT static void ResetEventManager();
160
161   Standard_EXPORT static Handle(ViewerTest_EventManager) CurrentEventManager();
162
163   Standard_EXPORT static void RemoveSelected();
164
165   Standard_EXPORT static void StandardModeActivation (const Standard_Integer Mode);
166
167   Standard_EXPORT static Quantity_NameOfColor GetColorFromName (const Standard_CString name);
168
169   //! Parses color argument(s) specified within theArgVec[0], theArgVec[1] and theArgVec[2].
170   //! Handles either color specified by name (single argument)
171   //! or by RGB components (3 arguments) in range 0..1.
172   //! The result is stored in theColor on success.
173   //! Returns number of handled arguments (1 or 3) or 0 on syntax error.
174   Standard_EXPORT static Standard_Integer ParseColor (Standard_Integer theArgNb,
175                                                       const char**     theArgVec,
176                                                       Quantity_Color&  theColor);
177
178   //! redraws all defined views.
179   Standard_EXPORT static void RedrawAllViews();
180
181   //! Splits "parameter=value" string into separate
182   //! parameter and value strings.
183   //! @return TRUE if the string matches pattern "<string>=<empty or string>"
184   Standard_EXPORT static Standard_Boolean SplitParameter (const TCollection_AsciiString& theString,
185                                                           TCollection_AsciiString&       theName,
186                                                           TCollection_AsciiString&       theValue);
187
188   //! Parses boolean argument.
189   //! Handles either flag specified by 0|1 or on|off.
190   Standard_EXPORT static Standard_Boolean ParseOnOff (Standard_CString  theArg,
191                                                       Standard_Boolean& theIsOn);
192
193   //! Parses line type argument.
194   //! Handles either enumeration (integer) value or string constant.
195   Standard_EXPORT static Standard_Boolean ParseLineType (Standard_CString   theArg,
196                                                          Aspect_TypeOfLine& theType);
197
198 private:
199
200   //! Returns a window class that implements standard behavior of
201   //! all windows of the ViewerTest. This includes usual Open CASCADE
202   //! view conventions for mouse buttons (e.g. Ctrl+MB1 for zoom,
203   //! Ctrl+MB2 for pan, etc) and keyboard shortcuts.
204   //! This method is relevant for MS Windows only and respectively
205   //! returns WNT_WClass handle.
206   Standard_EXPORT static const Handle(MMgt_TShared)& WClass();
207 };
208
209 #endif // _ViewerTest_HeaderFile