dataSourcePrim.h

//
// Copyright 2020 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PXR_USD_IMAGING_USD_IMAGING_DATA_SOURCE_PRIM_H
#define PXR_USD_IMAGING_USD_IMAGING_DATA_SOURCE_PRIM_H
 
#include "pxr/imaging/hd/dataSource.h"
#include "pxr/imaging/hd/dataSourceTypeDefs.h"
 
#include "pxr/usd/usd/prim.h"
 
#include "pxr/usd/usdGeom/xformable.h"
#include "pxr/usd/usdGeom/boundable.h"
 
#include "pxr/usdImaging/usdImaging/api.h"
#include "pxr/usdImaging/usdImaging/dataSourceStageGlobals.h"
#include "pxr/usdImaging/usdImaging/dataSourcePrimvars.h"
#include "pxr/usdImaging/usdImaging/types.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class UsdImagingDataSourceVisibility : public HdContainerDataSource
{
public:
    HD_DECLARE_DATASOURCE(UsdImagingDataSourceVisibility);
 
    TfTokenVector GetNames() override;
 
    HdDataSourceBaseHandle Get(const TfToken &name) override;
 
private:
    UsdImagingDataSourceVisibility(
            const UsdAttributeQuery &visibilityQuery,
            const SdfPath &sceneIndexPath,
            const UsdImagingDataSourceStageGlobals &stageGlobals);
 
private:
    UsdAttributeQuery _visibilityQuery;
    const UsdImagingDataSourceStageGlobals &_stageGlobals;
};
 
HD_DECLARE_DATASOURCE_HANDLES(UsdImagingDataSourceVisibility);
 
 
// ----------------------------------------------------------------------------
 
class UsdImagingDataSourcePurpose : public HdContainerDataSource
{
public:
    HD_DECLARE_DATASOURCE(UsdImagingDataSourcePurpose);
 
    TfTokenVector GetNames() override;
 
    HdDataSourceBaseHandle Get(const TfToken &name) override;
 
private:
    UsdImagingDataSourcePurpose(
            const UsdAttributeQuery &purposeQuery,
            const UsdImagingDataSourceStageGlobals &stageGlobals);
 
private:
    UsdAttributeQuery _purposeQuery;
    const UsdImagingDataSourceStageGlobals &_stageGlobals;
};
 
HD_DECLARE_DATASOURCE_HANDLES(UsdImagingDataSourcePurpose);
 
 
// ----------------------------------------------------------------------------
 
class UsdImagingDataSourceExtentCoordinate : public HdVec3dDataSource
{
public:
    HD_DECLARE_DATASOURCE(UsdImagingDataSourceExtentCoordinate);
 
    VtValue GetValue(HdSampledDataSource::Time shutterOffset) override;
 
    GfVec3d GetTypedValue(HdSampledDataSource::Time shutterOffset) override;
 
    bool GetContributingSampleTimesForInterval(
            HdSampledDataSource::Time startTime,
            HdSampledDataSource::Time endTime,
            std::vector<HdSampledDataSource::Time> *outSampleTimes) override;
 
private:
    UsdImagingDataSourceExtentCoordinate(
            const HdVec3fArrayDataSourceHandle &extentDs,
            const SdfPath &attrPath,
            unsigned int index);
 
private:
    HdVec3fArrayDataSourceHandle _extentDs;
    SdfPath _attrPath;
    unsigned int _index;
};
 
// ----------------------------------------------------------------------------
 
class UsdImagingDataSourceExtent : public HdContainerDataSource
{
public:
    HD_DECLARE_DATASOURCE(UsdImagingDataSourceExtent);
 
    TfTokenVector GetNames() override;
 
    HdDataSourceBaseHandle Get(const TfToken &name) override;
 
private:
    UsdImagingDataSourceExtent(
            const UsdAttributeQuery &extentQuery,
            const SdfPath &sceneIndexPath,
            const UsdImagingDataSourceStageGlobals &stageGlobals);
 
private:
    // Note: the constructor takes sceneIndexPath for change-tracking,
    // but here we're storing the USD attribute path for error reporting!
    SdfPath _attrPath;
    HdVec3fArrayDataSourceHandle _extentDs;
};
 
HD_DECLARE_DATASOURCE_HANDLES(UsdImagingDataSourceExtent);
 
// ----------------------------------------------------------------------------
 
class UsdImagingDataSourceExtentsHint : public HdContainerDataSource
{
public:
    HD_DECLARE_DATASOURCE(UsdImagingDataSourceExtentsHint);
 
    TfTokenVector GetNames() override;
 
    HdDataSourceBaseHandle Get(const TfToken &name) override;
 
private:
    UsdImagingDataSourceExtentsHint(
            const UsdAttributeQuery &extentQuery,
            const SdfPath &sceneIndexPath,
            const UsdImagingDataSourceStageGlobals &stageGlobals);
 
private:
    // Note: the constructor takes sceneIndexPath for change-tracking,
    // but here we're storing the USD attribute path for error reporting!
    SdfPath _attrPath;
    HdVec3fArrayDataSourceHandle _extentDs;
};
 
HD_DECLARE_DATASOURCE_HANDLES(UsdImagingDataSourceExtent);
 
// ----------------------------------------------------------------------------
 
class UsdImagingDataSourceXformResetXformStack : public HdBoolDataSource
{
public:
    HD_DECLARE_DATASOURCE(UsdImagingDataSourceXformResetXformStack);
 
    VtValue GetValue(HdSampledDataSource::Time shutterOffset) override;
 
    bool GetTypedValue(HdSampledDataSource::Time shutterOffset) override;
 
    bool GetContributingSampleTimesForInterval(
            HdSampledDataSource::Time startTime,
            HdSampledDataSource::Time endTime,
            std::vector<HdSampledDataSource::Time> *outSampleTimes) override {
        return false;
    }
 
private:
    UsdImagingDataSourceXformResetXformStack(
            const UsdGeomXformable::XformQuery &xformQuery,
            const UsdImagingDataSourceStageGlobals &stageGlobals);
 
private:
    UsdGeomXformable::XformQuery _xformQuery;
    const UsdImagingDataSourceStageGlobals &_stageGlobals;
};
 
HD_DECLARE_DATASOURCE_HANDLES(UsdImagingDataSourceXformResetXformStack);
 
// ----------------------------------------------------------------------------
 
class UsdImagingDataSourceXformMatrix : public HdMatrixDataSource
{
public:
 
    HD_DECLARE_DATASOURCE(UsdImagingDataSourceXformMatrix);
 
    VtValue GetValue(HdSampledDataSource::Time shutterOffset) override;
 
    GfMatrix4d GetTypedValue(HdSampledDataSource::Time shutterOffset) override;
 
    bool GetContributingSampleTimesForInterval(
            HdSampledDataSource::Time startTime,
            HdSampledDataSource::Time endTime,
            std::vector<HdSampledDataSource::Time> *outSampleTimes) override;
 
private:
    UsdImagingDataSourceXformMatrix(
            const UsdGeomXformable::XformQuery &xformQuery,
            const UsdImagingDataSourceStageGlobals &stageGlobals);
 
private:
    UsdGeomXformable::XformQuery _xformQuery;
    const UsdImagingDataSourceStageGlobals &_stageGlobals;
};
 
HD_DECLARE_DATASOURCE_HANDLES(UsdImagingDataSourceXformMatrix);
 
// ----------------------------------------------------------------------------
 
class UsdImagingDataSourceXform : public HdContainerDataSource
{
public:
    HD_DECLARE_DATASOURCE(UsdImagingDataSourceXform);
 
    TfTokenVector GetNames() override;
 
    HdDataSourceBaseHandle Get(const TfToken &name) override;
 
private:
    UsdImagingDataSourceXform(
            const UsdGeomXformable::XformQuery &xformQuery,
            const SdfPath &sceneIndexPath,
            const UsdImagingDataSourceStageGlobals &stageGlobals);
 
private:
    UsdGeomXformable::XformQuery _xformQuery;
    const UsdImagingDataSourceStageGlobals &_stageGlobals;
};
 
HD_DECLARE_DATASOURCE_HANDLES(UsdImagingDataSourceXform);
 
// ----------------------------------------------------------------------------
 
class UsdImagingDataSourcePrimOrigin : public HdContainerDataSource
{
public:
    HD_DECLARE_DATASOURCE(UsdImagingDataSourcePrimOrigin);
 
    TfTokenVector GetNames() override;
 
    HdDataSourceBaseHandle Get(const TfToken &name) override;
 
private:
    UsdImagingDataSourcePrimOrigin(const UsdPrim &usdPrim);
 
private:
    UsdPrim _usdPrim;
};
 
HD_DECLARE_DATASOURCE_HANDLES(UsdImagingDataSourcePrimOrigin);
 
// ----------------------------------------------------------------------------
 
class UsdImagingDataSourcePrim : public HdContainerDataSource
{
public:
    HD_DECLARE_DATASOURCE(UsdImagingDataSourcePrim);
 
    USDIMAGING_API
    TfTokenVector GetNames() override;
 
    USDIMAGING_API
    HdDataSourceBaseHandle Get(const TfToken &name) override;
 
    USDIMAGING_API
    static HdDataSourceLocatorSet Invalidate(
            UsdPrim const& prim,
            const TfToken &subprim,
            const TfTokenVector &properties,
            UsdImagingPropertyInvalidationType invalidationType);
 
protected:
    USDIMAGING_API
    UsdImagingDataSourcePrim(
            const SdfPath &sceneIndexPath,
            UsdPrim usdPrim,
            const UsdImagingDataSourceStageGlobals &stageGlobals);
 
    // Accessors, for derived classes...
    const SdfPath &_GetSceneIndexPath() const {
        return _sceneIndexPath;
    }
 
    const UsdPrim &_GetUsdPrim() const {
        return _usdPrim;
    }
 
    const UsdImagingDataSourceStageGlobals &_GetStageGlobals() const {
        return _stageGlobals;
    }
 
private:
    const SdfPath _sceneIndexPath;
    UsdPrim _usdPrim;
    const UsdImagingDataSourceStageGlobals &_stageGlobals;
};
 
HD_DECLARE_DATASOURCE_HANDLES(UsdImagingDataSourcePrim);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_IMAGING_USD_IMAGING_DATA_SOURCE_PRIM_H