All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
boundable.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 USDGEOM_GENERATED_BOUNDABLE_H
25 #define USDGEOM_GENERATED_BOUNDABLE_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdGeom/api.h"
31 #include "pxr/usd/usdGeom/xformable.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/usdGeom/tokens.h"
35 
36 #include "pxr/base/vt/value.h"
37 
38 #include "pxr/base/gf/vec3d.h"
39 #include "pxr/base/gf/vec3f.h"
40 #include "pxr/base/gf/matrix4d.h"
41 
42 #include "pxr/base/tf/token.h"
43 #include "pxr/base/tf/type.h"
44 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // BOUNDABLE //
51 // -------------------------------------------------------------------------- //
52 
83 {
84 public:
89 
94  explicit UsdGeomBoundable(const UsdPrim& prim=UsdPrim())
95  : UsdGeomXformable(prim)
96  {
97  }
98 
102  explicit UsdGeomBoundable(const UsdSchemaBase& schemaObj)
103  : UsdGeomXformable(schemaObj)
104  {
105  }
106 
108  USDGEOM_API
109  virtual ~UsdGeomBoundable();
110 
114  USDGEOM_API
115  static const TfTokenVector &
116  GetSchemaAttributeNames(bool includeInherited=true);
117 
127  USDGEOM_API
128  static UsdGeomBoundable
129  Get(const UsdStagePtr &stage, const SdfPath &path);
130 
131 
132 protected:
136  USDGEOM_API
137  UsdSchemaType _GetSchemaType() const override;
138 
139 private:
140  // needs to invoke _GetStaticTfType.
141  friend class UsdSchemaRegistry;
142  USDGEOM_API
143  static const TfType &_GetStaticTfType();
144 
145  static bool _IsTypedSchema();
146 
147  // override SchemaBase virtuals.
148  USDGEOM_API
149  const TfType &_GetTfType() const override;
150 
151 public:
152  // --------------------------------------------------------------------- //
153  // EXTENT
154  // --------------------------------------------------------------------- //
171  USDGEOM_API
172  UsdAttribute GetExtentAttr() const;
173 
179  USDGEOM_API
180  UsdAttribute CreateExtentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
181 
182 public:
183  // ===================================================================== //
184  // Feel free to add custom code below this line, it will be preserved by
185  // the code generator.
186  //
187  // Just remember to:
188  // - Close the class declaration with };
189  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
190  // - Close the include guard with #endif
191  // ===================================================================== //
192  // --(BEGIN CUSTOM CODE)--
193 
209  USDGEOM_API
210  static bool ComputeExtentFromPlugins(const UsdGeomBoundable &boundable,
211  const UsdTimeCode &time,
212  VtVec3fArray *extent);
213 
216  USDGEOM_API
217  static bool ComputeExtentFromPlugins(const UsdGeomBoundable &boundable,
218  const UsdTimeCode &time,
219  const GfMatrix4d &transform,
220  VtVec3fArray *extent);
221 
222 };
223 
224 PXR_NAMESPACE_CLOSE_SCOPE
225 
226 #endif
USDGEOM_API UsdAttribute CreateExtentAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetExtentAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
static USDGEOM_API UsdGeomBoundable Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdGeomBoundable holding the prim adhering to this schema at path on stage.
Stores a 4x4 matrix of double elements.
Definition: matrix4d.h:88
UsdGeomBoundable(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomBoundable on UsdPrim prim .
Definition: boundable.h:94
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:85
Boundable introduces the ability for a prim to persistently cache a rectilinear, local-space, extent.
Definition: boundable.h:82
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:149
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:131
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
Represents a non-concrete typed schema.
static USDGEOM_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor cl...
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
virtual USDGEOM_API ~UsdGeomBoundable()
Destructor.
UsdGeomBoundable(const UsdSchemaBase &schemaObj)
Construct a UsdGeomBoundable on the prim held by schemaObj .
Definition: boundable.h:102
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
static USDGEOM_API bool ComputeExtentFromPlugins(const UsdGeomBoundable &boundable, const UsdTimeCode &time, VtVec3fArray *extent)
Compute the extent for the Boundable prim boundable at time time.
TfType represents a dynamic runtime type.
Definition: type.h:70
Singleton registry that provides access to prim and property definition information for registered Us...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: boundable.h:88
USDGEOM_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
The base class for all schema types in Usd.
Definition: schemaBase.h:56
Base class for all transformable prims, which allows arbitrary sequences of component affine transfor...
Definition: xformable.h:252
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182
USDGEOM_API UsdAttribute GetExtentAttr() const
Extent is a three dimensional range measuring the geometric extent of the authored gprim in its own l...