dataSourceRelationship.h
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_RELATIONSHIP_H
25 #define PXR_USD_IMAGING_USD_IMAGING_DATA_SOURCE_RELATIONSHIP_H
26 
27 #include "pxr/usd/usd/relationship.h"
28 #include "pxr/usdImaging/usdImaging/dataSourceStageGlobals.h"
29 #include "pxr/imaging/hd/dataSource.h"
30 #include "pxr/imaging/hd/dataSourceTypeDefs.h"
31 
32 PXR_NAMESPACE_OPEN_SCOPE
33 
39 {
40 public:
41  HD_DECLARE_DATASOURCE(UsdImagingDataSourceRelationship);
42 
45  VtValue GetValue(HdSampledDataSource::Time shutterOffset) override;
46 
50  HdSampledDataSource::Time shutterOffset) override;
51 
54  HdSampledDataSource::Time startTime,
55  HdSampledDataSource::Time endTime,
56  std::vector<HdSampledDataSource::Time> *outSampleTimes) override;
57 
58 private:
65  const UsdRelationship &usdRel,
66  const UsdImagingDataSourceStageGlobals &stageGlobals);
67 
68 private:
69  UsdRelationship _usdRel;
70  const UsdImagingDataSourceStageGlobals & _stageGlobals;
71 };
72 
73 HD_DECLARE_DATASOURCE_HANDLES(UsdImagingDataSourceRelationship);
74 
75 PXR_NAMESPACE_CLOSE_SCOPE
76 
77 #endif // PXR_USD_IMAGING_USD_IMAGING_DATA_SOURCE_RELATIONSHIP_H
This class is used as a context object with global stage information, that gets passed down to dataso...
VtArray< SdfPath > GetTypedValue(HdSampledDataSource::Time shutterOffset) override
Returns the extracted path array value of the attribute.
A data source that represents a USD relationship.
A datasource representing a concretely-typed sampled value.
Definition: dataSource.h:201
Represents an arbitrary dimensional rectangular container class.
Definition: array.h:228
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
Definition: relationship.h:128
bool GetContributingSampleTimesForInterval(HdSampledDataSource::Time startTime, HdSampledDataSource::Time endTime, std::vector< HdSampledDataSource::Time > *outSampleTimes) override
Returns false indicating USD relationhips cannot vary with time.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166
VtValue GetValue(HdSampledDataSource::Time shutterOffset) override
Returns the extracted path array value of the attribute, as a VtValue.