LOP_SelectionRule.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        LOP Library (C++)
 *
 * COMMENTS:    Flat list of primitive paths, or rule-based description of a
 *              collection of USD primitives.
 *
 */

#ifndef __LOP_SelectionRule_h__
#define __LOP_SelectionRule_h__

#include "LOP_API.h"
#include <HUSD/HUSD_DataHandle.h>
#include <HUSD/HUSD_Utils.h>
#include <UT/UT_StringHolder.h>
#include <UT/UT_StringArray.h>
#include <UT/UT_StringMap.h>
#include <UT/UT_Error.h>

class UT_JSONWriter;
class UT_JSONParser;
class HUSD_PathSet;
class HUSD_TimeCode;

class LOP_API LOP_SelectionRule
{
public:
                         LOP_SelectionRule();
                        ~LOP_SelectionRule();

    bool                 operator==(const LOP_SelectionRule &other) const;
    bool                 operator!=(const LOP_SelectionRule &other) const;
    int                  hash() const;

    void                 save(UT_JSONWriter &writer) const;
    bool                 load(UT_JSONParser &parser);

    void                 getExpandedPathSet(HUSD_AutoAnyLock &lock,
                                int nodeid,
                                const HUSD_TimeCode &timecode,
                                HUSD_PathSet &paths,
                                bool *may_be_time_varying = nullptr,
                                HUSD_PathSet *missing_explicit_paths = nullptr,
                                UT_ErrorSeverity *error_severity = nullptr,
                                UT_StringHolder *error = nullptr) const;
    void                 getCollectionAwarePathSet(HUSD_AutoAnyLock &lock,
                                int nodeid,
                                const HUSD_TimeCode &timecode,
                                HUSD_PathSet &paths,
                                bool *may_be_time_varying = nullptr,
                                HUSD_PathSet *missing_explicit_paths = nullptr,
                                UT_ErrorSeverity *error_severity = nullptr,
                                UT_StringHolder *error = nullptr) const;
    bool                 copyToFindPrims(HUSD_FindPrims &findprims,
                                int nodeid,
                                const HUSD_TimeCode &timecode,
                                UT_ErrorSeverity *error_severity = nullptr,
                                UT_StringHolder *error = nullptr) const;

    const UT_StringHolder &getPathPattern() const
                         { return myPathPattern; }
    void                 setPathPattern(const UT_StringHolder &pattern)
                         { myPathPattern = pattern; }

    HUSD_PrimTraversalDemands traversalDemands() const
                         { return myTraversalDemands; }
    void                 setTraversalDemands(HUSD_PrimTraversalDemands demands)
                         { myTraversalDemands = demands; }

    const UT_StringHolder &icon() const
                         { return myIcon; }
    void                 setIcon(const UT_StringHolder &icon)
                         { myIcon = icon; }

    bool                 assumeWildcardsAroundPlainTokens() const
                         { return myAssumeWildcardsAroundPlainTokens; }
    void                 setAssumeWildcardsAroundPlainTokens(bool assume)
                         { myAssumeWildcardsAroundPlainTokens = assume; }

    bool                 caseSensitive() const
                         { return myCaseSensitive; }
    void                 setCaseSensitive(bool casesensitive)
                         { myCaseSensitive = casesensitive; }

private:
    UT_StringHolder              myPathPattern;
    HUSD_PrimTraversalDemands    myTraversalDemands;
    UT_StringHolder              myIcon;
    bool                         myAssumeWildcardsAroundPlainTokens;
    bool                         myCaseSensitive;
};

typedef UT_StringMap<LOP_SelectionRule> LOP_SelectionRuleMap;

#endif