#include <relationshipSpec.h>

Inheritance diagram for SdfRelationshipSpec:

Public Types
typedef SdfRelationshipSpec	This

typedef SdfPropertySpec	Parent

Public Member Functions
SDF_API bool	GetNoLoadHint (void) const

SDF_API void	SetNoLoadHint (bool noload)

Relationship targets
SDF_API SdfTargetsProxy	GetTargetPathList () const

SDF_API bool	HasTargetPathList () const
	Returns true if the relationship has any target paths. More...

SDF_API void	ClearTargetPathList () const
	Clears the list of target paths on this relationship. More...

SDF_API void	ReplaceTargetPath (const SdfPath &oldPath, const SdfPath &newPath)

SDF_API void	RemoveTargetPath (const SdfPath &path, bool preserveTargetOrder=false)

Public Member Functions inherited from SdfPropertySpec
SDF_API SdfSpecHandle	GetOwner () const
	Returns the owner prim or relationship of this property. 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 std::string	GetDisplayGroup () const

SDF_API void	SetDisplayGroup (const std::string &value)
	Sets the displayGroup string for this property spec. More...

SDF_API std::string	GetDisplayName () const

SDF_API void	SetDisplayName (const std::string &value)
	Sets the displayName string for this property spec. More...

SDF_API std::string	GetDocumentation () const

SDF_API void	SetDocumentation (const std::string &value)
	Sets the documentation string for this property spec. More...

SDF_API bool	GetHidden () const

SDF_API void	SetHidden (bool value)
	Sets whether this property spec will be hidden in browsers. More...

SDF_API SdfPermission	GetPermission () const

SDF_API void	SetPermission (SdfPermission value)
	Sets the property's permission restriction. More...

SDF_API std::string	GetPrefix () const

SDF_API void	SetPrefix (const std::string &value)
	Sets the prefix string for this property spec. More...

SDF_API std::string	GetSuffix () const

SDF_API void	SetSuffix (const std::string &value)
	Sets the suffix string for this property spec. More...

SDF_API std::string	GetSymmetricPeer () const

SDF_API void	SetSymmetricPeer (const std::string &peerName)

SDF_API SdfDictionaryProxy	GetSymmetryArguments () const

SDF_API void	SetSymmetryArgument (const std::string &name, const VtValue &value)

SDF_API TfToken	GetSymmetryFunction () const

SDF_API void	SetSymmetryFunction (const TfToken &functionName)

SDF_API SdfTimeSampleMap	GetTimeSampleMap () const
	Returns the entire set of time samples. More...

SDF_API TfType	GetValueType () const
	Returns the TfType representing the value type this property holds. More...

SDF_API SdfValueTypeName	GetTypeName () const

SDF_API VtValue	GetDefaultValue () const

SDF_API bool	SetDefaultValue (const VtValue &defaultValue)

SDF_API bool	HasDefaultValue () const
	Returns true if a default value is set for this attribute. More...

SDF_API void	ClearDefaultValue ()
	Clear the attribute's default value. More...

SDF_API const std::string &	GetName () const
	Returns the property's name. More...

SDF_API TfToken	GetNameToken () const
	Returns the property'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)

SDF_API std::string	GetComment () const

SDF_API void	SetComment (const std::string &value)
	Sets the comment string for this property spec. More...

SDF_API bool	IsCustom () const
	Returns true if this spec declares a custom property. More...

SDF_API void	SetCustom (bool custom)
	Sets whether this spec declares a custom property. More...

SDF_API SdfVariability	GetVariability () const

SDF_API bool	HasOnlyRequiredFields () const

Public Member Functions inherited from SdfSpec
SDF_API SdfSpec &	operator= (const SdfSpec &other)

SDF_API	~SdfSpec ()

SDF_API const SdfSchemaBase &	GetSchema () 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< TfToken >	ListInfoKeys () const

SDF_API std::vector< TfToken >	GetMetaDataInfoKeys () 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 VtValue &	GetFallbackForInfo (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< TfToken >	ListFields () 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
Spec creation
static SDF_API SdfRelationshipSpecHandle	New (const SdfPrimSpecHandle &owner, const std::string &name, bool custom=true, SdfVariability variability=SdfVariabilityUniform)

Static Public Member Functions inherited from SdfPropertySpec
static SDF_API bool	IsValidName (const std::string &name)

Friends
class	SdfAttributeSpec

class	Sdf_PyRelationshipAccess

Additional Inherited Members
Protected Member Functions inherited from SdfSpec
bool	_MoveSpec (const SdfPath &oldPath, const SdfPath &newPath) const

bool	_DeleteSpec (const SdfPath &path)

Detailed Description

A property that contains a reference to one or more SdfPrimSpec instances.

A relationship may refer to one or more target prims or attributes. All targets of a single relationship are considered to be playing the same role. Note that role does not imply that the target prims or attributes are of the same type.

Relationships may be annotated with relational attributes. Relational attributes are named SdfAttributeSpec objects containing values that describe the relationship. For example, point weights are commonly expressed as relational attributes.

Definition at line 51 of file relationshipSpec.h.

Member Typedef Documentation

typedef SdfPropertySpec SdfRelationshipSpec::Parent

Definition at line 57 of file relationshipSpec.h.

typedef SdfRelationshipSpec SdfRelationshipSpec::This

Definition at line 56 of file relationshipSpec.h.

Member Function Documentation

SDF_API void SdfRelationshipSpec::ClearTargetPathList ( ) const

Clears the list of target paths on this relationship.

SDF_API bool SdfRelationshipSpec::GetNoLoadHint ( void ) const

Get whether loading the target of this relationship is necessary to load the prim we're attached to

SDF_API SdfTargetsProxy SdfRelationshipSpec::GetTargetPathList ( ) const

Returns the relationship's target path list editor.

The list of the target paths for this relationship may be modified through the proxy.

SDF_API bool SdfRelationshipSpec::HasTargetPathList ( ) const

Returns true if the relationship has any target paths.

static SDF_API SdfRelationshipSpecHandle SdfRelationshipSpec::New	(	const SdfPrimSpecHandle &	owner,
		const std::string &	name,
		bool	custom = `true`,
		SdfVariability	variability = `SdfVariabilityUniform`
	)

static

Creates a new prim relationship instance.

Creates and returns a new relationship for the given prim. The owner will own the newly created relationship.

SDF_API void SdfRelationshipSpec::RemoveTargetPath	(	const SdfPath &	path,
		bool	preserveTargetOrder = `false`
	)

Removes the specified target path.

Removes the given target path and any relational attributes for the given target path. If preserveTargetOrder is true, Erase() is called on the list editor instead of RemoveItemEdits(). This preserves the ordered items list.

SDF_API void SdfRelationshipSpec::ReplaceTargetPath	(	const SdfPath &	oldPath,
		const SdfPath &	newPath
	)

Updates the specified target path.

Replaces the path given by oldPath with the one specified by newPath. Relational attributes are updated if necessary.

SDF_API void SdfRelationshipSpec::SetNoLoadHint ( bool noload )

Set whether loading the target of this relationship is necessary to load the prim we're attached to

Friends And Related Function Documentation

friend class Sdf_PyRelationshipAccess

friend

Definition at line 133 of file relationshipSpec.h.

friend class SdfAttributeSpec

friend

Definition at line 130 of file relationshipSpec.h.

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

pxr/usd/sdf/relationshipSpec.h

Public Types

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Function Documentation

Friends And Related Function Documentation