HUSD_GeoSubset.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_GeoSubset__
#define __HUSD_GeoSubset__

#include "HUSD_API.h"
#include "HUSD_DataHandle.h"
class HUSD_TimeCode;


class HUSD_API HUSD_GeoSubset
{
public:
    /// Standard constructor.
                HUSD_GeoSubset(HUSD_AutoWriteLock &lock);

    /// Creates geometry subset in a given primitive.
    bool        createGeoSubset( const UT_StringRef &prim_path,
                        const UT_ExintArray &face_indices,
                        const UT_StringRef &subset_name ) const;


    /// @{ Get and set the geometry subset family name. 
    /// The subsets that have the same family name are logically tied
    /// together, and can be validated for overlaps, partitioning, etc.
    void                    setFamilyName( const UT_StringRef &name )
                            { myFamilyName = name; }
    const UT_StringHolder & getFamilyName() const
                            { return myFamilyName; }
    /// @} 

    /// Enumerates the possible values for geo subset family type
    enum class FamilyType
    {
        UNRESTRICTED,       // each face can belong to zero or more subsets
        NONOVERLAPPING,     // each face belongs to at most one subset
        PARTITION,          // each face belongs to exactly one subset
    };
    void                    setFamilyType( FamilyType type )
                            { myFamilyType = type; }
    FamilyType              getFamilyType() const
                            { return myFamilyType; }
                    

    /// Returns true if the @p subset_prim_path refers to a geometry subset,
    /// and if so also returns the geometry parent path and face idices. 
    /// Otherwise, returns false.
    bool            getGeoPrimitiveAndFaceIndices( 
                                UT_StringHolder &geo_prim_path,
                                UT_ExintArray &face_indices,
                                const UT_StringRef &subset_prim_path,
                                const HUSD_TimeCode &time_code ) const;

private:
    HUSD_AutoWriteLock &        myWriteLock;
    UT_StringHolder             myFamilyName;
    FamilyType                  myFamilyType;
};

#endif