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

#include <pseudoRootSpec.h>

+ Inheritance diagram for SdfPseudoRootSpec:

Additional Inherited Members

- Public Types inherited from SdfPrimSpec
typedef SdfPrimSpecView NameChildrenView
 
typedef SdfPropertySpecView PropertySpecView
 
typedef SdfAttributeSpecView AttributeSpecView
 
typedef SdfRelationshipSpecView RelationshipSpecView
 
- Public Member Functions inherited from SdfPrimSpec
SDF_API SdfPrimSpecHandle GetNameRoot () const
 Returns the prim's namespace pseudo-root prim. More...
 
SDF_API SdfPrimSpecHandle GetNameParent () const
 
SDF_API SdfPrimSpecHandle GetRealNameParent () const
 Returns the prim's namespace parent. More...
 
SDF_API NameChildrenView GetNameChildren () const
 Returns a keyed vector view of the prim's namespace children. More...
 
SDF_API void SetNameChildren (const SdfPrimSpecHandleVector &)
 Updates nameChildren to match the given vector of prims. More...
 
SDF_API bool InsertNameChild (const SdfPrimSpecHandle &child, int index=-1)
 
SDF_API bool RemoveNameChild (const SdfPrimSpecHandle &child)
 Removes the child. Returns true if successful, false if failed. More...
 
SDF_API SdfNameChildrenOrderProxy GetNameChildrenOrder () const
 
SDF_API bool HasNameChildrenOrder () const
 Returns true if this prim has name children order specified. More...
 
SDF_API void SetNameChildrenOrder (const std::vector< TfToken > &names)
 
SDF_API void InsertInNameChildrenOrder (const TfToken &name, int index=-1)
 
SDF_API void RemoveFromNameChildrenOrder (const TfToken &name)
 Removes a name child name from the name children order. More...
 
SDF_API void RemoveFromNameChildrenOrderByIndex (int index)
 Removes a name child name from the name children order by index. More...
 
SDF_API void ApplyNameChildrenOrder (std::vector< TfToken > *vec) const
 
SDF_API PropertySpecView GetProperties () const
 Returns the prim's properties. More...
 
SDF_API void SetProperties (const SdfPropertySpecHandleVector &)
 Updates properties to match the given vector of properties. More...
 
SDF_API bool InsertProperty (const SdfPropertySpecHandle &property, int index=-1)
 
SDF_API void RemoveProperty (const SdfPropertySpecHandle &property)
 Removes the property. More...
 
SDF_API AttributeSpecView GetAttributes () const
 Returns a view of the attributes of this prim. More...
 
SDF_API RelationshipSpecView GetRelationships () const
 Returns a view of the relationships of this prim. More...
 
SDF_API SdfPropertyOrderProxy GetPropertyOrder () const
 
SDF_API bool HasPropertyOrder () const
 Returns true if this prim has a property ordering specified. More...
 
SDF_API void SetPropertyOrder (const std::vector< TfToken > &names)
 
SDF_API void InsertInPropertyOrder (const TfToken &name, int index=-1)
 
SDF_API void RemoveFromPropertyOrder (const TfToken &name)
 Remove a property name from the property order. More...
 
SDF_API void RemoveFromPropertyOrderByIndex (int index)
 Remove a property name from the property order by index. More...
 
SDF_API void ApplyPropertyOrder (std::vector< TfToken > *vec) const
 
SDF_API SdfSpecHandle GetObjectAtPath (const SdfPath &path) const
 
SDF_API SdfPrimSpecHandle GetPrimAtPath (const SdfPath &path) const
 
SDF_API SdfPropertySpecHandle GetPropertyAtPath (const SdfPath &path) const
 
SDF_API SdfAttributeSpecHandle GetAttributeAtPath (const SdfPath &path) const
 
SDF_API SdfRelationshipSpecHandle GetRelationshipAtPath (const SdfPath &path) const
 
SDF_API TfToken GetTypeName () const
 
SDF_API void SetTypeName (const std::string &value)
 Sets the typeName of the model prim. More...
 
SDF_API std::string GetComment () const
 
SDF_API void SetComment (const std::string &value)
 Sets the comment string for this prim spec. More...
 
SDF_API std::string GetDocumentation () const
 
SDF_API void SetDocumentation (const std::string &value)
 Sets the documentation string for this prim spec. More...
 
SDF_API bool GetActive () const
 
SDF_API void SetActive (bool value)
 Sets whether this prim spec is active. More...
 
SDF_API bool HasActive () const
 Returns true if this prim spec has an opinion about active. More...
 
SDF_API void ClearActive ()
 Removes the active opinion in this prim spec if there is one. More...
 
SDF_API bool GetHidden () const
 
SDF_API void SetHidden (bool value)
 Sets whether this prim spec will be hidden in browsers. More...
 
SDF_API TfToken GetKind () const
 
SDF_API void SetKind (const TfToken &value)
 Sets this prim spec's kind. More...
 
SDF_API bool HasKind () const
 Returns true if this prim spec has an opinion about kind. More...
 
SDF_API void ClearKind ()
 Remove the kind opinion from this prim spec if there is one. More...
 
SDF_API TfToken GetSymmetryFunction () const
 
SDF_API void SetSymmetryFunction (const TfToken &functionName)
 
SDF_API SdfDictionaryProxy GetSymmetryArguments () const
 
SDF_API void SetSymmetryArgument (const std::string &name, const VtValue &value)
 
SDF_API std::string GetSymmetricPeer () const
 
SDF_API void SetSymmetricPeer (const std::string &peerName)
 
SDF_API std::string GetPrefix () const
 
SDF_API void SetPrefix (const std::string &value)
 Sets the prefix string for this prim spec. More...
 
SDF_API std::string GetSuffix () const
 
SDF_API void SetSuffix (const std::string &value)
 Sets the suffix string for this prim spec. More...
 
SDF_API SdfDictionaryProxy GetCustomData () const
 
SDF_API SdfDictionaryProxy GetAssetInfo () const
 
SDF_API void SetCustomData (const std::string &name, const VtValue &value)
 
SDF_API void SetAssetInfo (const std::string &name, const VtValue &value)
 
SDF_API SdfSpecifier GetSpecifier () const
 Returns the spec specifier (def, over or class). More...
 
SDF_API void SetSpecifier (SdfSpecifier value)
 Sets the spec specifier (def or over). More...
 
SDF_API SdfPermission GetPermission () const
 
SDF_API void SetPermission (SdfPermission value)
 Sets the prim's permission restriction. More...
 
SDF_API VtDictionary GetPrefixSubstitutions () const
 
SDF_API void SetPrefixSubstitutions (const VtDictionary &prefixSubstitutions)
 Sets the prefixSubstitutions dictionary for this prim spec. More...
 
SDF_API VtDictionary GetSuffixSubstitutions () const
 
SDF_API void SetSuffixSubstitutions (const VtDictionary &suffixSubstitutions)
 Sets the suffixSubstitutions dictionary for this prim spec. More...
 
SDF_API void SetInstanceable (bool instanceable)
 Sets the value for the prim's instanceable flag. More...
 
SDF_API bool GetInstanceable () const
 Returns the value for the prim's instanceable flag. More...
 
SDF_API bool HasInstanceable () const
 
SDF_API void ClearInstanceable ()
 Clears the value for the prim's instanceable flag. More...
 
SDF_API SdfPayloadsProxy GetPayloadList () const
 
SDF_API bool HasPayloads () const
 Returns true if this prim has payloads set. More...
 
SDF_API void ClearPayloadList ()
 Clears the payloads for this prim. More...
 
SDF_API SdfInheritsProxy GetInheritPathList () const
 
SDF_API bool HasInheritPaths () const
 Returns true if this prim has inherit paths set. More...
 
SDF_API void ClearInheritPathList ()
 Clears the inherit paths for this prim. More...
 
SDF_API SdfSpecializesProxy GetSpecializesList () const
 
SDF_API bool HasSpecializes () const
 Returns true if this prim has specializes set. More...
 
SDF_API void ClearSpecializesList ()
 Clears the specializes for this prim. More...
 
SDF_API SdfReferencesProxy GetReferenceList () const
 
SDF_API bool HasReferences () const
 Returns true if this prim has references set. More...
 
SDF_API void ClearReferenceList ()
 Clears the references for this prim. More...
 
SDF_API SdfVariantSetNamesProxy GetVariantSetNameList () const
 
SDF_API bool HasVariantSetNames () const
 Returns true if this prim has variant sets set. More...
 
SDF_API std::vector< std::stringGetVariantNames (const std::string &name) const
 Returns list of variant names for the given variant set. More...
 
SDF_API SdfVariantSetsProxy GetVariantSets () const
 
SDF_API void RemoveVariantSet (const std::string &name)
 
SDF_API SdfVariantSelectionProxy GetVariantSelections () const
 
SDF_API void SetVariantSelection (const std::string &variantSetName, const std::string &variantName)
 
SDF_API void BlockVariantSelection (const std::string &variantSetName)
 
SDF_API SdfRelocatesMapProxy GetRelocates () const
 
SDF_API void SetRelocates (const SdfRelocatesMap &newMap)
 
SDF_API bool HasRelocates () const
 
SDF_API void ClearRelocates ()
 Clears the relocates opinion for this prim. More...
 
SDF_API const std::stringGetName () const
 Returns the prim's name. More...
 
SDF_API TfToken GetNameToken () const
 Returns the prim's name, as a token. More...
 
SDF_API bool CanSetName (const std::string &newName, std::string *whyNot) const
 
SDF_API bool SetName (const std::string &newName, bool validate=true)
 
- Public Member Functions inherited from SdfSpec
SDF_API SdfSpecoperator= (const SdfSpec &other)
 
SDF_API ~SdfSpec ()
 
SDF_API const SdfSchemaBaseGetSchema () const
 Returns the SdfSchemaBase for the layer that owns this spec. More...
 
SDF_API SdfSpecType GetSpecType () const
 
SDF_API bool IsDormant () const
 Returns true if this object is invalid or expired. More...
 
SDF_API SdfLayerHandle GetLayer () const
 Returns the layer that this object belongs to. More...
 
SDF_API SdfPath GetPath () const
 Returns the scene path of this object. More...
 
SDF_API bool PermissionToEdit () const
 Returns whether this object's layer can be edited. More...
 
SDF_API std::vector< TfTokenListInfoKeys () const
 
SDF_API std::vector< TfTokenGetMetaDataInfoKeys () const
 
SDF_API TfToken GetMetaDataDisplayGroup (TfToken const &key) const
 
SDF_API VtValue GetInfo (const TfToken &key) const
 
SDF_API void SetInfo (const TfToken &key, const VtValue &value)
 
SDF_API void SetInfoDictionaryValue (const TfToken &dictionaryKey, const TfToken &entryKey, const VtValue &value)
 
SDF_API bool HasInfo (const TfToken &key) const
 
SDF_API void ClearInfo (const TfToken &key)
 
SDF_API TfType GetTypeForInfo (const TfToken &key) const
 Returns the data type for the info with the given key. More...
 
SDF_API const VtValueGetFallbackForInfo (const TfToken &key) const
 Returns the fallback for the info with the given key. More...
 
SDF_API bool WriteToStream (std::ostream &, size_t indent=0) const
 Writes this spec to the given stream. More...
 
SDF_API bool IsInert (bool ignoreChildren=false) const
 
SDF_API std::vector< TfTokenListFields () const
 Returns all fields with values. More...
 
SDF_API bool HasField (const TfToken &name) const
 
template<class T >
bool HasField (const TfToken &name, T *value) const
 
SDF_API VtValue GetField (const TfToken &name) const
 Returns a field value by name. More...
 
template<typename T >
T GetFieldAs (const TfToken &name, const T &defaultValue=T()) const
 
SDF_API bool SetField (const TfToken &name, const VtValue &value)
 Sets a field value as a boxed VtValue. More...
 
template<typename T >
bool SetField (const TfToken &name, const T &value)
 Sets a field value of type T. More...
 
SDF_API bool ClearField (const TfToken &name)
 Clears a field. More...
 
SDF_API bool operator== (const SdfSpec &rhs) const
 
SDF_API bool operator< (const SdfSpec &rhs) const
 
- Static Public Member Functions inherited from SdfPrimSpec
static SDF_API SdfPrimSpecHandle New (const SdfLayerHandle &parentLayer, const std::string &name, SdfSpecifier spec, const std::string &typeName=std::string())
 
static SDF_API SdfPrimSpecHandle New (const SdfPrimSpecHandle &parentPrim, const std::string &name, SdfSpecifier spec, const std::string &typeName=std::string())
 
static SDF_API bool IsValidName (const std::string &name)
 Returns true if the given string is a valid prim name. More...
 
- Protected Member Functions inherited from SdfSpec
bool _MoveSpec (const SdfPath &oldPath, const SdfPath &newPath) const
 
bool _DeleteSpec (const SdfPath &path)
 

Detailed Description

Definition at line 37 of file pseudoRootSpec.h.


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