HDK
Main Page
Related Pages
Modules
Namespaces
Classes
Files
Examples
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Groups
Pages
dataSourceStageGlobals.h
Go to the documentation of this file.
1
//
2
// Copyright 2020 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 PXR_USD_IMAGING_USD_IMAGING_DATA_SOURCE_STAGE_GLOBALS_H
25
#define PXR_USD_IMAGING_USD_IMAGING_DATA_SOURCE_STAGE_GLOBALS_H
26
27
#include "
pxr/usd/usd/prim.h
"
28
#include "
pxr/usd/usd/timeCode.h
"
29
30
#include "
pxr/imaging/hd/dataSourceLocator.h
"
31
32
#include "
pxr/usd/sdf/path.h
"
33
34
PXR_NAMESPACE_OPEN_SCOPE
35
36
/// \class UsdImagingDataSourceStageGlobals
37
///
38
/// This class is used as a context object with global stage information,
39
/// that gets passed down to datasources to help them answer scene queries.
40
///
41
/// It's a pure virtual interface to allow for different use cases to override
42
/// certain behaviors (like getting the time coordinate, or whether we support
43
/// time-varying tracking).
44
///
45
class
UsdImagingDataSourceStageGlobals
46
{
47
public
:
48
virtual
~UsdImagingDataSourceStageGlobals
();
49
50
// Datasource API
51
52
/// Returns the current time represented in this instance.
53
virtual
UsdTimeCode
GetTime
()
const
= 0;
54
55
/// Flags the given \p primPath as time varying at the given locator.
56
virtual
void
FlagAsTimeVarying
(
57
const
SdfPath
&primPath,
58
const
HdDataSourceLocator
& locator)
const
= 0;
59
};
60
61
62
PXR_NAMESPACE_CLOSE_SCOPE
63
64
#endif // PXR_USD_IMAGING_USD_IMAGING_DATA_SOURCE_STAGE_GLOBALS_H
UsdImagingDataSourceStageGlobals::GetTime
virtual UsdTimeCode GetTime() const =0
Returns the current time represented in this instance.
dataSourceLocator.h
HdDataSourceLocator
Definition:
dataSourceLocator.h:44
UsdTimeCode
Definition:
timeCode.h:84
UsdImagingDataSourceStageGlobals
Definition:
dataSourceStageGlobals.h:45
prim.h
SdfPath
Definition:
path.h:291
path.h
PXR_NAMESPACE_OPEN_SCOPE
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition:
path.h:1441
UsdImagingDataSourceStageGlobals::~UsdImagingDataSourceStageGlobals
virtual ~UsdImagingDataSourceStageGlobals()
PXR_NAMESPACE_CLOSE_SCOPE
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition:
pxr.h:91
UsdImagingDataSourceStageGlobals::FlagAsTimeVarying
virtual void FlagAsTimeVarying(const SdfPath &primPath, const HdDataSourceLocator &locator) const =0
Flags the given primPath as time varying at the given locator.
timeCode.h
pxr
usdImaging
usdImaging
dataSourceStageGlobals.h
Generated on Thu Mar 28 2024 03:47:06 for HDK by
1.8.6