0029814: Modeling Data - add method TopoDS_Shape::NbChildren() for simple check of...
[occt.git] / src / XCAFPrs / XCAFPrs_AISObject.cxx
1 // Created on: 2000-08-11
2 // Created by: Andrey BETENEV
3 // Copyright (c) 2000-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #include <XCAFPrs_AISObject.hxx>
17
18 #include <AIS_DisplayMode.hxx>
19 #include <BRep_Builder.hxx>
20 #include <BRepBndLib.hxx>
21 #include <gp_Pnt.hxx>
22 #include <Graphic3d_AspectFillArea3d.hxx>
23 #include <Graphic3d_AspectLine3d.hxx>
24 #include <Prs3d_Drawer.hxx>
25 #include <Prs3d_DimensionAspect.hxx>
26 #include <Prs3d_IsoAspect.hxx>
27 #include <Prs3d_LineAspect.hxx>
28 #include <Prs3d_ShadingAspect.hxx>
29 #include <Prs3d_Text.hxx>
30 #include <TDataStd_Name.hxx>
31 #include <TDF_LabelSequence.hxx>
32 #include <TPrsStd_AISPresentation.hxx>
33 #include <TopoDS_Iterator.hxx>
34 #include <XCAFDoc_ShapeTool.hxx>
35 #include <XCAFPrs.hxx>
36 #include <XCAFPrs_IndexedDataMapOfShapeStyle.hxx>
37 #include <XCAFPrs_DataMapIteratorOfIndexedDataMapOfShapeStyle.hxx>
38 #include <XCAFPrs_Style.hxx>
39
40
41 IMPLEMENT_STANDARD_RTTIEXT(XCAFPrs_AISObject,AIS_ColoredShape)
42
43 //=======================================================================
44 //function : XCAFPrs_AISObject
45 //purpose  : 
46 //=======================================================================
47
48 XCAFPrs_AISObject::XCAFPrs_AISObject (const TDF_Label& theLabel)
49 : AIS_ColoredShape(TopoDS_Shape()),
50   myToSyncStyles (Standard_True)
51 {
52   // define plastic material by default for proper color reproduction
53   setMaterial (myDrawer, Graphic3d_NOM_PLASTIC, Standard_False, Standard_False);
54   hasOwnMaterial = Standard_True;
55
56   myLabel = theLabel;
57 }
58
59 //=======================================================================
60 //function : DisplayText
61 //purpose  : 
62 //=======================================================================
63
64 static void DisplayText (const TDF_Label& aLabel,
65                          const Handle(Prs3d_Presentation)& aPrs,
66                          const Handle(Prs3d_TextAspect)& anAspect,
67                          const TopLoc_Location& aLocation)
68 {
69   // first label itself
70   Handle (TDataStd_Name) aName;
71   if (aLabel.FindAttribute (TDataStd_Name::GetID(), aName)) {
72     TopoDS_Shape aShape;
73     if (XCAFDoc_ShapeTool::GetShape (aLabel, aShape)) {
74       // find the position to display as middle of the bounding box
75       aShape.Move (aLocation);
76       Bnd_Box aBox;
77       BRepBndLib::Add (aShape, aBox);
78       if ( ! aBox.IsVoid() ) 
79       {
80         Standard_Real aXmin, aYmin, aZmin, aXmax, aYmax, aZmax;
81         aBox.Get (aXmin, aYmin, aZmin, aXmax, aYmax, aZmax);
82         gp_Pnt aPnt (0.5 * (aXmin + aXmax), 0.5 * (aYmin + aYmax), 0.5 * (aZmin + aZmax));
83         Prs3d_Text::Draw (Prs3d_Root::CurrentGroup (aPrs), anAspect, aName->Get(), aPnt);
84       }
85     }
86   }
87
88   TDF_LabelSequence seq;
89   
90   // attibutes of subshapes
91   if (XCAFDoc_ShapeTool::GetSubShapes (aLabel, seq)) {
92     Standard_Integer i = 1;
93     for (i = 1; i <= seq.Length(); i++) {
94       TDF_Label aL = seq.Value (i);
95       DisplayText (aL, aPrs, anAspect, aLocation); //suppose that subshapes do not contain locations
96     }
97   }
98   
99   // attibutes of components
100   seq.Clear();
101   if (XCAFDoc_ShapeTool::GetComponents (aLabel, seq)) {
102     Standard_Integer i = 1;
103     for (i = 1; i <= seq.Length(); i++) {
104       TDF_Label aL = seq.Value (i);
105       DisplayText (aL, aPrs, anAspect, aLocation);
106       TDF_Label aRefLabel;
107       
108       // attributes of referrences
109       TopLoc_Location aLoc = XCAFDoc_ShapeTool::GetLocation (aL);
110       if (XCAFDoc_ShapeTool::GetReferredShape (aL, aRefLabel)) {
111         DisplayText (aRefLabel, aPrs, anAspect, aLoc);
112       }
113     }
114   }
115 }
116
117 //=======================================================================
118 //function : DispatchStyles
119 //purpose  :
120 //=======================================================================
121 void XCAFPrs_AISObject::DispatchStyles (const Standard_Boolean theToSyncStyles)
122 {
123   myToSyncStyles = theToSyncStyles;
124   myShapeColors.Clear();
125
126   TopoDS_Shape aShape;
127   if (!XCAFDoc_ShapeTool::GetShape (myLabel, aShape) || aShape.IsNull())
128   {
129     Set (TopoDS_Shape());
130     return;
131   }
132   Set (aShape);
133
134   // Collecting information on colored subshapes
135   TopLoc_Location aLoc;
136   XCAFPrs_IndexedDataMapOfShapeStyle aSettings;
137   XCAFPrs::CollectStyleSettings (myLabel, aLoc, aSettings);
138
139   // Getting default colors
140   XCAFPrs_Style aDefStyle;
141   DefaultStyle (aDefStyle);
142   Quantity_Color aColorCurv = aDefStyle.GetColorCurv();
143   Quantity_ColorRGBA aColorSurf = aDefStyle.GetColorSurfRGBA();
144
145   SetColors (myDrawer, aColorCurv, aColorSurf);
146
147   // collect sub-shapes with the same style into compounds
148   BRep_Builder aBuilder;
149   NCollection_IndexedDataMap<XCAFPrs_Style, TopoDS_Compound, XCAFPrs_Style> aStyleGroups;
150   for (XCAFPrs_DataMapIteratorOfIndexedDataMapOfShapeStyle aStyledShapeIter (aSettings);
151        aStyledShapeIter.More(); aStyledShapeIter.Next())
152   {
153     TopoDS_Compound aComp;
154     if (aStyleGroups.FindFromKey (aStyledShapeIter.Value(), aComp))
155     {
156       aBuilder.Add (aComp, aStyledShapeIter.Key());
157       continue;
158     }
159
160     aBuilder.MakeCompound (aComp);
161     aBuilder.Add (aComp, aStyledShapeIter.Key());
162     TopoDS_Compound* aMapShape = aStyleGroups.ChangeSeek (aStyledShapeIter.Value());
163     if (aMapShape == NULL)
164       aStyleGroups.Add (aStyledShapeIter.Value(), aComp);
165     else
166       *aMapShape = aComp;
167   }
168   aSettings.Clear();
169
170   // assign custom aspects
171   for (NCollection_IndexedDataMap<XCAFPrs_Style, TopoDS_Compound, XCAFPrs_Style>::Iterator aStyleGroupIter (aStyleGroups);
172        aStyleGroupIter.More(); aStyleGroupIter.Next())
173   {
174     const TopoDS_Compound& aComp = aStyleGroupIter.Value();
175     TopoDS_Iterator aShapeIter (aComp);
176     TopoDS_Shape aShapeCur = aShapeIter.Value();
177     aShapeIter.Next();
178     if (aShapeIter.More())
179     {
180       aShapeCur = aComp;
181     }
182
183     Handle(AIS_ColoredDrawer) aDrawer = CustomAspects (aShapeCur);
184     const XCAFPrs_Style& aStyle = aStyleGroupIter.Key();
185     aDrawer->SetHidden (!aStyle.IsVisible());
186
187     aColorCurv = aStyle.IsSetColorCurv() ? aStyle.GetColorCurv()     : aDefStyle.GetColorCurv();
188     aColorSurf = aStyle.IsSetColorSurf() ? aStyle.GetColorSurfRGBA() : aDefStyle.GetColorSurfRGBA();
189
190     SetColors (aDrawer, aColorCurv, aColorSurf);
191   }
192   aStyleGroups.Clear();
193 }
194
195 //=======================================================================
196 //function : Compute
197 //purpose  :
198 //=======================================================================
199 void XCAFPrs_AISObject::Compute (const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
200                                  const Handle(Prs3d_Presentation)&           thePrs,
201                                  const Standard_Integer                      theMode)
202 {
203   // update shape and sub-shapes styles only on first compute, or on first recompute
204   if (myToSyncStyles)
205   {
206     Standard_Boolean toMapStyles = myToSyncStyles;
207     for (PrsMgr_Presentations::Iterator aPrsIter (myPresentations); aPrsIter.More(); aPrsIter.Next())
208     {
209       if (aPrsIter.Value().Presentation()->Presentation() != thePrs
210       && !aPrsIter.Value().Presentation()->MustBeUpdated())
211       {
212         toMapStyles = Standard_False;
213         break;
214       }
215     }
216     if (toMapStyles)
217     {
218       DispatchStyles (Standard_True);
219     }
220   }
221   if (myshape.IsNull())
222   {
223     return;
224   }
225
226   if (myshape.ShapeType() == TopAbs_COMPOUND)
227   {
228     if (myshape.NbChildren() == 0)
229     {
230       return;
231     }
232   }
233
234   AIS_ColoredShape::Compute (thePresentationManager, thePrs, theMode);
235
236   if (XCAFPrs::GetViewNameMode())
237   {
238     // Displaying Name attributes
239     thePrs->SetDisplayPriority (10);
240     DisplayText (myLabel, thePrs, Attributes()->DimensionAspect()->TextAspect(), TopLoc_Location());//no location
241   }
242 }
243
244 //=======================================================================
245 //function : SetColors
246 //purpose  :
247 //=======================================================================
248 void XCAFPrs_AISObject::SetColors (const Handle(Prs3d_Drawer)& theDrawer,
249                                    const Quantity_Color&       theColorCurv,
250                                    const Quantity_ColorRGBA&   theColorSurf)
251 {
252   if (!theDrawer->HasOwnShadingAspect())
253   {
254     theDrawer->SetShadingAspect (new Prs3d_ShadingAspect());
255     if (theDrawer->HasLink())
256     {
257       *theDrawer->ShadingAspect()->Aspect() = *theDrawer->Link()->ShadingAspect()->Aspect();
258     }
259   }
260   if (!theDrawer->HasOwnLineAspect())
261   {
262     theDrawer->SetLineAspect (new Prs3d_LineAspect (Quantity_NOC_BLACK, Aspect_TOL_SOLID, 1.0));
263     if (theDrawer->HasLink())
264     {
265       *theDrawer->LineAspect()->Aspect() = *theDrawer->Link()->LineAspect()->Aspect();
266     }
267   }
268   if (!theDrawer->HasOwnWireAspect())
269   {
270     theDrawer->SetWireAspect (new Prs3d_LineAspect (Quantity_NOC_BLACK, Aspect_TOL_SOLID, 1.0));
271     if (theDrawer->HasLink())
272     {
273       *theDrawer->WireAspect()->Aspect() = *theDrawer->Link()->WireAspect()->Aspect();
274     }
275   }
276   if (!theDrawer->HasOwnUIsoAspect())
277   {
278     theDrawer->SetUIsoAspect (new Prs3d_IsoAspect (Quantity_NOC_GRAY75, Aspect_TOL_SOLID, 0.5, 1));
279     if (theDrawer->HasLink())
280     {
281       *theDrawer->UIsoAspect()->Aspect() = *theDrawer->Link()->UIsoAspect()->Aspect();
282       theDrawer->UIsoAspect()->SetNumber (theDrawer->Link()->UIsoAspect()->Number());
283     }
284   }
285   if (!theDrawer->HasOwnVIsoAspect())
286   {
287     theDrawer->SetVIsoAspect (new Prs3d_IsoAspect (Quantity_NOC_GRAY75, Aspect_TOL_SOLID, 0.5, 1));
288     if (theDrawer->HasLink())
289     {
290       *theDrawer->VIsoAspect()->Aspect() = *theDrawer->Link()->VIsoAspect()->Aspect();
291       theDrawer->VIsoAspect()->SetNumber (theDrawer->Link()->VIsoAspect()->Number());
292     }
293   }
294   if (!theDrawer->HasOwnFreeBoundaryAspect())
295   {
296     theDrawer->SetFreeBoundaryAspect (new Prs3d_LineAspect (Quantity_NOC_BLACK, Aspect_TOL_SOLID, 1.0));
297     if (theDrawer->HasLink())
298     {
299       *theDrawer->FreeBoundaryAspect()->Aspect() = *theDrawer->Link()->FreeBoundaryAspect()->Aspect();
300     }
301   }
302   if (!theDrawer->HasOwnUnFreeBoundaryAspect())
303   {
304     theDrawer->SetUnFreeBoundaryAspect (new Prs3d_LineAspect (Quantity_NOC_BLACK, Aspect_TOL_SOLID, 1.0));
305     if (theDrawer->HasLink())
306     {
307       *theDrawer->UnFreeBoundaryAspect()->Aspect() = *theDrawer->Link()->UnFreeBoundaryAspect()->Aspect();
308     }
309   }
310
311   theDrawer->UnFreeBoundaryAspect()->SetColor (theColorCurv);
312   theDrawer->FreeBoundaryAspect()->SetColor (theColorCurv);
313   theDrawer->WireAspect()->SetColor (theColorCurv);
314
315   Graphic3d_MaterialAspect aMaterial = myDrawer->ShadingAspect()->Aspect()->FrontMaterial();
316   aMaterial.SetColor (theColorSurf.GetRGB());
317   aMaterial.SetAlpha (theColorSurf.Alpha());
318   theDrawer->ShadingAspect()->Aspect()->SetInteriorColor (theColorSurf);
319   theDrawer->ShadingAspect()->Aspect()->SetFrontMaterial (aMaterial);
320   theDrawer->UIsoAspect()->SetColor (theColorSurf.GetRGB());
321   theDrawer->VIsoAspect()->SetColor (theColorSurf.GetRGB());
322 }
323
324 //=======================================================================
325 //function : DefaultStyle
326 //purpose  : DefaultStyle() can be redefined by subclasses in order to set custom default style
327 //=======================================================================
328 void XCAFPrs_AISObject::DefaultStyle (XCAFPrs_Style& theStyle) const
329 {
330   theStyle.SetColorSurf (Quantity_NOC_WHITE);
331   theStyle.SetColorCurv (Quantity_NOC_WHITE);
332 }
333
334 // =======================================================================
335 // function : SetMaterial
336 // purpose  :
337 // =======================================================================
338 void XCAFPrs_AISObject::SetMaterial (const Graphic3d_MaterialAspect& theMaterial)
339 {
340   XCAFPrs_Style aDefStyle;
341   DefaultStyle (aDefStyle);
342   setMaterial (myDrawer, theMaterial, HasColor(), IsTransparent());
343   SetColors (myDrawer, aDefStyle.GetColorCurv(), aDefStyle.GetColorSurf());
344   for (AIS_DataMapOfShapeDrawer::Iterator anIter (myShapeColors); anIter.More(); anIter.Next())
345   {
346     const Handle(AIS_ColoredDrawer)& aDrawer = anIter.Value();
347
348     // take current color
349     const Quantity_Color     aColorCurv = aDrawer->WireAspect()->Aspect()->Color();
350     const Quantity_ColorRGBA aSurfColor = aDrawer->ShadingAspect()->Aspect()->InteriorColorRGBA();
351
352     // SetColors() will take the material from myDrawer
353     SetColors (aDrawer, aColorCurv, aSurfColor);
354   }
355   SynchronizeAspects();
356 }