Loading...
Searching...
No Matches
visibilityAPI.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_VISIBILITYAPI_H
25#define USDGEOM_GENERATED_VISIBILITYAPI_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// VISIBILITYAPI //
51// -------------------------------------------------------------------------- //
52
94{
95public:
99 static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
100
105 explicit UsdGeomVisibilityAPI(const UsdPrim& prim=UsdPrim())
106 : UsdAPISchemaBase(prim)
107 {
108 }
109
113 explicit UsdGeomVisibilityAPI(const UsdSchemaBase& schemaObj)
114 : UsdAPISchemaBase(schemaObj)
115 {
116 }
117
119 USDGEOM_API
121
125 USDGEOM_API
126 static const TfTokenVector &
127 GetSchemaAttributeNames(bool includeInherited=true);
128
138 USDGEOM_API
140 Get(const UsdStagePtr &stage, const SdfPath &path);
141
142
159 USDGEOM_API
160 static bool
161 CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
162
178 USDGEOM_API
180 Apply(const UsdPrim &prim);
181
182protected:
186 USDGEOM_API
188
189private:
190 // needs to invoke _GetStaticTfType.
191 friend class UsdSchemaRegistry;
192 USDGEOM_API
193 static const TfType &_GetStaticTfType();
194
195 static bool _IsTypedSchema();
196
197 // override SchemaBase virtuals.
198 USDGEOM_API
199 const TfType &_GetTfType() const override;
200
201public:
202 // --------------------------------------------------------------------- //
203 // GUIDEVISIBILITY
204 // --------------------------------------------------------------------- //
231 USDGEOM_API
233
239 USDGEOM_API
240 UsdAttribute CreateGuideVisibilityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
241
242public:
243 // --------------------------------------------------------------------- //
244 // PROXYVISIBILITY
245 // --------------------------------------------------------------------- //
275 USDGEOM_API
277
283 USDGEOM_API
284 UsdAttribute CreateProxyVisibilityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
285
286public:
287 // --------------------------------------------------------------------- //
288 // RENDERVISIBILITY
289 // --------------------------------------------------------------------- //
320 USDGEOM_API
322
328 USDGEOM_API
329 UsdAttribute CreateRenderVisibilityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
330
331public:
332 // ===================================================================== //
333 // Feel free to add custom code below this line, it will be preserved by
334 // the code generator.
335 //
336 // Just remember to:
337 // - Close the class declaration with };
338 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
339 // - Close the include guard with #endif
340 // ===================================================================== //
341 // --(BEGIN CUSTOM CODE)--
342
356 USDGEOM_API
358};
359
360PXR_NAMESPACE_CLOSE_SCOPE
361
362#endif
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
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
TfType represents a dynamic runtime type.
Definition: type.h:65
The base class for all API schemas.
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
UsdGeomVisibilityAPI introduces properties that can be used to author visibility opinions.
Definition: visibilityAPI.h:94
USDGEOM_API UsdAttribute CreateGuideVisibilityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetGuideVisibilityAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
virtual USDGEOM_API ~UsdGeomVisibilityAPI()
Destructor.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: visibilityAPI.h:99
USDGEOM_API UsdAttribute GetGuideVisibilityAttr() const
This attribute controls visibility for geometry with purpose "guide".
static USDGEOM_API bool CanApply(const UsdPrim &prim, std::string *whyNot=nullptr)
Returns true if this single-apply API schema can be applied to the given prim.
static USDGEOM_API UsdGeomVisibilityAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdGeomVisibilityAPI holding the prim adhering to this schema at path on stage.
UsdGeomVisibilityAPI(const UsdSchemaBase &schemaObj)
Construct a UsdGeomVisibilityAPI on the prim held by schemaObj .
USDGEOM_API UsdAttribute CreateRenderVisibilityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRenderVisibilityAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
USDGEOM_API UsdAttribute GetProxyVisibilityAttr() const
This attribute controls visibility for geometry with purpose "proxy".
static USDGEOM_API UsdGeomVisibilityAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
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...
USDGEOM_API UsdAttribute CreateProxyVisibilityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetProxyVisibilityAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API UsdAttribute GetPurposeVisibilityAttr(const TfToken &purpose) const
Return the attribute that is used for expressing visibility opinions for the given purpose.
UsdGeomVisibilityAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomVisibilityAPI on UsdPrim prim .
USDGEOM_API UsdAttribute GetRenderVisibilityAttr() const
This attribute controls visibility for geometry with purpose "render".
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...
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