HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
boundableComputeExtent.h
Go to the documentation of this file.
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 USDGEOM_BOUNDABLE_COMPUTE_EXTENT_H
25 #define USDGEOM_BOUNDABLE_COMPUTE_EXTENT_H
26 
27 /// \file usdGeom/boundableComputeExtent.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdGeom/api.h"
31 
32 #include "pxr/base/gf/vec3f.h"
33 #include "pxr/base/vt/array.h"
34 
35 #include "pxr/base/tf/type.h"
36 
38 
39 class UsdGeomBoundable;
40 class UsdTimeCode;
41 
42 /// Function registered with #UsdGeomRegisterComputeExtentFunction for
43 /// computing extents for a Boundable prim at the given time and filling
44 /// the given VtVec3fArray with the result. If an optional transform matrix is
45 /// supplied, the extent is computed as if the object was first transformed by
46 /// the matrix. If the transform matrix is nullptr, the extent is computed as if
47 /// the identity matrix was passed.
48 ///
49 /// The Boundable is guaranteed to be convertible to the prim type this
50 /// function was registered with. The function must be thread-safe.
51 /// It should return true on success, false on failure.
52 using UsdGeomComputeExtentFunction = bool(*)(const UsdGeomBoundable&,
53  const UsdTimeCode&,
54  const GfMatrix4d*,
55  VtVec3fArray*);
56 
57 /// Registers \p fn as the function to use for computing extents for Boundable
58 /// prims of type \p PrimType by UsdGeomBoundable::ComputeExtentFromPlugins.
59 /// \p PrimType must derive from UsdGeomBoundable.
60 ///
61 /// Plugins should generally call this function in a TF_REGISTRY_FUNCTION.
62 /// For example:
63 ///
64 /// \code
65 /// TF_REGISTRY_FUNCTION(UsdGeomBoundable)
66 /// {
67 /// UsdGeomRegisterComputeExtentFunction<MyPrim>(MyComputeExtentFunction);
68 /// }
69 /// \endcode
70 ///
71 /// Plugins must also note that this function is implemented for a prim type
72 /// in that type's schema definition. For example:
73 ///
74 /// \code
75 /// class "MyPrim" (
76 /// ...
77 /// customData = {
78 /// dictionary extraPlugInfo = {
79 /// bool implementsComputeExtent = true
80 /// }
81 /// }
82 /// ...
83 /// )
84 /// { ... }
85 /// \endcode
86 ///
87 /// This allows the plugin system to discover this function dynamically
88 /// and load the plugin if needed.
89 template <class PrimType>
90 inline void
93 {
94  static_assert(
96  "Prim type must derive from UsdGeomBoundable");
97 
98  UsdGeomRegisterComputeExtentFunction(TfType::Find<PrimType>(), fn);
99 }
100 
101 /// \overload
103 void
105  const TfType& boundableType,
106  const UsdGeomComputeExtentFunction& fn);
107 
109 
110 #endif // USDGEOM_BOUNDABLE_COMPUTE_EXTENT_H
void UsdGeomRegisterComputeExtentFunction(const UsdGeomComputeExtentFunction &fn)
bool(*)(const UsdGeomBoundable &, const UsdTimeCode &, const GfMatrix4d *, VtVec3fArray *) UsdGeomComputeExtentFunction
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1245
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:83
Definition: type.h:70
#define USDGEOM_API
Definition: api.h:40
GLsizei const GLfloat * value
Definition: glew.h:1849