ufe  3.2
Universal Front End is a DCC-agnostic component that will allow a DCC to browse and edit data in multiple data models
Ufe::TypedAttribute< T > Class Template Referenceabstract

Typed attribute template for creating a specialized type. More...

#include <attribute.h>

Inheritance diagram for Ufe::TypedAttribute< T >:
Collaboration diagram for Ufe::TypedAttribute< T >:

Public Types

typedef std::shared_ptr< TypedAttribute< T > > Ptr
 
- Public Types inherited from Ufe::Attribute
typedef std::shared_ptr< AttributePtr
 
typedef std::string Type
 

Public Member Functions

Type type () const final
 
virtual T get () const =0
 
virtual void set (const T &value)=0
 Set the attribute value. More...
 
virtual UndoableCommand::Ptr setCmd (const T &value)
 Set the attribute value, and return a command for undo / redo. More...
 
 Attribute (const SceneItem::Ptr &)
 Constructor. More...
 
 Attribute (const Attribute &)=delete
 No copy or move constructor/assignment. More...
 
 Attribute (Attribute &&)=delete
 
- Public Member Functions inherited from Ufe::Attribute
 Attribute (const SceneItem::Ptr &)
 Constructor. More...
 
virtual ~Attribute ()
 
SceneItem::Ptr sceneItem () const
 
virtual bool hasValue () const =0
 
virtual std::string name () const =0
 
virtual std::string documentation () const =0
 
virtual std::string string () const =0
 
 Attribute (const Attribute &)=delete
 No copy or move constructor/assignment. More...
 
Attributeoperator= (const Attribute &)=delete
 No copy or move constructor/assignment. More...
 
 Attribute (Attribute &&)=delete
 No copy or move constructor/assignment. More...
 
Attributeoperator= (Attribute &&)=delete
 No copy or move constructor/assignment. More...
 
virtual Value getMetadata (const std::string &key) const =0
 
virtual bool setMetadata (const std::string &key, const Value &value)=0
 
virtual UndoableCommand::Ptr setMetadataCmd (const std::string &key, const Value &value)
 
virtual bool clearMetadata (const std::string &key)=0
 
virtual bool hasMetadata (const std::string &key) const =0
 Returns true if metadata key has a non-empty value. More...
 

Additional Inherited Members

- Static Public Attributes inherited from Ufe::Attribute
static constexpr char kInvalid [] = "Invalid"
 
static constexpr char kBool [] = "Bool"
 
static constexpr char kInt [] = "Int"
 
static constexpr char kFloat [] = "Float"
 
static constexpr char kDouble [] = "Double"
 
static constexpr char kString [] = "String"
 
static constexpr char kColorFloat3 [] = "ColorFloat3"
 
static constexpr char kEnumString [] = "EnumString"
 
static constexpr char kInt3 [] = "Int3"
 
static constexpr char kFloat3 [] = "Float3"
 
static constexpr char kDouble3 [] = "Double3"
 
static constexpr char kGeneric [] = "Generic"
 
static constexpr char kLocked [] = "Locked"
 

Detailed Description

template<typename T>
class Ufe::TypedAttribute< T >

Typed attribute template for creating a specialized type.

Definition at line 193 of file attribute.h.

Member Typedef Documentation

◆ Ptr

template<typename T >
typedef std::shared_ptr<TypedAttribute<T> > Ufe::TypedAttribute< T >::Ptr

Definition at line 197 of file attribute.h.

Member Function Documentation

◆ Attribute() [1/3]

template<typename T >
Ufe::Attribute::Attribute

Constructor.

◆ Attribute() [2/3]

template<typename T >
Ufe::Attribute::Attribute
delete

◆ Attribute() [3/3]

template<typename T >
Ufe::Attribute::Attribute
delete

No copy or move constructor/assignment.

◆ get()

template<typename T >
virtual T Ufe::TypedAttribute< T >::get ( ) const
pure virtual
Returns
The attribute value.

◆ set()

template<typename T >
virtual void Ufe::TypedAttribute< T >::set ( const T &  value)
pure virtual

Set the attribute value.

◆ setCmd()

template<typename T >
virtual UndoableCommand::Ptr Ufe::TypedAttribute< T >::setCmd ( const T &  value)
virtual

Set the attribute value, and return a command for undo / redo.

◆ type()

template<typename T >
Type Ufe::TypedAttribute< T >::type ( ) const
finalvirtual
Returns
The attributes type.

Implements Ufe::Attribute.


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