HUSD_FindProps.h

Go to the documentation of this file.

/*
 * Copyright 2019 Side Effects Software Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

#ifndef __HUSD_FindProps_h__
#define __HUSD_FindProps_h__

#include "HUSD_API.h"
#include "HUSD_DataHandle.h"
#include "HUSD_FindPrims.h"
#include "HUSD_PathSet.h"
#include "HUSD_Utils.h"
#include <UT/UT_StringHolder.h>
#include <UT/UT_UniquePtr.h>
#include <pxr/pxr.h>

class HUSD_API HUSD_FindProps
{
public:
                                 HUSD_FindProps(HUSD_AutoAnyLock &lock,
                                         HUSD_PrimTraversalDemands demands =
                                            HUSD_TRAVERSAL_DEFAULT_DEMANDS);
                                 // Simple constructor when you just want to
                                 // operate on a single property.
                                 HUSD_FindProps(HUSD_AutoAnyLock &lock,
                                         const UT_StringRef &primpath,
                                         const UT_StringRef &propname,
                                         HUSD_PrimTraversalDemands demands =
                                            HUSD_TRAVERSAL_DEFAULT_DEMANDS);
                                ~HUSD_FindProps();

    const HUSD_FindPrims        &findPrims() const
                                 { return myFindPrims; }
    HUSD_FindPrims              &findPrims()
                                 { return myFindPrims; }

    const UT_StringHolder       &propertyPattern() const
                                 { return myPropertyPattern; }
    void                         setPropertyPattern(
                                        const UT_StringHolder &pattern);

    const HUSD_PathSet          &getExpandedPathSet() const;

private:
    class husd_FindPropsPrivate;

    UT_UniquePtr<husd_FindPropsPrivate>  myPrivate;
    HUSD_AutoAnyLock                    &myAnyLock;
    HUSD_FindPrims                       myFindPrims;
    UT_StringHolder                      myPropertyPattern;
};

#endif