HUSD_Info.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_Info_h__
#define __HUSD_Info_h__

#include "HUSD_API.h"
#include "HUSD_DataHandle.h"
#include "HUSD_Utils.h"
#include <UT/UT_ArrayStringSet.h>
#include <UT/UT_StringMap.h>
#include <UT/UT_UniquePtr.h>
#include <UT/UT_VectorTypes.h>

class husd_InfoPrivate;
class HUSD_TimeCode;
class HUSD_Path;
enum class HUSD_XformType;
enum class HUSD_TimeSampling;
template <typename T> class UT_BoundingBoxT;
using UT_BoundingBoxD = UT_BoundingBoxT<fpreal64>;
class UT_InfoTree;
class UT_Options;
typedef UT_StringMap<UT_StringHolder> HUSD_CollectionInfoMap;

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

    static bool          isArrayValueType(const UT_StringRef &valueType);
    static bool          isTokenArrayValueType(const UT_StringRef &valueType);
    static bool          isPrimvarName(const UT_StringRef &name);
    static void          getPrimitiveKinds(UT_StringArray &kinds);
    static void          getUsdVersionInfo(UT_StringMap<UT_StringHolder> &info);

    // Get kind hierarchy information.
    static bool          isModelKind(const UT_StringRef &kind);
    static bool          isGroupKind(const UT_StringRef &kind);
    static bool          isComponentKind(const UT_StringRef &kind);

    // Test for paths that represent instance prototypes.
    static bool          isPathInPrototype(const HUSD_Path &primpath);

    // Get the global variant selection fallback settings from the USD library.
    static void          getGlobalVariantSelectionFallbacks(
                                UT_StringMap<UT_StringArray> &
                                    variantselections);

    // Test if a string is a stage variable expression, optionally setting
    // an error if the expression isn't valid.
    static bool          isStageVariableExpression(const UT_StringRef &expr,
                                bool check_for_errors = true);

    // Get basic information from the auto lock used to construct this
    // info object.
    bool                 isStageValid() const;
    bool                 getStageRootLayer(UT_StringHolder &identifier) const;
    static bool          isLopLayer(const UT_StringRef &identifier);
    static bool          getLayerSavePath(const UT_StringHolder &identifier,
                                const UT_StringMap<UT_StringHolder> &refargs,
                                UT_StringHolder &savepath);

    // Reload a layer. Does the USD reload and clears Houdini-specific caches
    // associated with loaded layers. Optionally finds all referenced layers
    // and also reloads them (recursively).
    static bool          reload(const UT_StringRef &filepath,
                                bool recursive,
                                bool force_load = false);
    // Reloads as above, but uses the asset resolver context from the auto lock
    // used to construct this info object.
    bool                 reloadWithContext(const UT_StringRef &filepath,
                                bool recursive,
                                bool force_load = false) const;
    // Clear the current stage from the GusdUSD_XformCache.
    void                 clearGusdXformCache() const;

    // Returns the identifiers and a human readable name for all sublayers of
    // the stage root layer in strongest to weakest order.
    bool                 getSourceLayers(UT_StringArray &names,
                                UT_StringArray &identifiers,
                                UT_IntArray &fromlops,
                                UT_IntArray &fromsops) const;
    bool                 getLayerHierarchy(UT_InfoTree &hierarchy) const;
    bool                 getLayerSavePath(UT_StringHolder &savepath) const;
    bool                 getLayersAboveLayerBreak(
                                UT_StringArray &identifiers) const;

    // Check if the layer specified by the file path can be found. Uses the
    // stage's resolver context if this object was created with a lock.
    bool                 getLayerExists(const UT_StringRef &filepath) const;

    // Layer information
    bool                 getStartTimeCode(fpreal64 &starttimecode) const;
    bool                 getEndTimeCode(fpreal64 &endtimecode) const;
    bool                 getFramesPerSecond(fpreal64 &fps) const;
    bool                 getTimeCodesPerSecond(fpreal64 &tcs) const;
    bool                 getMetrics(UT_StringHolder &upaxis,
                                fpreal64 &metersperunit) const;

    // Return the "current render settings" metadata from the stage. If it's
    // not set, return an empty string.
    UT_StringHolder      getCurrentRenderSettings() const;
    // Return the paths to all render settings prims on the stage.
    bool                 getAllRenderSettings(UT_StringArray &paths) const;
    // Return a render settings path using the following priorities:
    //    1. The provided explicit_path, if a prim exists there.
    //    2. The current settings prim according to the stage metadata.
    //    3. If there is exactly one settings prim on the stage, return it.
    //       If pick_first_of_many is true and there is more than one render
    //       settings prim, pick the first one.
    //    4. Return an empty path.
    HUSD_Path            getBestRenderSettings(
                                const UT_StringRef &explicit_path =
                                    UT_StringHolder::theEmptyString,
                                bool pick_first_of_many = false) const;
    // Return a camera path using the following priorities:
    //    1. The provided explicit_path, if a camera exists there.
    //    2. The camera according to the supplied render_settings prim
    //       (note that no smart fallback is used here if the prim is empty
    //        or doesn't point to a render settings prim - use the result of
    //        getBestRenderSettings if this is the intent).
    //    3. If there is exactly one camera prim on the stage, return it.
    //       If pick_first_of_many is true and there is more than one camera
    //       prim, pick the first one.
    //    4. Return an empty path.
    HUSD_Path            getBestCamera(
                                const UT_StringRef &explicit_path =
                                    UT_StringHolder::theEmptyString,
                                const UT_StringHolder &render_settings =
                                    UT_StringHolder::theEmptyString,
                                bool pick_first_of_many = false) const;

    // General primitive information (parent, children, kinds)
    bool                 isPrimAtPath(const UT_StringRef &primpath) const;
    bool                 isActive(const UT_StringRef &primpath) const;
    bool                 isVisible(const UT_StringRef &primpath,
                                const HUSD_TimeCode &time_code,
                                HUSD_TimeSampling *time_sampling=nullptr) const;
    bool                 isInstance(const UT_StringRef &primpath) const;
    UT_StringHolder      getKind(const UT_StringRef &primpath) const;
    bool                 isKind(const UT_StringRef &primpath, 
                                const UT_StringRef &kind) const;
    UT_StringHolder      getSpecifier(const UT_StringRef &primpath) const;
    bool                 isAbstract(const UT_StringRef &primpath) const;
    bool                 isModel(const UT_StringRef &primpath) const;
    UT_StringHolder      getPrimType(const UT_StringRef &primpath) const;
    bool                 isPrimType(const UT_StringRef &primpath, 
                                const UT_StringRef &type) const;
    bool                 hasPrimAPI(const UT_StringRef &primpath, 
                                const UT_StringRef &api) const;
    bool                 hasPayload(const UT_StringRef &primpath) const;
    UT_StringHolder      getIcon(const UT_StringRef &primpath) const;
    UT_StringHolder      getPurpose(const UT_StringRef &primpath) const;
    UT_StringHolder      getDrawMode(const UT_StringRef &primpath) const;

    // Tests the value of the "editable" attribute from the HoudiniEditableAPI
    // schema, used to indicate if a prim should be modified by LOPs.
    bool                 isEditable(const UT_StringRef &primpath) const;
    // Tests the value of the "selectable" attribute from the
    // HoudiniSelectableAPI schema, used to indicate if a prim is selectable.
    bool                 isSelectable(const UT_StringRef &primpath,
                                UT_Map<HUSD_Path, bool> *cache = nullptr) const;
    // Tests the value of the IsHidden metadata, used to indicate if a prim
    // should be shown in the scene graph tree.
    bool                 isHiddenInUi(const UT_StringRef &primpath) const;

    // Determines the primitive kind that should be used for the specified
    // primitive to maintain a valid model kind hierarchy.
    UT_StringHolder      getAutoParentPrimKind(
                                const UT_StringRef &primpath) const;

    // Get information about child primitives.
    bool                 hasChildren(const UT_StringRef &primpath) const;
    void                 getChildren(const UT_StringRef &primpath,
                                UT_StringArray &childnames) const;

    // Return a simple count of the number of descendant prims.
    exint                getDescendantCount(const UT_StringRef &primpath,
                                HUSD_PrimTraversalDemands demands) const;

    // Gather general statistics about the descendants of a primitive.
    enum DescendantStatsFlags {
        STATS_SIMPLE_COUNTS = 0x0000,
        STATS_PURPOSE_COUNTS = 0x0001,
        STATS_GEOMETRY_COUNTS = 0x0002
    };
    void                 getDescendantStats(const UT_StringRef &primpath,
                                UT_Options &stats,
                                DescendantStatsFlags
                                    flags = STATS_SIMPLE_COUNTS) const;

    // Searches up the scene graph tree starting from "primpath" looking for
    // the first prim with the specified kindhint. If none of that kind are
    // found, it will look for the least nested prim of the base kind. So
    // if kindhint is assembly, and there is no assembly, it will return
    // the least nested group. Then fall back to the least nested model.
    // Then finall fall back to returning the original primpath. This
    // method will never return an empty string. If kindhint is an empty
    // string, the original primpath is always returned.
    UT_StringHolder      getSelectionAncestor(const UT_StringRef &primpath,
                                const UT_StringRef &kindhint,
                                bool allow_kind_mismatch,
                                bool allow_instance_proxies,
                                bool allow_hidden_prims) const;
    
    // Populates "stats" with counts of various features of the stage.
    // Wrapper around API method UsdUtilsComputeUsdStageStats
    bool computeStageStats(UT_Options &stats) const;

    static bool computeStageStats(const UT_StringRef &path,
            UT_Options &stats);

    // Wrapper for UsdUtilsComputeAllDependencies
    static bool computeAllDependencies(const UT_StringRef &path,
            UT_StringArray &layers,
            UT_StringArray &resolved,
            UT_StringArray &unresolved);
    
    // Wrapper for UsdUtilsExtractExternalReferences
    static bool extractExternalReferences(const UT_StringRef &path,
            UT_StringArray &sub_layers,
            UT_StringArray &references,
            UT_StringArray &payloads);

    // Evaluates a primitive pattern on a stage created by loading the
    // specified USD file.
    static bool getExpandedPathSet(const UT_StringRef &filepath,
            const UT_StringRef &primpattern,
            HUSD_PathSet &paths);

    // Return the root prims in the layer identified by the path and file
    // format arguments provided. The root prims are added to the output
    // string set as paths.
    static bool getLayerRootPrims(const UT_StringRef &filepath,
            const UT_StringMap<UT_StringHolder> &fileargs,
            HUSD_PathSet &rootprims);

    // Return true if the layer identified by the path and file format
    // arguments provided has any prims outside the specified path.
    static bool hasAnyPrimsOutside(const UT_StringRef &filepath,
            const UT_StringMap<UT_StringHolder> &fileargs,
            const UT_StringRef &primpath);

    // Attributes
    enum class QueryAspect
    {
        ANY,        // Any attribute 
        ARRAY       // Attribute of some array type.
    };
    // Checks existence or property of a prim's attribute.
    bool                 isAttribAtPath(const UT_StringRef &attribpath,
                                QueryAspect query = QueryAspect::ANY) const;
    bool                 isAttribAtPath(const UT_StringRef &primpath,
                                const UT_StringRef &attribname,
                                QueryAspect query = QueryAspect::ANY) const;

    // Length of array attributes (1 for non-arrays).
    exint                getAttribLength(const UT_StringRef &attribpath,
                                const HUSD_TimeCode &time_code,
                                HUSD_TimeSampling *time_sampling=nullptr) const;
    exint                getAttribLength(const UT_StringRef &primpath,
                                const UT_StringRef &attribname,
                                const HUSD_TimeCode &time_code,
                                HUSD_TimeSampling *time_sampling=nullptr) const;

    // Tuple size of attributes (eg, 2,3,4 for vectors, 1 for scalars)
    // For array attributes, returns the tuple size of contained element type.
    exint                getAttribSize(const UT_StringRef &attribpath) const;
    exint                getAttribSize(const UT_StringRef &primpath,
                                const UT_StringRef &attribname) const;

    // Returns the name of the attribute type (eg, "float", "double3[]"). 
    // Note, this is different than attribute value type name (eg, "GfVec3d")
    UT_StringHolder      getAttribTypeName(const UT_StringRef &attrpath) const;
    UT_StringHolder      getAttribTypeName(const UT_StringRef &primpath,
                                const UT_StringRef &attribname) const;

    // Time samples array (may be empty)
    bool                 getAttribTimeSamples(const UT_StringRef &attribpath,
                                UT_FprealArray &time_samples) const;
    bool                 getAttribTimeSamples(const UT_StringRef &primpath,
                                const UT_StringRef &attribname,
                                UT_FprealArray &time_samples) const;

    // Transforms
    UT_Matrix4D          getLocalXform(const UT_StringRef &primpath,
                                const HUSD_TimeCode &time_code,
                                HUSD_TimeSampling *time_sampling=nullptr) const;
    UT_Matrix4D          getWorldXform(const UT_StringRef &primpath,
                                const HUSD_TimeCode &time_code,
                                HUSD_TimeSampling *time_sampling=nullptr) const;
    UT_Matrix4D          getParentXform(const UT_StringRef &primpath,
                                const HUSD_TimeCode &time_code,
                                HUSD_TimeSampling *time_sampling=nullptr) const;
    UT_Matrix4D          getXformFromOpOrder(const UT_StringRef &primpath,
                                const HUSD_TimeCode &time_code,
                                const UT_StringArray &xformOpOrder,
                                HUSD_TimeSampling *time_sampling=nullptr) const;
    bool                 getXformOrder(const UT_StringRef &primpath,
                                UT_StringArray &xform_order) const;
    bool                 isXformReset(const UT_StringRef &primpath) const;
    bool                 getXformTimeSamples(const UT_StringRef &primpath,
                                const UT_Vector2F &interval,
                                UT_Array<HUSD_TimeCode> &timecodes) const;

    UT_StringHolder      findXformName(const UT_StringRef &primpath,
                                const UT_StringRef &xform_name_suffix) const;
    UT_StringHolder      getUniqueXformName(const UT_StringRef &primpath,
                                HUSD_XformType type, 
                                const UT_StringRef &xform_name_suffix) const;

    static const UT_StringHolder &getTransformAttribName();
    static const UT_StringHolder &getTimeVaryingAttribName();
    void                 getAttributeNames(const UT_StringRef &primpath,
                                UT_ArrayStringSet &attrib_names) const;
    void                 extractAttributes(const UT_StringRef &primpath,
                                const UT_ArrayStringSet &which_attribs,
                                const HUSD_TimeCode &tc,
                                UT_Options &values,
                                HUSD_TimeSampling *time_sampling=nullptr) const;

    // Bounds
    UT_BoundingBoxD      getBounds(const UT_StringRef &primpath,
                                const UT_StringArray &purposes,
                                const HUSD_TimeCode &time_code) const;

    // Point Instancers
    bool                 getPointInstancerXforms( const UT_StringRef &primpath,
                                UT_Array<UT_Matrix4D> &xforms,
                                const HUSD_TimeCode &time_code);
    UT_BoundingBoxD      getPointInstancerBounds(const UT_StringRef &primpath,
                                exint instance_index,
                                const UT_StringArray &purposes,
                                const HUSD_TimeCode &time_code) const;
    int                  getPointInstancerInstanceCount(
                                const UT_StringRef &primpath,
                                const HUSD_TimeCode &time_code) const;

    // Lights
    bool                 hasAnyVisibleLights(
                                const HUSD_TimeCode &time_code) const;

    // Variants
    bool                 getVariantSets(const UT_StringRef &primpath,
                                UT_StringArray &vset_names) const;
    bool                 getVariants(const UT_StringRef &primpath,
                                const UT_StringRef &variantset,
                                UT_StringArray &vset_names) const;
    UT_StringHolder      getVariantSelection(const UT_StringRef &primpath,
                                const UT_StringRef &variantset) const;

    // Collections
    bool                 isCollectionAtPath(
                                const UT_StringRef &collectionpath) const;
    UT_StringHolder      getCollectionExpansionRule(
                                const UT_StringRef &collectionpath) const;
    bool                 getCollectionIncludePaths(
                                const UT_StringRef &collectionpath,
                                UT_StringArray &primpaths) const;
    bool                 getCollectionExcludePaths(
                                const UT_StringRef &collectionpath,
                                UT_StringArray &primpaths) const;
    bool                 getCollectionComputedPaths(
                                const UT_StringRef &collectionpath,
                                UT_StringArray &primpaths) const;
    bool                 collectionContains(
                                const UT_StringRef &collectionpath,
                                const UT_StringRef &primpath) const;
    bool                 getCollections(const UT_StringRef &primpath,
                                HUSD_CollectionInfoMap
                                    &collection_info_map) const;

    // Materials
    UT_StringHolder      getBoundMaterial(const UT_StringRef &primpath) const;

    // Primvars
    bool                 isPrimvarAtPath(const UT_StringRef &primpath,
                                const UT_StringRef &primvarname,
                                QueryAspect query = QueryAspect::ANY,
                                bool allow_inheritance = false) const;
    void                 getPrimvarNames(const UT_StringRef &primpath,
                                UT_ArrayStringSet &primvar_names,
                                bool allow_inheritance = false) const;
    exint                getPrimvarLength(const UT_StringRef &primpath,
                                const UT_StringRef &primvarname,
                                const HUSD_TimeCode &time_code,
                                HUSD_TimeSampling *time_sampling=nullptr,
                                bool allow_inheritance = false) const;
    exint                getPrimvarSize(const UT_StringRef &primpath,
                                const UT_StringRef &primvarname,
                                bool allow_inheritance = false) const;
    UT_StringHolder      getPrimvarTypeName(const UT_StringRef &primpath,
                                const UT_StringRef &primvarname,
                                bool allow_inheritance = false) const;
    bool                 getPrimvarTimeSamples(const UT_StringRef &primpath,
                                const UT_StringRef &primvarname,
                                UT_FprealArray &time_samples,
                                bool allow_inheritance = false) const;

    // Relationships
    void                 getRelationshipNames(const UT_StringRef &primpath,
                                UT_ArrayStringSet &rel_names) const;

    bool                 isRelationshipAtPath(
                                const UT_StringRef &relpath) const;
    bool                 isRelationshipAtPath(const UT_StringRef &primpath,
                                const UT_StringRef &relationahipname) const;

    bool                 getRelationshipTargets (
                                const UT_StringRef &relpath,
                                UT_StringArray &target_paths) const;
    bool                 getRelationshipTargets (
                                const UT_StringRef &primpath,
                                const UT_StringRef &relationshipname,
                                UT_StringArray &target_paths) const;

    bool                 getRelationshipForwardedTargets (
                                const UT_StringRef &relpath,
                                UT_StringArray &target_paths) const;
    bool                 getRelationshipForwardedTargets (
                                const UT_StringRef &primpath,
                                const UT_StringRef &relationshipname,
                                UT_StringArray &target_paths) const;

    // Metadata
    void                 getMetadataNames(const UT_StringRef &object_path,
                                UT_ArrayStringSet &metadata_names) const;
    bool                 isMetadataAtPath(const UT_StringRef &object_path,
                                const UT_StringRef &metadata_name,
                                QueryAspect query = QueryAspect::ANY) const;
    exint                getMetadataLength(const UT_StringRef &object_path,
                                const UT_StringRef &metadata_name) const;

    // Access information from the active layer, rather than the stage.
    bool                 isActiveLayerPrimAtPath(const UT_StringRef &primpath,
                                const UT_StringRef &prim_type =
                                    UT_StringHolder::theEmptyString) const;
    // Returns the identifiers and a human readable name for all sublayers of
    // the active layer in strongest to weakest order.
    bool                 getActiveLayerSubLayers(UT_StringArray &names,
                                UT_StringArray &identifiers,
                                UT_IntArray &fromlops,
                                UT_IntArray &fromsops) const;

    // Shader parameters.
    void                 getShaderInputAttributeNames(
                                const UT_StringRef &primpath,
                                UT_ArrayStringSet &attrib_names) const;

    // Obtains a value for a metadata on a given object.
    // The object path can point to a primitive, attribute, or a relationship.
    // The metadata name can be a simple name (eg, "active") or a name path
    // into metadata dictionaries (eg "assetInfo:foo" or "customData:bar:baz").
    template<typename UtValueType>
    bool                 getMetadata(const UT_StringRef &object_path,
                                const UT_StringRef &name,
                                UtValueType &value) const;

    // Obtains a value for custom data on a given object.
    template<typename UtValueType>
    bool                 getCustomData(const UT_StringRef &primpath,
                                const UT_StringRef &name,
                                UtValueType &value) const;

    // Obtains a value for asset info on a given object.
    template<typename UtValueType>
    bool                 getAssetInfo(const UT_StringRef &primpath,
                                const UT_StringRef &name,
                                UtValueType &value) const;

private:
    UT_UniquePtr<husd_InfoPrivate>       myPrivate;
    HUSD_AutoAnyLock                    &myAnyLock;
};

#endif