All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
gusd.h
1 //
2 // Copyright 2017 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 __GUSD_PXGUSD_H__
25 #define __GUSD_PXGUSD_H__
26 
27 #include "pxr/usd/usd/prim.h"
28 #include "gusd/api.h"
29 
30 #include "pxr/pxr.h"
31 #include <string>
32 #include <functional>
33 
34 class GA_PrimitiveFactory;
35 
36 PXR_NAMESPACE_OPEN_SCOPE
37 
38 class TfToken;
39 
40 GUSD_API
41 void GusdInit();
42 
43 GUSD_API
44 void GusdNewGeometryPrim( GA_PrimitiveFactory* f );
45 
46 GUSD_API
47 void GusdNewGeometryIO();
48 
49 // We sometimes need to be able to convert an absolute path to an asset to a
50 // path that can be resolved to an asset using lib Ar. How this is done depends
51 // on the site specific system used to resolve assets, so we provide a callback.
52 typedef std::function<std::string (const std::string&)> GusdPathComputeFunc;
53 
54 GUSD_API
55 void GusdRegisterComputeRelativeSearchPathFunc( const GusdPathComputeFunc &func );
56 
57 GUSD_API
58 std::string GusdComputeRelativeSearchPath( const std::string &path );
59 
60 // When we write a new asset to a USD file, we want to assign a "kind". By
61 // default we mark it a "component".
62 GUSD_API
63 void GusdSetAssetKind( const TfToken &kind );
64 
65 GUSD_API
66 TfToken GusdGetAssetKind();
67 
68 // We often need to call some function, which may be system
69 // specific, on a USD prim so we provide a callback.
70 typedef std::function<bool (const UsdPrim&)> GusdUsdPrimFunc;
71 
72 GUSD_API
73 void GusdRegisterOperateOnUsdPrimFunc( const GusdUsdPrimFunc &func );
74 
75 GUSD_API
76 bool GusdOperateOnUsdPrim( const UsdPrim &prim );
77 
78 PXR_NAMESPACE_CLOSE_SCOPE
79 
80 #endif
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a &quot;Prim&quot; as ...
Definition: prim.h:131