Loading...
Searching...
No Matches
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"
32#include "pxr/usd/usd/prim.h"
33#include "pxr/usd/usd/stage.h"
35
36#include "pxr/base/vt/value.h"
37
38#include "pxr/base/gf/vec3d.h"
39#include "pxr/base/gf/vec3f.h"
41
42#include "pxr/base/tf/token.h"
43#include "pxr/base/tf/type.h"
44
45PXR_NAMESPACE_OPEN_SCOPE
46
47class SdfAssetPath;
48
49// -------------------------------------------------------------------------- //
50// BOUNDABLE //
51// -------------------------------------------------------------------------- //
52
83{
84public:
88 static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped;
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
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
132protected:
136 USDGEOM_API
138
139private:
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
151public:
152 // --------------------------------------------------------------------- //
153 // EXTENT
154 // --------------------------------------------------------------------- //
177 USDGEOM_API
179
185 USDGEOM_API
186 UsdAttribute CreateExtentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
187
188public:
189 // ===================================================================== //
190 // Feel free to add custom code below this line, it will be preserved by
191 // the code generator.
192 //
193 // Just remember to:
194 // - Close the class declaration with };
195 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
196 // - Close the include guard with #endif
197 // ===================================================================== //
198 // --(BEGIN CUSTOM CODE)--
199
208 USDGEOM_API
209 bool ComputeExtent(const UsdTimeCode &time, VtVec3fArray *extent) const;
210
226 USDGEOM_API
227 static bool ComputeExtentFromPlugins(const UsdGeomBoundable &boundable,
228 const UsdTimeCode &time,
229 VtVec3fArray *extent);
230
233 USDGEOM_API
234 static bool ComputeExtentFromPlugins(const UsdGeomBoundable &boundable,
235 const UsdTimeCode &time,
236 const GfMatrix4d &transform,
237 VtVec3fArray *extent);
238
239};
240
241PXR_NAMESPACE_CLOSE_SCOPE
242
243#endif
Stores a 4x4 matrix of double elements.
Definition: matrix4d.h:88
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
TfType represents a dynamic runtime type.
Definition: type.h:65
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
Boundable introduces the ability for a prim to persistently cache a rectilinear, local-space,...
Definition: boundable.h:83
USDGEOM_API bool ComputeExtent(const UsdTimeCode &time, VtVec3fArray *extent) const
If an extent is authored on this boundable, it queries the extent from the extent attribute,...
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.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: boundable.h:88
static USDGEOM_API bool ComputeExtentFromPlugins(const UsdGeomBoundable &boundable, const UsdTimeCode &time, VtVec3fArray *extent)
Compute the extent for the Boundable prim boundable at time time.
USDGEOM_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
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...
static USDGEOM_API bool ComputeExtentFromPlugins(const UsdGeomBoundable &boundable, const UsdTimeCode &time, const GfMatrix4d &transform, VtVec3fArray *extent)
This is an overloaded member function, provided for convenience. It differs from the above function o...
UsdGeomBoundable(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomBoundable on UsdPrim prim .
Definition: boundable.h:94
USDGEOM_API UsdAttribute GetExtentAttr() const
Extent is a three dimensional range measuring the geometric extent of the authored gprim in its own l...
UsdGeomBoundable(const UsdSchemaBase &schemaObj)
Construct a UsdGeomBoundable on the prim held by schemaObj .
Definition: boundable.h:102
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.
virtual USDGEOM_API ~UsdGeomBoundable()
Destructor.
Base class for all transformable prims, which allows arbitrary sequences of component affine transfor...
Definition: xformable.h:253
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
The base class for all schema types in Usd.
Definition: schemaBase.h:56
Singleton registry that provides access to schema type information and the prim definitions for regis...
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:84
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:164
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:129
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:457