0030674: Visualization, AIS_InteractiveObject - fix accessibility of several properties
[occt.git] / src / AIS / AIS_InteractiveObject.hxx
1 // Created on: 1996-12-11
2 // Created by: Robert COUBLANC
3 // Copyright (c) 1996-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 _AIS_InteractiveObject_HeaderFile
18 #define _AIS_InteractiveObject_HeaderFile
19
20 #include <AIS_KindOfInteractive.hxx>
21 #include <SelectMgr_SelectableObject.hxx>
22
23 class AIS_InteractiveContext;
24 class Graphic3d_MaterialAspect;
25 class Prs3d_Presentation;
26 class Prs3d_BasicAspect;
27 class Bnd_Box;
28
29 //! Defines a class of objects with display and selection services.
30 //! Entities which are visualized and selected are Interactive Objects.
31 //! Specific attributes of entities such as arrow aspect for dimensions must be loaded in a Prs3d_Drawer.
32 //!
33 //! You can make use of classes of standard Interactive Objects for which all necessary methods have already been programmed,
34 //! or you can implement your own classes of Interactive Objects.
35 //! Key interface methods to be implemented by every Interactive Object:
36 //! * Presentable Object (PrsMgr_PresentableObject)
37 //!   Consider defining an enumeration of supported Display Mode indexes for particular Interactive Object or class of Interactive Objects.
38 //!   - AcceptDisplayMode() accepting display modes implemented by this object;
39 //!   - Compute() computing presentation for the given display mode index;
40 //! * Selectable Object (SelectMgr_SelectableObject)
41 //!   Consider defining an enumeration of supported Selection Mode indexes for particular Interactive Object or class of Interactive Objects.
42 //!   - ComputeSelection() computing selectable entities for the given selection mode index.
43 class AIS_InteractiveObject : public SelectMgr_SelectableObject
44 {
45   friend class AIS_InteractiveContext;
46   DEFINE_STANDARD_RTTIEXT(AIS_InteractiveObject, SelectMgr_SelectableObject)
47 public:
48
49   //! Returns the kind of Interactive Object; AIS_KOI_None by default.
50   virtual AIS_KindOfInteractive Type() const { return AIS_KOI_None; }
51
52   //! Specifies additional characteristics of Interactive Object of Type(); -1 by default.
53   //! Among the datums, this signature is attributed to the shape.
54   //! The remaining datums have the following default signatures:
55   //! - Point          signature 1
56   //! - Axis           signature 2
57   //! - Trihedron      signature 3
58   //! - PlaneTrihedron signature 4
59   //! - Line           signature 5
60   //! - Circle         signature 6
61   //! - Plane          signature 7.
62   virtual Standard_Integer Signature() const { return -1; }
63   
64   //! Updates the active presentation; if <AllModes> = Standard_True
65   //! all the presentations inside are recomputed.
66   //! IMPORTANT: It is preferable to call Redisplay method of
67   //! corresponding AIS_InteractiveContext instance for cases when it
68   //! is accessible. This method just redirects call to myCTXPtr,
69   //! so this class field must be up to date for proper result.
70   Standard_EXPORT void Redisplay (const Standard_Boolean AllModes = Standard_False);
71
72   //! Indicates whether the Interactive Object has a pointer to an interactive context.
73   Standard_Boolean HasInteractiveContext() const { return myCTXPtr != NULL; }
74
75   //! Returns the context pointer to the interactive context.
76   AIS_InteractiveContext* InteractiveContext() const { return myCTXPtr; }
77   
78   //! Sets the interactive context aCtx and provides a link
79   //! to the default drawing tool or "Drawer" if there is none.
80   Standard_EXPORT virtual void SetContext (const Handle(AIS_InteractiveContext)& aCtx);
81   
82   //! Returns true if the object has an owner attributed to it.
83   //! The owner can be a shape for a set of sub-shapes or a sub-shape for sub-shapes which it is composed of, and takes the form of a transient.
84   Standard_Boolean HasOwner() const { return !myOwner.IsNull(); }
85   
86   //! Returns the owner of the Interactive Object.
87   //! The owner can be a shape for a set of sub-shapes or
88   //! a sub-shape for sub-shapes which it is composed of,
89   //! and takes the form of a transient.
90   //! There are two types of owners:
91   //! -   Direct owners, decomposition shapes such as
92   //! edges, wires, and faces.
93   //! -   Users, presentable objects connecting to sensitive
94   //! primitives, or a shape which has been decomposed.
95   const Handle(Standard_Transient)& GetOwner() const { return myOwner; }
96
97   //! Allows you to attribute the owner theApplicativeEntity to
98   //! an Interactive Object. This can be a shape for a set of
99   //! sub-shapes or a sub-shape for sub-shapes which it
100   //! is composed of. The owner takes the form of a transient.
101   void SetOwner (const Handle(Standard_Transient)& theApplicativeEntity) { myOwner = theApplicativeEntity; }
102
103   //! Each Interactive Object has methods which allow us to attribute an Owner to it in the form of a Transient.
104   //! This method removes the owner from the graphic entity.
105   void ClearOwner() { myOwner.Nullify(); }
106
107 public:
108
109   //! Returns the context pointer to the interactive context.
110   Standard_EXPORT Handle(AIS_InteractiveContext) GetContext() const;
111
112   //! Returns TRUE when this object has a presentation in the current DisplayMode()
113   Standard_EXPORT Standard_Boolean HasPresentation() const;
114
115   //! Returns the current presentation of this object according to the current DisplayMode()
116   Standard_EXPORT Handle(Prs3d_Presentation) Presentation() const;
117
118   //! Sets the graphic basic aspect to the current presentation.
119   Standard_DEPRECATED("Deprecated method, results might be undefined")
120   Standard_EXPORT void SetAspect (const Handle(Prs3d_BasicAspect)& anAspect);
121
122 protected:
123
124   //! The TypeOfPresention3d means that the interactive object
125   //! may have a presentation dependant of the view of Display.
126   Standard_EXPORT AIS_InteractiveObject(const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d = PrsMgr_TOP_AllView);
127
128 protected:
129
130   AIS_InteractiveContext*    myCTXPtr; //!< pointer to Interactive Context, where object is currently displayed; @sa SetContext()
131   Handle(Standard_Transient) myOwner;  //!< application-specific owner object
132
133 };
134
135 DEFINE_STANDARD_HANDLE(AIS_InteractiveObject, SelectMgr_SelectableObject)
136
137 #endif // _AIS_InteractiveObject_HeaderFile