![]() |
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
|
Abstract base class for Attribute interface. More...
#include <attribute.h>
Public Types | |
typedef std::shared_ptr< Attribute > | Ptr |
typedef std::string | Type |
Public Member Functions | |
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 Type | type () const =0 |
virtual std::string | string () const =0 |
Attribute (const Attribute &)=delete | |
No copy or move constructor/assignment. More... | |
Attribute & | operator= (const Attribute &)=delete |
No copy or move constructor/assignment. More... | |
Attribute (Attribute &&)=delete | |
No copy or move constructor/assignment. More... | |
Attribute & | operator= (Attribute &&)=delete |
No copy or move constructor/assignment. More... | |
Metadata Access: | |
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... | |
Static Public Attributes | |
Built-in attribute types: | |
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" |
Metadata Keys: | |
static constexpr char | kLocked [] = "Locked" |
Private Attributes | |
const SceneItem::Ptr | fItem |
Abstract base class for Attribute interface.
This base class defines an interface for factory objects that runtimes implement to handle the various supported attribute types (such as bool, int, float, etc).
Definition at line 37 of file attribute.h.
typedef std::shared_ptr<Attribute> Ufe::Attribute::Ptr |
Definition at line 40 of file attribute.h.
typedef std::string Ufe::Attribute::Type |
Definition at line 41 of file attribute.h.
Ufe::Attribute::Attribute | ( | const SceneItem::Ptr & | ) |
Constructor.
|
virtual |
|
delete |
No copy or move constructor/assignment.
|
delete |
No copy or move constructor/assignment.
|
pure virtual |
Clear the metadata key's value.
[in] | key | The metadata key to clear. |
|
pure virtual |
|
pure virtual |
Get the value of the metadata named key.
[in] | key | The metadata key to query. |
|
pure virtual |
Returns true if metadata key has a non-empty value.
|
pure virtual |
|
pure virtual |
No copy or move constructor/assignment.
No copy or move constructor/assignment.
SceneItem::Ptr Ufe::Attribute::sceneItem | ( | ) | const |
|
pure virtual |
Set the metadata key's value to value.
[in] | key | The metadata key to set. |
[in] | value | The value to set. |
|
virtual |
Return a command for undo / redo that sets the metadata key's value to value. The returned command is not executed; it is up to the caller to call execute().
|
pure virtual |
|
pure virtual |
Implemented in Ufe::TypedAttribute< T >, Ufe::AttributeEnumString, and Ufe::AttributeGeneric.
|
private |
Definition at line 144 of file attribute.h.
|
static |
Definition at line 46 of file attribute.h.
|
static |
Definition at line 51 of file attribute.h.
|
static |
Definition at line 49 of file attribute.h.
|
static |
Definition at line 55 of file attribute.h.
|
static |
Definition at line 52 of file attribute.h.
|
static |
Definition at line 48 of file attribute.h.
|
static |
Definition at line 54 of file attribute.h.
|
static |
Definition at line 56 of file attribute.h.
|
static |
Definition at line 47 of file attribute.h.
|
static |
Definition at line 53 of file attribute.h.
|
static |
Definition at line 45 of file attribute.h.
|
static |
Metadata key: Locked, value type = bool
A locked attribute value cannot be changed.
Definition at line 98 of file attribute.h.
|
static |
Definition at line 50 of file attribute.h.