shapeAdapter.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_SHAPE_ADAPTER_H
#define PXRUSDMAYAGL_SHAPE_ADAPTER_H


#include "pxr/pxr.h"

#include "pxrUsdMayaGL/api.h"
#include "pxrUsdMayaGL/renderParams.h"
#include "pxrUsdMayaGL/userData.h"

#include "pxr/base/gf/matrix4d.h"
#include "pxr/base/tf/token.h"
#include "pxr/imaging/hd/repr.h"
#include "pxr/imaging/hd/rprimCollection.h"
#include "pxr/usd/sdf/path.h"

// XXX: On Linux, some Maya headers (notably M3dView.h) end up indirectly
//      including X11/Xlib.h, which #define's "Bool" as int. This can cause
//      compilation issues if sdf/types.h is included afterwards, so to fix
//      this, we ensure that it gets included first.
#include "pxr/usd/sdf/types.h"

#include <maya/M3dView.h>
#include <maya/MBoundingBox.h>
#include <maya/MColor.h>
#include <maya/MDagPath.h>
#include <maya/MDrawRequest.h>
#include <maya/MHWGeometryUtilities.h>
#include <maya/MPxSurfaceShapeUI.h>
#include <maya/MUserData.h>

#include <memory>


PXR_NAMESPACE_OPEN_SCOPE


class PxrMayaHdShapeAdapter
{
    public:

        PXRUSDMAYAGL_API
        virtual bool Sync(
                const MDagPath& shapeDagPath,
                const M3dView::DisplayStyle legacyDisplayStyle,
                const M3dView::DisplayStatus legacyDisplayStatus);

        PXRUSDMAYAGL_API
        virtual bool Sync(
                const MDagPath& shapeDagPath,
                const unsigned int displayStyle,
                const MHWRender::DisplayStatus displayStatus);

        PXRUSDMAYAGL_API
        virtual bool UpdateVisibility(const M3dView* view = nullptr);

        PXRUSDMAYAGL_API
        virtual bool IsVisible() const;

        PXRUSDMAYAGL_API
        virtual void GetMayaUserData(
                MPxSurfaceShapeUI* shapeUI,
                MDrawRequest& drawRequest,
                const MBoundingBox* boundingBox = nullptr);

        PXRUSDMAYAGL_API
        virtual PxrMayaHdUserData* GetMayaUserData(
                MUserData* oldData,
                const MBoundingBox* boundingBox = nullptr);

        PXRUSDMAYAGL_API
        virtual HdReprSelector GetReprSelectorForDisplayState(
                const unsigned int displayStyle,
                const MHWRender::DisplayStatus displayStatus) const;

        PXRUSDMAYAGL_API
        virtual PxrMayaHdRenderParams GetRenderParams(
                bool* drawShape,
                bool* drawBoundingBox) const;

        PXRUSDMAYAGL_API
        virtual const HdRprimCollection& GetRprimCollection() const;

        PXRUSDMAYAGL_API
        virtual const TfTokenVector& GetRenderTags() const;


        PXRUSDMAYAGL_API
        virtual const GfMatrix4d& GetRootXform() const;

        PXRUSDMAYAGL_API
        virtual void SetRootXform(const GfMatrix4d& transform);

        PXRUSDMAYAGL_API
        virtual const SdfPath& GetDelegateID() const;

        PXRUSDMAYAGL_API
        virtual const MDagPath& GetDagPath() const;

        PXRUSDMAYAGL_API
        virtual bool IsViewport2() const;

    protected:

        PXRUSDMAYAGL_API
        virtual bool _Sync(
                const MDagPath& shapeDagPath,
                const unsigned int displayStyle,
                const MHWRender::DisplayStatus displayStatus) = 0;

        PXRUSDMAYAGL_API
        virtual TfToken _GetRprimCollectionName() const;

        static bool _GetWireframeColor(
                const unsigned int displayStyle,
                const MHWRender::DisplayStatus displayStatus,
                const MDagPath& shapeDagPath,
                MColor* mayaWireColor);

        static bool _GetVisibility(
                const MDagPath& dagPath,
                const M3dView* view,
                bool* visibility);

        PXRUSDMAYAGL_API
        PxrMayaHdShapeAdapter();

        PXRUSDMAYAGL_API
        virtual ~PxrMayaHdShapeAdapter();

        MDagPath _shapeDagPath;

        PxrMayaHdRenderParams _renderParams;
        bool _drawShape;
        bool _drawBoundingBox;

        HdRprimCollection _rprimCollection;
        TfTokenVector     _renderTags;

        GfMatrix4d _rootXform;

        bool _isViewport2;
};


PXR_NAMESPACE_CLOSE_SCOPE


#endif