All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
writeCtrlFlags.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 
25 #ifndef __GUSD_WRITECTRLFLAGS_H__
26 #define __GUSD_WRITECTRLFLAGS_H__
27 
28 #include "gusd/api.h"
29 #include "pxr/pxr.h"
30 
31 #include <GT/GT_Primitive.h>
32 
33 PXR_NAMESPACE_OPEN_SCOPE
34 
35 // Flags indicating how we want to write geometry to a USD file. These flags
36 // are initialized by the ROP but they may be modified by primitive attributes.
37 // Values set in geometry packed prims will be inherited by the children of that
38 // prim.
39 
40 struct GusdWriteCtrlFlags {
41 
42  // Flags indicating what data to write when we are writing overlays
43  bool overPoints; // For point instancers, overlayPoints and overlayTransforms are synonymous.
44  bool overTransforms;
45  bool overPrimvars;
46  bool overAll; // Completely replace prims, including topology.
47  // For point instancers, if overlayAll is set and
48  // prototypes are specified, replace the prototypes.
49 
50  bool writeStaticGeo;
51  bool writeStaticTopology;
52  bool writeStaticPrimvars;
53 
54  GusdWriteCtrlFlags()
55  : overPoints( false )
56  , overTransforms( false )
57  , overPrimvars( false )
58  , overAll( false )
59  , writeStaticGeo( false )
60  , writeStaticTopology( false )
61  , writeStaticPrimvars( false )
62  {}
63 
64  // Update flags with values read from prims attributes.
65  GUSD_API
66  void update( const GT_PrimitiveHandle &prim );
67 
68  static bool getBoolAttr(
69  const GT_PrimitiveHandle& prim,
70  const char *attrName,
71  bool defaultValue );
72 };
73 
74 PXR_NAMESPACE_CLOSE_SCOPE
75 
76 #endif // __GUSD_WRITECTRLFLAGS_H__