0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / SelectBasics / SelectBasics_EntityOwner.hxx
CommitLineData
42cf5bc1 1// Created on: 1995-02-09
2// Created by: Mister rmi
3// Copyright (c) 1995-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 _SelectBasics_EntityOwner_HeaderFile
18#define _SelectBasics_EntityOwner_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_Type.hxx>
22
23#include <Standard_Integer.hxx>
24#include <MMgt_TShared.hxx>
25#include <Standard_Boolean.hxx>
26class TopLoc_Location;
27
28
29class SelectBasics_EntityOwner;
30DEFINE_STANDARD_HANDLE(SelectBasics_EntityOwner, MMgt_TShared)
31
32//! defines an abstract owner of sensitive primitives.
33//! Owners are typically used to establish a connection
34//! between sensitive entities and high-level objects (e.g. presentations).
35//!
36//! Priority : It's possible to give a priority:
37//! the scale : [0-9] ; the default priority is 0
38//! it allows the predominance of one selected object upon
39//! another one if many objects are selected at the same time
40//!
41//! example : Selection of shapes : the owners are
42//! selectable objects (presentations)
43//!
44//! a user can give vertex priority [3], edges [2] faces [1] shape [0],
45//! so that if during selection one vertex one edge and one face are
46//! simultaneously detected, the vertex will only be hilighted.
47class SelectBasics_EntityOwner : public MMgt_TShared
48{
49
50public:
51
52
53 //! sets the selectable priority of the owner
54 void Set (const Standard_Integer aPriority);
55
56 Standard_Integer Priority() const;
57
58 Standard_EXPORT virtual Standard_Boolean HasLocation() const = 0;
59
60 Standard_EXPORT virtual void SetLocation (const TopLoc_Location& aLoc) = 0;
61
62 Standard_EXPORT virtual void ResetLocation() = 0;
63
64 Standard_EXPORT virtual TopLoc_Location Location() const = 0;
65
66
67
68
69 DEFINE_STANDARD_RTTI(SelectBasics_EntityOwner,MMgt_TShared)
70
71protected:
72
73
74 Standard_EXPORT SelectBasics_EntityOwner(const Standard_Integer aPriority = 0);
75
76 Standard_Integer mypriority;
77
78
79private:
80
81
82
83
84};
85
86
87#include <SelectBasics_EntityOwner.lxx>
88
89
90
91
92
93#endif // _SelectBasics_EntityOwner_HeaderFile