HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HUSD_Info Class Reference

#include <HUSD_Info.h>

Public Types

enum  DescendantStatsFlags { STATS_SIMPLE_COUNTS = 0x0000, STATS_PURPOSE_COUNTS = 0x0001, STATS_GEOMETRY_COUNTS = 0x0002 }
 
enum  QueryAspect { QueryAspect::ANY, QueryAspect::ARRAY }
 

Public Member Functions

 HUSD_Info ()
 
 HUSD_Info (HUSD_AutoAnyLock &lock)
 
 ~HUSD_Info ()
 
bool isStageValid () const
 
bool getStageRootLayer (UT_StringHolder &identifier) const
 
bool reloadWithContext (const UT_StringRef &filepath, bool recursive) const
 
bool getSourceLayers (UT_StringArray &names, UT_StringArray &identifiers, UT_IntArray &anonymous, UT_IntArray &fromsops) const
 
bool getLayerHierarchy (UT_InfoTree &hierarchy) const
 
bool getLayerSavePath (UT_StringHolder &savepath) const
 
bool getLayersAboveLayerBreak (UT_StringArray &identifiers) const
 
bool getLayerExists (const UT_StringRef &filepath) const
 
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
 
UT_StringHolder getCurrentRenderSettings () const
 
bool getAllRenderSettings (UT_StringArray &paths) const
 
bool isPrimAtPath (const UT_StringRef &primpath, const UT_StringRef &prim_type=UT_StringHolder::theEmptyString) 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 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
 
UT_StringHolder getAutoParentPrimKind (const UT_StringRef &primpath) const
 
bool hasChildren (const UT_StringRef &primpath) const
 
void getChildren (const UT_StringRef &primpath, UT_StringArray &childnames) const
 
void getDescendantStats (const UT_StringRef &primpath, UT_Options &stats, DescendantStatsFlags flags=STATS_SIMPLE_COUNTS) const
 
UT_StringHolder getAncestorOfKind (const UT_StringRef &primpath, const UT_StringRef &kind) const
 
UT_StringHolder getAncestorInstanceRoot (const UT_StringRef &primpath) const
 
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
 
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
 
exint getAttribSize (const UT_StringRef &attribpath) const
 
exint getAttribSize (const UT_StringRef &primpath, const UT_StringRef &attribname) const
 
UT_StringHolder getAttribTypeName (const UT_StringRef &attrpath) const
 
UT_StringHolder getAttribTypeName (const UT_StringRef &primpath, const UT_StringRef &attribname) const
 
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
 
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
 
bool getXformOrder (const UT_StringRef &primpath, UT_StringArray &xform_order) const
 
bool isXformReset (const UT_StringRef &primpath) 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
 
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
 
UT_BoundingBoxD getBounds (const UT_StringRef &primpath, const UT_StringArray &purposes, const HUSD_TimeCode &time_code) const
 
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
 
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
 
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
 
UT_StringHolder getBoundMaterial (const UT_StringRef &primpath) const
 
bool isPrimvarAtPath (const UT_StringRef &primpath, const UT_StringRef &primvarname, QueryAspect query=QueryAspect::ANY) const
 
void getPrimvarNames (const UT_StringRef &primpath, UT_ArrayStringSet &primvar_names) const
 
exint getPrimvarLength (const UT_StringRef &primpath, const UT_StringRef &primvarname, const HUSD_TimeCode &time_code, HUSD_TimeSampling *time_sampling=nullptr) const
 
exint getPrimvarSize (const UT_StringRef &primpath, const UT_StringRef &primvarname) const
 
UT_StringHolder getPrimvarTypeName (const UT_StringRef &primpath, const UT_StringRef &primvarname) const
 
bool getPrimvarTimeSamples (const UT_StringRef &primpath, const UT_StringRef &primvarname, UT_FprealArray &time_samples) const
 
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
 
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
 
bool isActiveLayerPrimAtPath (const UT_StringRef &primpath, const UT_StringRef &prim_type=UT_StringHolder::theEmptyString) const
 
bool getActiveLayerSubLayers (UT_StringArray &names, UT_StringArray &identifiers, UT_IntArray &anonymous, UT_IntArray &fromsops) const
 
void getShaderInputAttributeNames (const UT_StringRef &primpath, UT_ArrayStringSet &attrib_names) const
 

Static Public Member Functions

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)
 
static bool isModelKind (const UT_StringRef &kind)
 
static bool isGroupKind (const UT_StringRef &kind)
 
static bool isComponentKind (const UT_StringRef &kind)
 
static bool reload (const UT_StringRef &filepath, bool recursive)
 
static const UT_StringHoldergetTransformAttribName ()
 
static const UT_StringHoldergetTimeVaryingAttribName ()
 

Detailed Description

Definition at line 35 of file HUSD_Info.h.

Member Enumeration Documentation

Enumerator
STATS_SIMPLE_COUNTS 
STATS_PURPOSE_COUNTS 
STATS_GEOMETRY_COUNTS 

Definition at line 121 of file HUSD_Info.h.

Enumerator
ANY 
ARRAY 

Definition at line 137 of file HUSD_Info.h.

Constructor & Destructor Documentation

HUSD_Info::HUSD_Info ( )
HUSD_Info::HUSD_Info ( HUSD_AutoAnyLock lock)
HUSD_Info::~HUSD_Info ( )

Member Function Documentation

bool HUSD_Info::collectionContains ( const UT_StringRef collectionpath,
const UT_StringRef primpath 
) const
void HUSD_Info::extractAttributes ( const UT_StringRef primpath,
const UT_ArrayStringSet which_attribs,
const HUSD_TimeCode tc,
UT_Options values,
HUSD_TimeSampling time_sampling = nullptr 
) const
UT_StringHolder HUSD_Info::findXformName ( const UT_StringRef primpath,
const UT_StringRef xform_name_suffix 
) const
bool HUSD_Info::getActiveLayerSubLayers ( UT_StringArray names,
UT_StringArray identifiers,
UT_IntArray anonymous,
UT_IntArray fromsops 
) const
bool HUSD_Info::getAllRenderSettings ( UT_StringArray paths) const
UT_StringHolder HUSD_Info::getAncestorInstanceRoot ( const UT_StringRef primpath) const
UT_StringHolder HUSD_Info::getAncestorOfKind ( const UT_StringRef primpath,
const UT_StringRef kind 
) const
exint HUSD_Info::getAttribLength ( const UT_StringRef attribpath,
const HUSD_TimeCode time_code,
HUSD_TimeSampling time_sampling = nullptr 
) const
exint HUSD_Info::getAttribLength ( const UT_StringRef primpath,
const UT_StringRef attribname,
const HUSD_TimeCode time_code,
HUSD_TimeSampling time_sampling = nullptr 
) const
exint HUSD_Info::getAttribSize ( const UT_StringRef attribpath) const
exint HUSD_Info::getAttribSize ( const UT_StringRef primpath,
const UT_StringRef attribname 
) const
bool HUSD_Info::getAttribTimeSamples ( const UT_StringRef attribpath,
UT_FprealArray time_samples 
) const
bool HUSD_Info::getAttribTimeSamples ( const UT_StringRef primpath,
const UT_StringRef attribname,
UT_FprealArray time_samples 
) const
UT_StringHolder HUSD_Info::getAttribTypeName ( const UT_StringRef attrpath) const
UT_StringHolder HUSD_Info::getAttribTypeName ( const UT_StringRef primpath,
const UT_StringRef attribname 
) const
void HUSD_Info::getAttributeNames ( const UT_StringRef primpath,
UT_ArrayStringSet attrib_names 
) const
UT_StringHolder HUSD_Info::getAutoParentPrimKind ( const UT_StringRef primpath) const
UT_StringHolder HUSD_Info::getBoundMaterial ( const UT_StringRef primpath) const
UT_BoundingBoxD HUSD_Info::getBounds ( const UT_StringRef primpath,
const UT_StringArray purposes,
const HUSD_TimeCode time_code 
) const
void HUSD_Info::getChildren ( const UT_StringRef primpath,
UT_StringArray childnames 
) const
bool HUSD_Info::getCollectionComputedPaths ( const UT_StringRef collectionpath,
UT_StringArray primpaths 
) const
bool HUSD_Info::getCollectionExcludePaths ( const UT_StringRef collectionpath,
UT_StringArray primpaths 
) const
UT_StringHolder HUSD_Info::getCollectionExpansionRule ( const UT_StringRef collectionpath) const
bool HUSD_Info::getCollectionIncludePaths ( const UT_StringRef collectionpath,
UT_StringArray primpaths 
) const
bool HUSD_Info::getCollections ( const UT_StringRef primpath,
HUSD_CollectionInfoMap collection_info_map 
) const
UT_StringHolder HUSD_Info::getCurrentRenderSettings ( ) const
void HUSD_Info::getDescendantStats ( const UT_StringRef primpath,
UT_Options stats,
DescendantStatsFlags  flags = STATS_SIMPLE_COUNTS 
) const
UT_StringHolder HUSD_Info::getDrawMode ( const UT_StringRef primpath) const
bool HUSD_Info::getEndTimeCode ( fpreal64 endtimecode) const
bool HUSD_Info::getFramesPerSecond ( fpreal64 fps) const
UT_StringHolder HUSD_Info::getIcon ( const UT_StringRef primpath) const
UT_StringHolder HUSD_Info::getKind ( const UT_StringRef primpath) const
bool HUSD_Info::getLayerExists ( const UT_StringRef filepath) const
bool HUSD_Info::getLayerHierarchy ( UT_InfoTree hierarchy) const
bool HUSD_Info::getLayersAboveLayerBreak ( UT_StringArray identifiers) const
bool HUSD_Info::getLayerSavePath ( UT_StringHolder savepath) const
UT_Matrix4D HUSD_Info::getLocalXform ( const UT_StringRef primpath,
const HUSD_TimeCode time_code,
HUSD_TimeSampling time_sampling = nullptr 
) const
exint HUSD_Info::getMetadataLength ( const UT_StringRef object_path,
const UT_StringRef metadata_name 
) const
void HUSD_Info::getMetadataNames ( const UT_StringRef object_path,
UT_ArrayStringSet metadata_names 
) const
bool HUSD_Info::getMetrics ( UT_StringHolder upaxis,
fpreal64 metersperunit 
) const
UT_Matrix4D HUSD_Info::getParentXform ( const UT_StringRef primpath,
const HUSD_TimeCode time_code,
HUSD_TimeSampling time_sampling = nullptr 
) const
UT_BoundingBoxD HUSD_Info::getPointInstancerBounds ( const UT_StringRef primpath,
exint  instance_index,
const UT_StringArray purposes,
const HUSD_TimeCode time_code 
) const
bool HUSD_Info::getPointInstancerXforms ( const UT_StringRef primpath,
UT_Array< UT_Matrix4D > &  xforms,
const HUSD_TimeCode time_code 
)
static void HUSD_Info::getPrimitiveKinds ( UT_StringArray kinds)
static
UT_StringHolder HUSD_Info::getPrimType ( const UT_StringRef primpath) const
exint HUSD_Info::getPrimvarLength ( const UT_StringRef primpath,
const UT_StringRef primvarname,
const HUSD_TimeCode time_code,
HUSD_TimeSampling time_sampling = nullptr 
) const
void HUSD_Info::getPrimvarNames ( const UT_StringRef primpath,
UT_ArrayStringSet primvar_names 
) const
exint HUSD_Info::getPrimvarSize ( const UT_StringRef primpath,
const UT_StringRef primvarname 
) const
bool HUSD_Info::getPrimvarTimeSamples ( const UT_StringRef primpath,
const UT_StringRef primvarname,
UT_FprealArray time_samples 
) const
UT_StringHolder HUSD_Info::getPrimvarTypeName ( const UT_StringRef primpath,
const UT_StringRef primvarname 
) const
UT_StringHolder HUSD_Info::getPurpose ( const UT_StringRef primpath) const
bool HUSD_Info::getRelationshipForwardedTargets ( const UT_StringRef relpath,
UT_StringArray target_paths 
) const
bool HUSD_Info::getRelationshipForwardedTargets ( const UT_StringRef primpath,
const UT_StringRef relationshipname,
UT_StringArray target_paths 
) const
void HUSD_Info::getRelationshipNames ( const UT_StringRef primpath,
UT_ArrayStringSet rel_names 
) const
bool HUSD_Info::getRelationshipTargets ( const UT_StringRef relpath,
UT_StringArray target_paths 
) const
bool HUSD_Info::getRelationshipTargets ( const UT_StringRef primpath,
const UT_StringRef relationshipname,
UT_StringArray target_paths 
) const
void HUSD_Info::getShaderInputAttributeNames ( const UT_StringRef primpath,
UT_ArrayStringSet attrib_names 
) const
bool HUSD_Info::getSourceLayers ( UT_StringArray names,
UT_StringArray identifiers,
UT_IntArray anonymous,
UT_IntArray fromsops 
) const
bool HUSD_Info::getStageRootLayer ( UT_StringHolder identifier) const
bool HUSD_Info::getStartTimeCode ( fpreal64 starttimecode) const
bool HUSD_Info::getTimeCodesPerSecond ( fpreal64 tcs) const
static const UT_StringHolder& HUSD_Info::getTimeVaryingAttribName ( )
static
static const UT_StringHolder& HUSD_Info::getTransformAttribName ( )
static
UT_StringHolder HUSD_Info::getUniqueXformName ( const UT_StringRef primpath,
HUSD_XformType  type,
const UT_StringRef xform_name_suffix 
) const
static void HUSD_Info::getUsdVersionInfo ( UT_StringMap< UT_StringHolder > &  info)
static
bool HUSD_Info::getVariants ( const UT_StringRef primpath,
const UT_StringRef variantset,
UT_StringArray vset_names 
) const
UT_StringHolder HUSD_Info::getVariantSelection ( const UT_StringRef primpath,
const UT_StringRef variantset 
) const
bool HUSD_Info::getVariantSets ( const UT_StringRef primpath,
UT_StringArray vset_names 
) const
UT_Matrix4D HUSD_Info::getWorldXform ( const UT_StringRef primpath,
const HUSD_TimeCode time_code,
HUSD_TimeSampling time_sampling = nullptr 
) const
bool HUSD_Info::getXformOrder ( const UT_StringRef primpath,
UT_StringArray xform_order 
) const
bool HUSD_Info::hasChildren ( const UT_StringRef primpath) const
bool HUSD_Info::hasPayload ( const UT_StringRef primpath) const
bool HUSD_Info::hasPrimAPI ( const UT_StringRef primpath,
const UT_StringRef api 
) const
bool HUSD_Info::isActive ( const UT_StringRef primpath) const
bool HUSD_Info::isActiveLayerPrimAtPath ( const UT_StringRef primpath,
const UT_StringRef prim_type = UT_StringHolder::theEmptyString 
) const
static bool HUSD_Info::isArrayValueType ( const UT_StringRef valueType)
static
bool HUSD_Info::isAttribAtPath ( const UT_StringRef attribpath,
QueryAspect  query = QueryAspect::ANY 
) const
bool HUSD_Info::isAttribAtPath ( const UT_StringRef primpath,
const UT_StringRef attribname,
QueryAspect  query = QueryAspect::ANY 
) const
bool HUSD_Info::isCollectionAtPath ( const UT_StringRef collectionpath) const
static bool HUSD_Info::isComponentKind ( const UT_StringRef kind)
static
static bool HUSD_Info::isGroupKind ( const UT_StringRef kind)
static
bool HUSD_Info::isInstance ( const UT_StringRef primpath) const
bool HUSD_Info::isKind ( const UT_StringRef primpath,
const UT_StringRef kind 
) const
bool HUSD_Info::isMetadataAtPath ( const UT_StringRef object_path,
const UT_StringRef metadata_name,
QueryAspect  query = QueryAspect::ANY 
) const
static bool HUSD_Info::isModelKind ( const UT_StringRef kind)
static
bool HUSD_Info::isPrimAtPath ( const UT_StringRef primpath,
const UT_StringRef prim_type = UT_StringHolder::theEmptyString 
) const
bool HUSD_Info::isPrimType ( const UT_StringRef primpath,
const UT_StringRef type 
) const
bool HUSD_Info::isPrimvarAtPath ( const UT_StringRef primpath,
const UT_StringRef primvarname,
QueryAspect  query = QueryAspect::ANY 
) const
static bool HUSD_Info::isPrimvarName ( const UT_StringRef name)
static
bool HUSD_Info::isRelationshipAtPath ( const UT_StringRef relpath) const
bool HUSD_Info::isRelationshipAtPath ( const UT_StringRef primpath,
const UT_StringRef relationahipname 
) const
bool HUSD_Info::isStageValid ( ) const
static bool HUSD_Info::isTokenArrayValueType ( const UT_StringRef valueType)
static
bool HUSD_Info::isVisible ( const UT_StringRef primpath,
const HUSD_TimeCode time_code,
HUSD_TimeSampling time_sampling = nullptr 
) const
bool HUSD_Info::isXformReset ( const UT_StringRef primpath) const
static bool HUSD_Info::reload ( const UT_StringRef filepath,
bool  recursive 
)
static
bool HUSD_Info::reloadWithContext ( const UT_StringRef filepath,
bool  recursive 
) const

The documentation for this class was generated from the following file: