Timeline-style controller for one authored avatar document. 更多...
#include <AvatarDocumentEditor.h>
Public 成员函数 | |
| AvatarDocumentEditor (std::string targetId) | |
| Construct a seeded two-layer face with a referenced parameter. | |
| AvatarDocumentEditor (const AvatarDocumentEditor &)=delete | |
| AvatarDocumentEditor & | operator= (const AvatarDocumentEditor &)=delete |
| const avatar_editing::AvatarDocumentTarget & | target () const noexcept |
| Borrow the authoritative avatar document. | |
| avatar_editing::Result< void > | configureWorkspace (editor::EditorWorkspace &workspace) const |
| Install Layers / Preview / Inspector / Parameters / Expressions panels. | |
| avatar_editing::Result< void > | selectLayer (std::string id) |
| avatar_editing::Result< void > | selectParameter (std::string id) |
| avatar_editing::Result< void > | selectExpression (std::string id) |
| avatar_editing::Result< void > | pointerDown (float x, float y) |
| avatar_editing::Result< void > | setLayerVisible (bool visible) |
| avatar_editing::Result< void > | setLayerZ (int zIndex) |
| avatar_editing::Result< void > | setParameterValue (double value) |
| avatar_editing::Result< void > | createLayer (std::string id, std::string name) |
| avatar_editing::Result< void > | deleteSelectedLayer () |
| avatar_editing::Result< void > | createParameter (std::string id, std::string name) |
| avatar_editing::Result< void > | deleteSelectedParameter () |
| avatar_editing::Result< void > | createExpression (std::string id, std::string name) |
| avatar_editing::Result< void > | deleteSelectedExpression () |
| avatar_editing::Result< editor::TransactionReceipt > | undo () |
| avatar_editing::Result< editor::TransactionReceipt > | redo () |
| bool | canUndo () const noexcept |
| bool | canRedo () const noexcept |
| Can redo. | |
| std::uint64_t | revision () const noexcept |
| Revision. | |
| std::uint64_t | previewRevision () const noexcept |
| Preview revision. | |
| std::string | kind () const |
| Kind. | |
| std::string | selectedId () const |
| Selected id. | |
| std::string | selectedType () const |
| Selected type. | |
| int | layerCount () const |
| Layer count. | |
| std::string | layerId (int index) const |
| Layer id. | |
| std::string | layerName (int index) const |
| Layer name. | |
| bool | layerVisible (int index) const |
| Layer visible. | |
| int | layerZ (int index) const |
| Layer z. | |
| bool | isLayerSelected (int index) const |
| True when layer selected. | |
| int | previewLayerCount () const |
| Preview layer count. | |
| float | previewX (int index) const |
| Preview x. | |
| float | previewY (int index) const |
| Preview y. | |
| float | previewW (int index) const |
| Preview w. | |
| float | previewH (int index) const |
| Preview h. | |
| float | previewR (int index) const |
| Preview r. | |
| float | previewG (int index) const |
| Preview g. | |
| float | previewB (int index) const |
| Preview b. | |
| float | previewA (int index) const |
| Preview a. | |
| bool | isPreviewSelected (int index) const |
| True when preview selected. | |
| std::string | previewName (int index) const |
| Preview name. | |
| int | parameterCount () const |
| Parameter count. | |
| std::string | parameterId (int index) const |
| Parameter id. | |
| std::string | parameterName (int index) const |
| Parameter name. | |
| float | parameterValue (int index) const |
| Parameter value. | |
| float | parameterMinimum (int index) const |
| Parameter minimum. | |
| float | parameterMaximum (int index) const |
| Parameter maximum. | |
| bool | isParameterSelected (int index) const |
| True when parameter selected. | |
| int | expressionCount () const |
| Expression count. | |
| std::string | expressionId (int index) const |
| Expression id. | |
| std::string | expressionName (int index) const |
| Expression name. | |
| bool | isExpressionSelected (int index) const |
| True when expression selected. | |
| int | expressionChannelCount (int index) const |
| Expression channel count. | |
| std::string | expressionChannelName (int expression, int channel) const |
| Expression channel name. | |
详细描述
Timeline-style controller for one authored avatar document.
Owns the document, local undo and a CPU composite of authored layer rects. Live AvatarInstance publication stays candidate-first and is skipped until a texture resolver is attached; failed publish keeps the last successful layout.
@ownership Editor owns the document. Preview getters copy values. @threadaffinity Owner thread only. @reentrancy No unknown callbacks.
在文件 AvatarDocumentEditor.h 第 32 行定义.
构造及析构函数说明
◆ AvatarDocumentEditor() [1/2]
|
explicit |
Construct a seeded two-layer face with a referenced parameter.
在文件 AvatarDocumentEditor.cpp 第 38 行定义.
◆ AvatarDocumentEditor() [2/2]
|
delete |
成员函数说明
◆ canRedo()
|
inlinenoexcept |
Can redo.
在文件 AvatarDocumentEditor.h 第 69 行定义.
◆ canUndo()
|
inlinenoexcept |
在文件 AvatarDocumentEditor.h 第 67 行定义.
◆ configureWorkspace()
| avatar_editing::Result< void > eve::avatar_editor::AvatarDocumentEditor::configureWorkspace | ( | editor::EditorWorkspace & | workspace | ) | const |
Install Layers / Preview / Inspector / Parameters / Expressions panels.
- 注解
- Does not retain
workspace.
在文件 AvatarDocumentEditor.cpp 第 77 行定义.
引用了 eve::editor::EditorWorkspace::activatePanel(), context, id, order, eve::editor::EditorWorkspace::registerPanel(), eve::editor::EditorWorkspace::setPanelCapability(), eve::editor::EditorWorkspace::setPanelContext() , 以及 title.
◆ createExpression()
| avatar_editing::Result< void > eve::avatar_editor::AvatarDocumentEditor::createExpression | ( | std::string | id, |
| std::string | name | ||
| ) |
◆ createLayer()
| avatar_editing::Result< void > eve::avatar_editor::AvatarDocumentEditor::createLayer | ( | std::string | id, |
| std::string | name | ||
| ) |
◆ createParameter()
| avatar_editing::Result< void > eve::avatar_editor::AvatarDocumentEditor::createParameter | ( | std::string | id, |
| std::string | name | ||
| ) |
◆ deleteSelectedExpression()
| avatar_editing::Result< void > eve::avatar_editor::AvatarDocumentEditor::deleteSelectedExpression | ( | ) |
◆ deleteSelectedLayer()
| avatar_editing::Result< void > eve::avatar_editor::AvatarDocumentEditor::deleteSelectedLayer | ( | ) |
◆ deleteSelectedParameter()
| avatar_editing::Result< void > eve::avatar_editor::AvatarDocumentEditor::deleteSelectedParameter | ( | ) |
◆ expressionChannelCount()
| int eve::avatar_editor::AvatarDocumentEditor::expressionChannelCount | ( | int | index | ) | const |
◆ expressionChannelName()
| std::string eve::avatar_editor::AvatarDocumentEditor::expressionChannelName | ( | int | expression, |
| int | channel | ||
| ) | const |
◆ expressionCount()
|
inline |
Expression count.
在文件 AvatarDocumentEditor.h 第 133 行定义.
◆ expressionId()
| std::string eve::avatar_editor::AvatarDocumentEditor::expressionId | ( | int | index | ) | const |
◆ expressionName()
| std::string eve::avatar_editor::AvatarDocumentEditor::expressionName | ( | int | index | ) | const |
◆ isExpressionSelected()
| bool eve::avatar_editor::AvatarDocumentEditor::isExpressionSelected | ( | int | index | ) | const |
◆ isLayerSelected()
| bool eve::avatar_editor::AvatarDocumentEditor::isLayerSelected | ( | int | index | ) | const |
◆ isParameterSelected()
| bool eve::avatar_editor::AvatarDocumentEditor::isParameterSelected | ( | int | index | ) | const |
◆ isPreviewSelected()
| bool eve::avatar_editor::AvatarDocumentEditor::isPreviewSelected | ( | int | index | ) | const |
◆ kind()
|
inline |
Kind.
在文件 AvatarDocumentEditor.h 第 75 行定义.
◆ layerCount()
|
inline |
Layer count.
在文件 AvatarDocumentEditor.h 第 82 行定义.
◆ layerId()
| std::string eve::avatar_editor::AvatarDocumentEditor::layerId | ( | int | index | ) | const |
◆ layerName()
| std::string eve::avatar_editor::AvatarDocumentEditor::layerName | ( | int | index | ) | const |
◆ layerVisible()
| bool eve::avatar_editor::AvatarDocumentEditor::layerVisible | ( | int | index | ) | const |
◆ layerZ()
| int eve::avatar_editor::AvatarDocumentEditor::layerZ | ( | int | index | ) | const |
◆ operator=()
|
delete |
◆ parameterCount()
|
inline |
Parameter count.
在文件 AvatarDocumentEditor.h 第 118 行定义.
◆ parameterId()
| std::string eve::avatar_editor::AvatarDocumentEditor::parameterId | ( | int | index | ) | const |
◆ parameterMaximum()
| float eve::avatar_editor::AvatarDocumentEditor::parameterMaximum | ( | int | index | ) | const |
◆ parameterMinimum()
| float eve::avatar_editor::AvatarDocumentEditor::parameterMinimum | ( | int | index | ) | const |
◆ parameterName()
| std::string eve::avatar_editor::AvatarDocumentEditor::parameterName | ( | int | index | ) | const |
◆ parameterValue()
| float eve::avatar_editor::AvatarDocumentEditor::parameterValue | ( | int | index | ) | const |
◆ pointerDown()
| avatar_editing::Result< void > eve::avatar_editor::AvatarDocumentEditor::pointerDown | ( | float | x, |
| float | y | ||
| ) |
在文件 AvatarDocumentEditor.cpp 第 223 行定义.
引用了 selectLayer(), x , 以及 y.
◆ previewA()
| float eve::avatar_editor::AvatarDocumentEditor::previewA | ( | int | index | ) | const |
◆ previewB()
| float eve::avatar_editor::AvatarDocumentEditor::previewB | ( | int | index | ) | const |
◆ previewG()
| float eve::avatar_editor::AvatarDocumentEditor::previewG | ( | int | index | ) | const |
◆ previewH()
| float eve::avatar_editor::AvatarDocumentEditor::previewH | ( | int | index | ) | const |
◆ previewLayerCount()
|
inline |
Preview layer count.
在文件 AvatarDocumentEditor.h 第 95 行定义.
◆ previewName()
| std::string eve::avatar_editor::AvatarDocumentEditor::previewName | ( | int | index | ) | const |
◆ previewR()
| float eve::avatar_editor::AvatarDocumentEditor::previewR | ( | int | index | ) | const |
◆ previewRevision()
|
inlinenoexcept |
Preview revision.
在文件 AvatarDocumentEditor.h 第 73 行定义.
◆ previewW()
| float eve::avatar_editor::AvatarDocumentEditor::previewW | ( | int | index | ) | const |
◆ previewX()
| float eve::avatar_editor::AvatarDocumentEditor::previewX | ( | int | index | ) | const |
◆ previewY()
| float eve::avatar_editor::AvatarDocumentEditor::previewY | ( | int | index | ) | const |
◆ redo()
| avatar_editing::Result< editor::TransactionReceipt > eve::avatar_editor::AvatarDocumentEditor::redo | ( | ) |
◆ revision()
|
inlinenoexcept |
Revision.
在文件 AvatarDocumentEditor.h 第 71 行定义.
被这些函数引用 deleteSelectedLayer() , 以及 deleteSelectedParameter().
◆ selectedId()
|
inline |
Selected id.
在文件 AvatarDocumentEditor.h 第 77 行定义.
◆ selectedType()
|
inline |
Selected type.
在文件 AvatarDocumentEditor.h 第 79 行定义.
◆ selectExpression()
| avatar_editing::Result< void > eve::avatar_editor::AvatarDocumentEditor::selectExpression | ( | std::string | id | ) |
在文件 AvatarDocumentEditor.cpp 第 208 行定义.
引用了 eve::avatar_editing::AvatarDocumentTarget::expressions(), found , 以及 id.
被这些函数引用 createExpression() , 以及 deleteSelectedExpression().
◆ selectLayer()
| avatar_editing::Result< void > eve::avatar_editor::AvatarDocumentEditor::selectLayer | ( | std::string | id | ) |
在文件 AvatarDocumentEditor.cpp 第 179 行定义.
引用了 found, id, layer , 以及 eve::avatar_editing::AvatarDocumentTarget::layers().
被这些函数引用 createLayer(), deleteSelectedLayer() , 以及 pointerDown().
◆ selectParameter()
| avatar_editing::Result< void > eve::avatar_editor::AvatarDocumentEditor::selectParameter | ( | std::string | id | ) |
在文件 AvatarDocumentEditor.cpp 第 193 行定义.
引用了 found, id , 以及 eve::avatar_editing::AvatarDocumentTarget::parameters().
被这些函数引用 createParameter() , 以及 deleteSelectedParameter().
◆ setLayerVisible()
| avatar_editing::Result< void > eve::avatar_editor::AvatarDocumentEditor::setLayerVisible | ( | bool | visible | ) |
在文件 AvatarDocumentEditor.cpp 第 235 行定义.
引用了 eve::avatar_editing::AvatarDocumentTarget::makeSet() , 以及 visible.
◆ setLayerZ()
| avatar_editing::Result< void > eve::avatar_editor::AvatarDocumentEditor::setLayerZ | ( | int | zIndex | ) |
◆ setParameterValue()
| avatar_editing::Result< void > eve::avatar_editor::AvatarDocumentEditor::setParameterValue | ( | double | value | ) |
在文件 AvatarDocumentEditor.cpp 第 254 行定义.
引用了 eve::avatar_editing::AvatarDocumentTarget::makeSet() , 以及 value.
◆ target()
|
inlinenoexcept |
Borrow the authoritative avatar document.
在文件 AvatarDocumentEditor.h 第 41 行定义.
◆ undo()
| avatar_editing::Result< editor::TransactionReceipt > eve::avatar_editor::AvatarDocumentEditor::undo | ( | ) |
该类的文档由以下文件生成:
- src/modules/avatar/editor/AvatarDocumentEditor.h
- src/modules/avatar/editor/AvatarDocumentEditor.cpp