instancer.h

//
// Copyright 2016 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_IMAGING_HD_INSTANCER_H
#define PXR_IMAGING_HD_INSTANCER_H

#include "pxr/pxr.h"
#include "pxr/imaging/hd/api.h"
#include "pxr/imaging/hd/version.h"
#include "pxr/imaging/hd/types.h"

#include "pxr/usd/sdf/path.h"

#include <mutex>

PXR_NAMESPACE_OPEN_SCOPE

class HdSceneDelegate;
class HdRenderIndex;
class HdRprim;
class HdRenderParam;


class HdInstancer {
public:
    HD_API
    HdInstancer(HdSceneDelegate* delegate, SdfPath const& id);

    HD_API
    virtual ~HdInstancer();

    SdfPath const& GetId() const { return _id; }

    SdfPath const& GetParentId() const { return _parentId; }

    HdSceneDelegate* GetDelegate() const { return _delegate; }

    HD_API
    static int GetInstancerNumLevels(HdRenderIndex& index,
                                     HdRprim const& rprim);

    HD_API
    static TfTokenVector const & GetBuiltinPrimvarNames();

    HD_API
    virtual void Sync(HdSceneDelegate *sceneDelegate,
                      HdRenderParam   *renderParam,
                      HdDirtyBits     *dirtyBits);

    HD_API
    virtual void Finalize(HdRenderParam *renderParam);

    HD_API
    virtual HdDirtyBits GetInitialDirtyBitsMask() const;

    HD_API
    static void _SyncInstancerAndParents(
        HdRenderIndex &renderIndex,
        SdfPath const& instancerId);

protected:
    HD_API
    void _UpdateInstancer(HdSceneDelegate *delegate,
                          HdDirtyBits *dirtyBits);

private:
    HdSceneDelegate* _delegate;
    SdfPath _id;
    SdfPath _parentId;

    // XXX: This mutex exists for _SyncInstancerAndParents, which will go
    // away when the render index calls sync on instancers.
    std::mutex _instanceLock;
};


PXR_NAMESPACE_CLOSE_SCOPE

#endif  // PXR_IMAGING_HD_INSTANCER_H