File: View_DisplayPreview.hxx

package info (click to toggle)
opencascade 7.9.2%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 301,932 kB
  • sloc: cpp: 1,523,264; tcl: 10,159; cs: 5,173; java: 1,554; sh: 1,342; ansic: 827; xml: 699; makefile: 31; javascript: 22
file content (78 lines) | stat: -rw-r--r-- 2,987 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
// Created on: 2020-01-25
// Created by: Natalia ERMOLAEVA
// Copyright (c) 2020 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef View_DisplayPreview_H
#define View_DisplayPreview_H

#include <inspector/View_DisplayActionType.hxx>

#include <AIS_InteractiveContext.hxx>
#include <Standard.hxx>
#include <Standard_Handle.hxx>
#include <Standard_Macro.hxx>

class AIS_InteractiveObject;
class View_PreviewParameters;

//! \class View_DisplayPreview
//! \brief It is responsible for communication with AIS Interactive Context to:
//! - display/erase presentations;
//! - change display mode of visualized presentations (Shaded or WireFrame mode)
//!
//! It contains containers of visualized presentations to obtain presentations relating only to this
//! displayer. Displayer is connected to AIS Interactive Context
class View_DisplayPreview
{
public:
  //! Constructor
  Standard_EXPORT View_DisplayPreview();

  //! Destructor
  virtual ~View_DisplayPreview() {}

  //! Stores the current context where the presentations will be displayed/erased.
  //! Erases previously displayed presentations if there were some displayed
  //! \param theContext a context instance
  Standard_EXPORT void SetContext(const Handle(AIS_InteractiveContext)& theContext);

  //! Returns preview parameters
  View_PreviewParameters* GetPreviewParameters() const { return myPreviewParameters; }

  //! Updates visibility of the presentations for the display type
  Standard_EXPORT void UpdatePreview(
    const View_DisplayActionType                        theType,
    const NCollection_List<Handle(Standard_Transient)>& thePresentations);

  //! Returns true if preview presentation is shown
  Standard_Boolean HasPreview() const { return !myPreviewPresentation.IsNull(); }

  //! Custom preview selection mode
  static Standard_Integer PreviewSelectionMode() { return 100; }

private:
  //! Returns the current context
  const Handle(AIS_InteractiveContext)& GetContext() const { return myContext; }

private:
  Handle(AIS_InteractiveContext) myContext; //!< context, where the displayer works

  View_PreviewParameters* myPreviewParameters; //!< drawer of preview presentation
  Handle(AIS_InteractiveObject)
    myPreviewPresentation; //!< presentation of preview for a selected object
  NCollection_List<Handle(AIS_InteractiveObject)>
    myPreviewReadyPresentations; //!< presentation of preview for a selected object
};

#endif