include/opencascade/TPrsStd_AISViewer.hxx

0001 // Created on: 1998-09-30
0002 // Created by: Denis PASCAL
0003 // Copyright (c) 1998-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 _TPrsStd_AISViewer_HeaderFile
0018 #define _TPrsStd_AISViewer_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <TDF_Attribute.hxx>
0024 class AIS_InteractiveContext;
0025 class Standard_GUID;
0026 class TDF_Label;
0027 class V3d_Viewer;
0028 class TDF_RelocationTable;
0029
0030
0031 class TPrsStd_AISViewer;
0032 DEFINE_STANDARD_HANDLE(TPrsStd_AISViewer, TDF_Attribute)
0033
0034 //! The groundwork to define an interactive viewer attribute.
0035 //! This attribute stores an interactive context at the root label.
0036 //! You can only have one instance of this class per data framework.
0037 class TPrsStd_AISViewer : public TDF_Attribute
0038 {
0039
0040 public:
0041
0042
0043   //! class methods
0044   //! =============
0045   Standard_EXPORT static const Standard_GUID& GetID();
0046
0047   //! returns True if   there is an AISViewer attribute  in
0048   //! <acces> Data Framework.
0049   Standard_EXPORT static Standard_Boolean Has (const TDF_Label& acces);
0050
0051   //! create and set an  AISViewer at. Raise an exception if
0052   //! Has.
0053   Standard_EXPORT static Handle(TPrsStd_AISViewer) New (const TDF_Label& access, const Handle(AIS_InteractiveContext)& selector);
0054
0055   //! create  and set an   AISAttribute at root  label. The
0056   //! interactive context is  build.  Raise an exception  if
0057   //! Has.
0058   Standard_EXPORT static Handle(TPrsStd_AISViewer) New (const TDF_Label& acces, const Handle(V3d_Viewer)& viewer);
0059
0060
0061   //! Finds the viewer attribute at the label access, the
0062   //! root of the data framework. Calling this function can be used to initialize an AIS viewer
0063   Standard_EXPORT static Standard_Boolean Find (const TDF_Label& acces, Handle(TPrsStd_AISViewer)& A);
0064
0065   Standard_EXPORT static Standard_Boolean Find (const TDF_Label& acces, Handle(AIS_InteractiveContext)& IC);
0066
0067   Standard_EXPORT static Standard_Boolean Find (const TDF_Label& acces, Handle(V3d_Viewer)& V);
0068
0069   //! AISViewer methods
0070   //! =================
0071   Standard_EXPORT static void Update (const TDF_Label& acces);
0072
0073   Standard_EXPORT TPrsStd_AISViewer();
0074
0075   //! Updates the viewer at the label access.
0076   //! access is the root of the data framework.
0077   Standard_EXPORT void Update() const;
0078
0079   //! Sets the interactive context ctx for this attribute.
0080   Standard_EXPORT void SetInteractiveContext (const Handle(AIS_InteractiveContext)& ctx);
0081
0082   //! Returns the interactive context in this attribute.
0083   Standard_EXPORT Handle(AIS_InteractiveContext) GetInteractiveContext() const;
0084
0085   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0086
0087   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& with) Standard_OVERRIDE;
0088
0089   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0090
0091   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0092
0093   //! Dumps the content of me into the stream
0094   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
0095
0096
0097
0098   DEFINE_STANDARD_RTTIEXT(TPrsStd_AISViewer,TDF_Attribute)
0099
0100 protected:
0101
0102
0103
0104
0105 private:
0106
0107
0108   Handle(AIS_InteractiveContext) myInteractiveContext;
0109
0110
0111 };
0112
0113
0114
0115
0116
0117
0118
0119 #endif // _TPrsStd_AISViewer_HeaderFile