instancerImager.h

Go to the documentation of this file.

//
// Copyright 2018 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 PXRUSDMAYAGL_INSTANCER_IMAGER_H
#define PXRUSDMAYAGL_INSTANCER_IMAGER_H


#include "pxrUsdMayaGL/api.h"
#include "pxrUsdMayaGL/instancerShapeAdapter.h"

#include "pxr/base/tf/singleton.h"
#include "pxr/base/tf/weakBase.h"

#include "usdMaya/notice.h"
#include "usdMaya/util.h"

#include <maya/MCallbackIdArray.h>
#include <maya/MDagMessage.h>

PXR_NAMESPACE_OPEN_SCOPE

class UsdMayaGL_InstancerImager : public TfWeakBase {
public:
    static UsdMayaGL_InstancerImager& GetInstance();

    void SyncShapeAdapters(const unsigned int displayStyle);

    void SyncShapeAdapters(const M3dView::DisplayStyle legacyDisplayStyle);

    void RemoveShapeAdapters(bool vp2);

private:
    struct _InstancerEntry {
        MCallbackIdArray callbacks;

        // The shape adapter generates an in-memory USD stage, so don't create
        // the shape adapters until we need them. For example, we might never
        // need the legacy shape adapter if we only have VP2 viewports.
        std::unique_ptr<UsdMayaGL_InstancerShapeAdapter> adapterVp2;
        std::unique_ptr<UsdMayaGL_InstancerShapeAdapter> adapterLegacy;

        ~_InstancerEntry();
    };

    UsdMayaUtil::MObjectHandleUnorderedMap<_InstancerEntry> _instancers;

    UsdMayaUtil::MObjectHandleUnorderedSet _instancersToRemove;

    UsdMayaUtil::MObjectHandleUnorderedSet _dirtyInstancersVp2;
    UsdMayaUtil::MObjectHandleUnorderedSet _dirtyInstancersLegacy;

    UsdMayaUtil::MObjectHandleUnorderedSet _dirtyInstancerXformsVp2;
    UsdMayaUtil::MObjectHandleUnorderedSet _dirtyInstancerXformsLegacy;

    MObjectHandle _cachedHdImagingShape;


    static void _OnNodeDirty(
            MObject& node,
            void* clientData);

    static void _OnWorldMatrixChanged(
            MObject &transformNode,
            MDagMessage::MatrixModifiedFlags& modified,
            void *clientData);


    void _SyncShapeAdapters(
            bool vp2,
            const unsigned int vp2DisplayStyle,
            const M3dView::DisplayStyle legacyDisplayStyle);

    void _DirtyHdImagingShape(bool createIfNeeded);


    void _StartTrackingInstancer(const MObject& instancer);
    void _StopTrackingInstancer(const MObjectHandle& instancerHandle);


    void _OnSceneReset(
            const UsdMayaSceneResetNotice& notice);
    void _OnConnection(
            const UsdMayaAssemblyConnectedToInstancerNotice& notice);
    void _OnDisconnection(
            const UsdMayaAssemblyDisconnectedFromInstancerNotice& notice);


    UsdMayaGL_InstancerImager();
    ~UsdMayaGL_InstancerImager();

    friend class TfSingleton<UsdMayaGL_InstancerImager>;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif