#include <attributeSpec.h>

Inheritance diagram for SdfAttributeSpec:

Public Types
typedef SdfAttributeSpec	This

typedef SdfPropertySpec	Parent

Public Member Functions
Connections
SDF_API SdfConnectionsProxy	GetConnectionPathList () const

SDF_API bool	HasConnectionPaths () const
	Returns `true` if any connection paths are set on this attribute. More...

SDF_API void	ClearConnectionPaths ()
	Clears the connection paths for this attribute. More...

Attribute value API
SDF_API VtTokenArray	GetAllowedTokens () const

SDF_API void	SetAllowedTokens (const VtTokenArray &allowedTokens)
	Sets the allowed tokens metadata for this attribute. More...

SDF_API bool	HasAllowedTokens () const
	Returns true if allowed tokens metadata is set for this attribute. More...

SDF_API void	ClearAllowedTokens ()
	Clears the allowed tokens metadata for this attribute. More...

SDF_API TfEnum	GetDisplayUnit () const
	Returns the display unit of the attribute. More...

SDF_API void	SetDisplayUnit (const TfEnum &displayUnit)
	Sets the display unit of the attribute. More...

SDF_API bool	HasDisplayUnit () const
	Returns true if a display unit is set for this attribute. More...

SDF_API void	ClearDisplayUnit ()
	Clears the display unit of the attribute. More...

SDF_API TfToken	GetColorSpace () const

SDF_API void	SetColorSpace (const TfToken &colorSpace)

SDF_API bool	HasColorSpace () const
	Returns true if this attribute has a colorSpace value authored. More...

SDF_API void	ClearColorSpace ()
	Clears the colorSpace metadata value set on this attribute. More...

Spec properties
SDF_API TfToken	GetRoleName () const

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 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

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)

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 construction
static SDF_API SdfAttributeSpecHandle	New (const SdfPrimSpecHandle &owner, const std::string &name, const SdfValueTypeName &typeName, SdfVariability variability=SdfVariabilityVarying, bool custom=false)

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

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 subclass of SdfPropertySpec that holds typed data.

Attributes are typed data containers that can optionally hold any and all of the following:

A single default value.
An array of knot values describing how the value varies over time.
A dictionary of posed values, indexed by name.

The values contained in an attribute must all be of the same type. In the Python API the typeName property holds the attribute type. In the C++ API, you can get the attribute type using the GetTypeName() method. In addition, all values, including all knot values, must be the same shape. For information on shapes, see the VtShape class reference in the C++ documentation.

Definition at line 56 of file attributeSpec.h.

Member Typedef Documentation

typedef SdfPropertySpec SdfAttributeSpec::Parent

Definition at line 62 of file attributeSpec.h.

typedef SdfAttributeSpec SdfAttributeSpec::This

Definition at line 61 of file attributeSpec.h.

Member Function Documentation

SDF_API void SdfAttributeSpec::ClearAllowedTokens ( )

Clears the allowed tokens metadata for this attribute.

SDF_API void SdfAttributeSpec::ClearColorSpace ( )

Clears the colorSpace metadata value set on this attribute.

SDF_API void SdfAttributeSpec::ClearConnectionPaths ( )

Clears the connection paths for this attribute.

SDF_API void SdfAttributeSpec::ClearDisplayUnit ( )

Clears the display unit of the attribute.

SDF_API VtTokenArray SdfAttributeSpec::GetAllowedTokens ( ) const

Returns the allowed tokens metadata for this attribute. Consumers may use this metadata to define a set of predefined options for this attribute's value. However, this metadata is purely advisory. It is up to the consumer to perform any validation against this set of tokens, if desired.

SDF_API TfToken SdfAttributeSpec::GetColorSpace ( ) const

Returns the color-space in which a color or texture valued attribute is authored.

SDF_API SdfConnectionsProxy SdfAttributeSpec::GetConnectionPathList ( ) const

Returns a proxy for editing the attribute's connection paths.

The returned proxy, which is an SdfListEditorProxy, modifies the SdfListOp that represents this attribute's connections.

SDF_API TfEnum SdfAttributeSpec::GetDisplayUnit ( ) const

Returns the display unit of the attribute.

SDF_API TfToken SdfAttributeSpec::GetRoleName ( ) const

Returns the roleName for this attribute's typeName.

If the typeName has no roleName, return empty token.

SDF_API bool SdfAttributeSpec::HasAllowedTokens ( ) const

Returns true if allowed tokens metadata is set for this attribute.

SDF_API bool SdfAttributeSpec::HasColorSpace ( ) const

Returns true if this attribute has a colorSpace value authored.

SDF_API bool SdfAttributeSpec::HasConnectionPaths ( ) const

Returns true if any connection paths are set on this attribute.

SDF_API bool SdfAttributeSpec::HasDisplayUnit ( ) const

Returns true if a display unit is set for this attribute.

static SDF_API SdfAttributeSpecHandle SdfAttributeSpec::New	(	const SdfPrimSpecHandle &	owner,
		const std::string &	name,
		const SdfValueTypeName &	typeName,
		SdfVariability	variability = `SdfVariabilityVarying`,
		bool	custom = `false`
	)

static

Constructs a new prim attribute instance.

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

SDF_API void SdfAttributeSpec::SetAllowedTokens ( const VtTokenArray & allowedTokens )

Sets the allowed tokens metadata for this attribute.

SDF_API void SdfAttributeSpec::SetColorSpace ( const TfToken & colorSpace )

Sets the color-space in which a color or texture valued attribute is authored.

SDF_API void SdfAttributeSpec::SetDisplayUnit ( const TfEnum & displayUnit )

Sets the display unit of the attribute.

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

pxr/usd/sdf/attributeSpec.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Function Documentation