0031687: Draw Harness, ViewerTest - extend command vrenderparams with option updating...
[occt.git] / src / AIS / AIS_MultipleConnectedInteractive.hxx
CommitLineData
42cf5bc1 1// Created on: 1997-04-22
2// Created by: Guest Design
3// Copyright (c) 1997-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_MultipleConnectedInteractive_HeaderFile
18#define _AIS_MultipleConnectedInteractive_HeaderFile
19
42cf5bc1 20#include <AIS_InteractiveObject.hxx>
42cf5bc1 21#include <AIS_KindOfInteractive.hxx>
42cf5bc1 22
23//! Defines an Interactive Object by gathering together
24//! several object presentations. This is done through a
25//! list of interactive objects. These can also be
26//! Connected objects. That way memory-costly
27//! calculations of presentation are avoided.
28class AIS_MultipleConnectedInteractive : public AIS_InteractiveObject
29{
1f7f5a90 30 DEFINE_STANDARD_RTTIEXT(AIS_MultipleConnectedInteractive, AIS_InteractiveObject)
42cf5bc1 31public:
32
42cf5bc1 33 //! Initializes the Interactive Object with multiple
34 //! connections to AIS_Interactive objects.
35 Standard_EXPORT AIS_MultipleConnectedInteractive();
1f7f5a90 36
42cf5bc1 37 //! Establishes the connection between the Connected Interactive Object, theInteractive, and its reference.
38 //! Locates instance in theLocation and applies specified transformation persistence mode.
39 //! @return created instance object (AIS_ConnectedInteractive or AIS_MultipleConnectedInteractive)
1f7f5a90 40 Handle(AIS_InteractiveObject) Connect (const Handle(AIS_InteractiveObject)& theAnotherObj,
7f24b768 41 const Handle(TopLoc_Datum3D)& theLocation,
1f7f5a90 42 const Handle(Graphic3d_TransformPers)& theTrsfPers)
778cd667 43 {
1f7f5a90 44 return connect (theAnotherObj, theLocation, theTrsfPers);
778cd667 45 }
1f7f5a90 46
42cf5bc1 47 Standard_EXPORT virtual AIS_KindOfInteractive Type() const Standard_OVERRIDE;
48
49 Standard_EXPORT virtual Standard_Integer Signature() const Standard_OVERRIDE;
50
51 //! Returns true if the object is connected to others.
52 Standard_EXPORT Standard_Boolean HasConnection() const;
53
54 //! Removes the connection with theInteractive.
55 Standard_EXPORT void Disconnect (const Handle(AIS_InteractiveObject)& theInteractive);
56
57 //! Clears all the connections to objects.
58 Standard_EXPORT void DisconnectAll();
59
42cf5bc1 60 //! Informs the graphic context that the interactive Object
61 //! may be decomposed into sub-shapes for dynamic selection.
62 Standard_EXPORT virtual Standard_Boolean AcceptShapeDecomposition() const Standard_OVERRIDE;
63
b5cce1ab 64 //! Returns common entity owner if the object is an assembly
65 virtual const Handle(SelectMgr_EntityOwner)& GetAssemblyOwner() const Standard_OVERRIDE { return myAssemblyOwner; }
42cf5bc1 66
b5cce1ab 67 //! Returns the owner of mode for selection of object as a whole
68 virtual Handle(SelectMgr_EntityOwner) GlobalSelOwner() const Standard_OVERRIDE { return myAssemblyOwner; }
42cf5bc1 69
2ec85268 70 //! Assigns interactive context.
71 Standard_EXPORT virtual void SetContext (const Handle(AIS_InteractiveContext)& theCtx) Standard_OVERRIDE;
72
1f7f5a90 73public: // short aliases to Connect() method
42cf5bc1 74
1f7f5a90 75 //! Establishes the connection between the Connected Interactive Object, theInteractive, and its reference.
76 //! Copies local transformation and transformation persistence mode from theInteractive.
77 //! @return created instance object (AIS_ConnectedInteractive or AIS_MultipleConnectedInteractive)
78 Handle(AIS_InteractiveObject) Connect (const Handle(AIS_InteractiveObject)& theAnotherObj)
79 {
80 return connect (theAnotherObj, theAnotherObj->LocalTransformationGeom(), theAnotherObj->TransformPersistence());
81 }
42cf5bc1 82
1f7f5a90 83 //! Establishes the connection between the Connected Interactive Object, theInteractive, and its reference.
84 //! Locates instance in theLocation and copies transformation persistence mode from theInteractive.
85 //! @return created instance object (AIS_ConnectedInteractive or AIS_MultipleConnectedInteractive)
86 Handle(AIS_InteractiveObject) Connect (const Handle(AIS_InteractiveObject)& theAnotherObj,
87 const gp_Trsf& theLocation)
88 {
7f24b768 89 return connect (theAnotherObj, new TopLoc_Datum3D (theLocation), theAnotherObj->TransformPersistence());
1f7f5a90 90 }
91
92 //! Establishes the connection between the Connected Interactive Object, theInteractive, and its reference.
93 //! Locates instance in theLocation and applies specified transformation persistence mode.
94 //! @return created instance object (AIS_ConnectedInteractive or AIS_MultipleConnectedInteractive)
95 Handle(AIS_InteractiveObject) Connect (const Handle(AIS_InteractiveObject)& theAnotherObj,
96 const gp_Trsf& theLocation,
97 const Handle(Graphic3d_TransformPers)& theTrsfPers)
98 {
7f24b768 99 return connect (theAnotherObj, new TopLoc_Datum3D (theLocation), theTrsfPers);
1f7f5a90 100 }
101
102 Standard_DEPRECATED("This method is deprecated - Connect() taking Graphic3d_TransformPers should be called instead")
103 Handle(AIS_InteractiveObject) Connect (const Handle(AIS_InteractiveObject)& theInteractive,
104 const gp_Trsf& theLocation,
105 const Graphic3d_TransModeFlags& theTrsfPersFlag,
106 const gp_Pnt& theTrsfPersPoint)
107 {
7f24b768 108 return connect (theInteractive, new TopLoc_Datum3D (theLocation), Graphic3d_TransformPers::FromDeprecatedParams (theTrsfPersFlag, theTrsfPersPoint));
1f7f5a90 109 }
110
111protected:
42cf5bc1 112
113 //! this method is redefined virtual;
114 //! when the instance is connected to another
115 //! InteractiveObject,this method doesn't
116 //! compute anything, but just uses the
117 //! presentation of this last object, with
118 //! a transformation if there's one stored.
119 Standard_EXPORT virtual void Compute (const Handle(PrsMgr_PresentationManager3d)& aPresentationManager, const Handle(Prs3d_Presentation)& aPresentation, const Standard_Integer aMode = 0) Standard_OVERRIDE;
120
1f7f5a90 121 //! Establishes the connection between the Connected Interactive Object, theInteractive, and its reference.
122 //! Locates instance in theLocation and applies specified transformation persistence mode.
123 //! @return created instance object (AIS_ConnectedInteractive or AIS_MultipleConnectedInteractive)
124 Standard_EXPORT virtual Handle(AIS_InteractiveObject) connect (const Handle(AIS_InteractiveObject)& theInteractive,
7f24b768 125 const Handle(TopLoc_Datum3D)& theLocation,
1f7f5a90 126 const Handle(Graphic3d_TransformPers)& theTrsfPers);
42cf5bc1 127
128private:
42cf5bc1 129
130 //! Computes the selection for whole subtree in scene hierarchy.
131 Standard_EXPORT virtual void ComputeSelection (const Handle(SelectMgr_Selection)& aSelection, const Standard_Integer aMode) Standard_OVERRIDE;
132
b5cce1ab 133protected:
134
135 Handle(SelectMgr_EntityOwner) myAssemblyOwner;
136
42cf5bc1 137};
138
1f7f5a90 139DEFINE_STANDARD_HANDLE(AIS_MultipleConnectedInteractive, AIS_InteractiveObject)
42cf5bc1 140
141#endif // _AIS_MultipleConnectedInteractive_HeaderFile