HUSD_GetAttributes.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_GetAttributes_h__
#define __HUSD_GetAttributes_h__

#include "HUSD_API.h"
#include "HUSD_DataHandle.h"
#include "HUSD_TimeCode.h"
#include <UT/UT_StringHolder.h>

enum class HUSD_TimeSampling;


class HUSD_API HUSD_GetAttributes
{
public:
                         HUSD_GetAttributes(HUSD_AutoAnyLock &lock);
                        ~HUSD_GetAttributes();

    /// @{ Obtains attribute or primvar value.
    template<typename UtValueType>
    bool                 getAttribute(const UT_StringRef &primpath,
                                const UT_StringRef &attribname,
                                UtValueType &value,
                                const HUSD_TimeCode &timecode) const;

    template<typename UtValueType>
    bool                 getPrimvar(const UT_StringRef &primpath,
                                const UT_StringRef &primvarname,
                                UtValueType &value,
                                const HUSD_TimeCode &timecode,
                                bool allow_inheritance = false) const;

    template<typename UtValueType>
    bool                 getAttributeOrPrimvar(const UT_StringRef &primpath,
                                const UT_StringRef &name,
                                UtValueType &value,
                                const HUSD_TimeCode &timecode,
                                bool flatten_primvar = false) const;
    /// @}


    /// @{ Obtains attribute or primvar array value.
    // The following methods perform exactly the same thing as the aboves,
    // but accept the subclasses from the UT_Array. 
    template<typename UtValueType>
    bool                 getAttributeArray(const UT_StringRef &primpath,
                                const UT_StringRef &attribname,
                                UT_Array<UtValueType> &value,
                                const HUSD_TimeCode &timecode) const
    { return getAttribute(primpath, attribname, value, timecode); }

    template<typename UtValueType>
    bool                 getPrimvarArray(const UT_StringRef &primpath,
                                const UT_StringRef &primvarname,
                                UT_Array<UtValueType> &value,
                                const HUSD_TimeCode &timecode,
                                bool allow_inheritance = false) const
    { return getPrimvar(primpath, primvarname, value, timecode, 
            allow_inheritance); }

    template<typename UtValueType>
    bool                 getAttributeOrPrimvarArray(const UT_StringRef &primpath,
                                const UT_StringRef &name,
                                UT_Array<UtValueType> &value,
                                const HUSD_TimeCode &timecode,
                                bool flatten_primvar = false) const
    {
        return getAttributeOrPrimvar(
                primpath, name, value, timecode, flatten_primvar);
    }
    /// @}
    
    /// Obtains the size of an array attribute (0 if the attribute
    /// is not an array)
    bool                 getAttributeArraySize(const UT_StringRef &primpath,
                                const UT_StringRef &attribname,
                                size_t &arraylength,
                                const HUSD_TimeCode &timecode) const;

    /// Returns the interpolation style of an attribute.
    /// This is only valid for certain attributes, e.g. UsdGeomPoints 'widths'.
    UT_StringHolder      getAttributeInterpolation(const UT_StringRef &primpath,
                                const UT_StringRef &primvarname) const;

    /// Obtains array value of a flattened primvar.
    template<typename UtValueType>
    bool                 getFlattenedPrimvar(const UT_StringRef &primpath,
                                const UT_StringRef &primvarname,
                                UT_Array<UtValueType> &value,
                                const HUSD_TimeCode &timecode,
                                bool allow_inheritance = false) const;

    /// Returns true if the primvar is indexed.
    bool                 isPrimvarIndexed(const UT_StringRef &primpath,
                                const UT_StringRef &primvarname,
                                bool allow_inheritance = false) const;

    /// Returns the index array for indexed primvars.
    bool                 getPrimvarIndices(const UT_StringRef &primpath,
                                const UT_StringRef &primvarname, 
                                UT_ExintArray &indices,
                                const HUSD_TimeCode &timecode,
                                bool allow_inheritance = false) const;

    /// Returns the interpolation style of a primvar.
    UT_StringHolder      getPrimvarInterpolation(const UT_StringRef &primpath,
                                const UT_StringRef &primvarname,
                                bool allow_inheritance = false) const;

    /// Returns the element size of a primvar.
    exint                getPrimvarElementSize(const UT_StringRef &primpath,
                                const UT_StringRef &primvarname,
                                bool allow_inheritance = false) const;


    /// Returns true if any attribute we have fetched has many time samples.
    bool                 getIsTimeVarying() const;

    /// Returns the overal sampling of fethced attributes.
    HUSD_TimeSampling    getTimeSampling() const 
                         { return myTimeSampling; }

private:
    HUSD_AutoAnyLock            &myAnyLock;
    mutable HUSD_TimeSampling    myTimeSampling;
};
#endif