HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
notice.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_BASE_PLUG_NOTICE_H
25 #define PXR_BASE_PLUG_NOTICE_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/base/plug/api.h"
30 #include "pxr/base/tf/notice.h"
31 
33 
35 
36 /// \class PlugNotice
37 /// Notifications sent by the Plug library.
39 {
40 public:
41  /// Base class for all Plug notices.
42  class Base : public TfNotice
43  {
44  public:
45  PLUG_API virtual ~Base();
46  };
47 
48  /// Notice sent after new plugins have been registered with the Plug
49  /// registry.
50  class DidRegisterPlugins : public Base
51  {
52  public:
53  explicit DidRegisterPlugins(const PlugPluginPtrVector& newPlugins);
54  PLUG_API virtual ~DidRegisterPlugins();
55 
56  const PlugPluginPtrVector& GetNewPlugins() const
57  { return _plugins; }
58 
59  private:
60  PlugPluginPtrVector _plugins;
61  };
62 
63 private:
64  PlugNotice();
65 };
66 
68 
69 #endif // PXR_BASE_PLUG_NOTICE_H
const PlugPluginPtrVector & GetNewPlugins() const
Definition: notice.h:56
PXR_NAMESPACE_OPEN_SCOPE TF_DECLARE_WEAK_PTRS(PlugPlugin)
virtual PLUG_API ~DidRegisterPlugins()
virtual PLUG_API ~Base()
DidRegisterPlugins(const PlugPluginPtrVector &newPlugins)
Base class for all Plug notices.
Definition: notice.h:42
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PLUG_API
Definition: api.h:40
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91