HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
tokens.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 USDMEDIA_TOKENS_H
25 #define USDMEDIA_TOKENS_H
26 
27 /// \file usdMedia/tokens.h
28 
29 // XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
30 //
31 // This is an automatically generated file (by usdGenSchema.py).
32 // Do not hand-edit!
33 //
34 // XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
35 
36 #include "pxr/pxr.h"
37 #include "pxr/usd/usdMedia/api.h"
38 #include "pxr/base/tf/staticData.h"
39 #include "pxr/base/tf/token.h"
40 #include <vector>
41 
43 
44 
45 /// \class UsdMediaTokensType
46 ///
47 /// \link UsdMediaTokens \endlink provides static, efficient
48 /// \link TfToken TfTokens\endlink for use in all public USD API.
49 ///
50 /// These tokens are auto-generated from the module's schema, representing
51 /// property names, for when you need to fetch an attribute or relationship
52 /// directly by name, e.g. UsdPrim::GetAttribute(), in the most efficient
53 /// manner, and allow the compiler to verify that you spelled the name
54 /// correctly.
55 ///
56 /// UsdMediaTokens also contains all of the \em allowedTokens values
57 /// declared for schema builtin attributes of 'token' scene description type.
58 /// Use UsdMediaTokens like so:
59 ///
60 /// \code
61 /// gprim.GetMyTokenValuedAttr().Set(UsdMediaTokens->auralMode);
62 /// \endcode
65  /// \brief "auralMode"
66  ///
67  /// UsdMediaSpatialAudio
69  /// \brief "endTime"
70  ///
71  /// UsdMediaSpatialAudio
73  /// \brief "filePath"
74  ///
75  /// UsdMediaSpatialAudio
77  /// \brief "gain"
78  ///
79  /// UsdMediaSpatialAudio
80  const TfToken gain;
81  /// \brief "loopFromStage"
82  ///
83  /// Possible value for UsdMediaSpatialAudio::GetPlaybackModeAttr()
85  /// \brief "loopFromStart"
86  ///
87  /// Possible value for UsdMediaSpatialAudio::GetPlaybackModeAttr()
89  /// \brief "loopFromStartToEnd"
90  ///
91  /// Possible value for UsdMediaSpatialAudio::GetPlaybackModeAttr()
93  /// \brief "mediaOffset"
94  ///
95  /// UsdMediaSpatialAudio
97  /// \brief "nonSpatial"
98  ///
99  /// Possible value for UsdMediaSpatialAudio::GetAuralModeAttr()
101  /// \brief "onceFromStart"
102  ///
103  /// Possible value for UsdMediaSpatialAudio::GetPlaybackModeAttr(), Default value for UsdMediaSpatialAudio::GetPlaybackModeAttr()
105  /// \brief "onceFromStartToEnd"
106  ///
107  /// Possible value for UsdMediaSpatialAudio::GetPlaybackModeAttr()
109  /// \brief "playbackMode"
110  ///
111  /// UsdMediaSpatialAudio
113  /// \brief "spatial"
114  ///
115  /// Possible value for UsdMediaSpatialAudio::GetAuralModeAttr(), Default value for UsdMediaSpatialAudio::GetAuralModeAttr()
117  /// \brief "startTime"
118  ///
119  /// UsdMediaSpatialAudio
121  /// A vector of all of the tokens listed above.
122  const std::vector<TfToken> allTokens;
123 };
124 
125 /// \var UsdMediaTokens
126 ///
127 /// A global variable with static, efficient \link TfToken TfTokens\endlink
128 /// for use in all public USD API. \sa UsdMediaTokensType
130 
132 
133 #endif
const TfToken mediaOffset
"mediaOffset"
Definition: tokens.h:96
const TfToken loopFromStartToEnd
"loopFromStartToEnd"
Definition: tokens.h:92
USDMEDIA_API UsdMediaTokensType()
const TfToken startTime
"startTime"
Definition: tokens.h:120
USDMEDIA_API TfStaticData< UsdMediaTokensType > UsdMediaTokens
const TfToken endTime
"endTime"
Definition: tokens.h:72
Definition: token.h:87
const TfToken playbackMode
"playbackMode"
Definition: tokens.h:112
const TfToken loopFromStart
"loopFromStart"
Definition: tokens.h:88
const TfToken auralMode
"auralMode"
Definition: tokens.h:68
#define USDMEDIA_API
Definition: api.h:40
const std::vector< TfToken > allTokens
A vector of all of the tokens listed above.
Definition: tokens.h:122
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
const TfToken filePath
"filePath"
Definition: tokens.h:76
const TfToken nonSpatial
"nonSpatial"
Definition: tokens.h:100
const TfToken loopFromStage
"loopFromStage"
Definition: tokens.h:84
const TfToken spatial
"spatial"
Definition: tokens.h:116
const TfToken onceFromStartToEnd
"onceFromStartToEnd"
Definition: tokens.h:108
const TfToken onceFromStart
"onceFromStart"
Definition: tokens.h:104
const TfToken gain
"gain"
Definition: tokens.h:80