0027596: Visualization, StdPrs_WFShape - pack isolines into single group of primitives
[occt.git] / src / Prs3d / Prs3d.hxx
1 // Created on: 1992-08-26
2 // Created by: Jean Louis FRENKEL
3 // Copyright (c) 1992-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _Prs3d_HeaderFile
18 #define _Prs3d_HeaderFile
19
20 #include <Graphic3d_ArrayOfPrimitives.hxx>
21 #include <Standard.hxx>
22 #include <Standard_DefineAlloc.hxx>
23 #include <Standard_Handle.hxx>
24 #include <Standard_Boolean.hxx>
25 #include <Quantity_Length.hxx>
26 #include <Standard_Real.hxx>
27 #include <Prs3d_Drawer.hxx>
28 #include <Prs3d_NListOfSequenceOfPnt.hxx>
29
30 class TopoDS_Shape;
31 class Prs3d_Presentation;
32
33 //! The Prs3d package provides the following services
34 //! -   a presentation object (the context for all
35 //! modifications to the display, its presentation will be
36 //! displayed in every view of an active viewer)
37 //! -   an attribute manager governing how objects such
38 //! as color, width, and type of line are displayed;
39 //! these are generic objects, whereas those in
40 //! StdPrs are specific geometries and topologies.
41 //! -   generic   algorithms providing default settings for
42 //! objects such as points, curves, surfaces and shapes
43 //! -   a root object which provides the abstract
44 //! framework for the DsgPrs definitions at work in
45 //! display of dimensions, relations and trihedra.
46 class Prs3d 
47 {
48 public:
49
50   DEFINE_STANDARD_ALLOC
51   
52   //! draws an arrow at a given location, with respect
53   //! to a given direction.
54   Standard_EXPORT static Standard_Boolean MatchSegment (const Quantity_Length X, const Quantity_Length Y, const Quantity_Length Z, const Quantity_Length aDistance, const gp_Pnt& p1, const gp_Pnt& p2, Quantity_Length& dist);
55   
56   //! Computes the absolute deflection value depending on
57   //! the type of deflection in theDrawer:
58   //! <ul>
59   //! <li><b>Aspect_TOD_RELATIVE</b>: the absolute deflection is computed using the relative
60   //! deviation coefficient from theDrawer and the shape's bounding box;</li>
61   //! <li><b>Aspect_TOD_ABSOLUTE</b>: the maximal chordial deviation from theDrawer is returned.</li>
62   //! </ul>
63   //! In case of the type of deflection in theDrawer computed relative deflection for shape
64   //! is stored as absolute deflection. It is necessary to use it later on for sub-shapes.
65   //! This function should always be used to compute the deflection value for building
66   //! discrete representations of the shape (triangualtion, wireframe) to avoid incosistencies
67   //! between different representations of the shape and undesirable visual artifacts.
68   Standard_EXPORT static Standard_Real GetDeflection (const TopoDS_Shape& theShape, const Handle(Prs3d_Drawer)& theDrawer);
69
70   //! Assembles array of primitives for sequence of polylines.
71   //! @param thePoints [in] the polylines sequence
72   //! @return array of primitives
73   Standard_EXPORT static Handle(Graphic3d_ArrayOfPrimitives) PrimitivesFromPolylines (const Prs3d_NListOfSequenceOfPnt& thePoints);
74
75   //! Add primitives into new group in presentation and clear the list of polylines.
76   Standard_EXPORT static void AddPrimitivesGroup (const Handle(Prs3d_Presentation)& thePrs,
77                                                   const Handle(Prs3d_LineAspect)&   theAspect,
78                                                   Prs3d_NListOfSequenceOfPnt&       thePolylines);
79
80 };
81
82 #endif // _Prs3d_HeaderFile