IEditableTarget public API. 更多...
#include <EditableTarget.h>
Public 成员函数 | |
| virtual | ~IEditableTarget ()=default |
| Releases IEditableTarget resources. | |
| virtual TargetId | targetId () const =0 |
| Target id. | |
| virtual std::uint64_t | revision () const =0 |
| Revision. | |
| virtual EditRegion | dirtyRegion () const =0 |
| Dirty region. | |
| virtual void | clearDirtyRegion ()=0 |
| Clears dirty region. | |
| virtual TargetDescriptor | describe () const |
| Describe the target for tools and automation. | |
| virtual void * | queryCapability (const CapabilityId &capability) |
| Query an optional stable capability. | |
| template<class C > | |
| eve::OptionalRef< C > | capability () |
| Query a capability through its interface-owned stable identity. | |
| template<class C > | |
| eve::OptionalRef< const C > | capability () const |
| Capability. | |
| template<class C > | |
| C * | query () |
| Queries query. | |
| template<class C > | |
| const C * | query () const |
| Queries query. | |
详细描述
IEditableTarget public API.
在文件 EditableTarget.h 第 48 行定义.
构造及析构函数说明
◆ ~IEditableTarget()
|
virtualdefault |
Releases IEditableTarget resources.
成员函数说明
◆ capability() [1/2]
|
inline |
Query a capability through its interface-owned stable identity.
- 模板参数
-
C Capability interface declaring static editingCapabilityId().
- 返回
- Borrowed typed capability, or empty when unsupported. @lifetime Valid until this target is destroyed or the capability is explicitly invalidated.
Capability.
Constexpr.
Constexpr.
在文件 EditableTarget.h 第 82 行定义.
引用了 queryCapability().
被这些函数引用 eve::editor::PluginPermissionTarget::decision(), eve::editor::EditorTargetCoordinator::inspect(), queryCapability(), eve::editor::ActionTimelineTarget::queryCapability(), eve::animation_editing::AnimationClipDocumentTarget::queryCapability(), eve::archspace_editing::ArchSpaceDocumentTarget::queryCapability(), eve::audio_editing::AudioEffectChainTarget::queryCapability(), eve::audio_editing::AudioSourceTarget::queryCapability(), eve::audio_editing::AudioSourcePublishingTarget::queryCapability(), eve::audio_editing::AudioMixerTarget::queryCapability(), eve::building_editing::BuildingPlacementTarget::queryCapability(), eve::camera_editing::CameraDocumentTarget::queryCapability(), eve::crowd_editing::CrowdDocumentTarget::queryCapability(), eve::editor::EditorCurveDocument::queryCapability(), eve::editor::PluginPermissionTarget::queryCapability(), eve::editor::ProjectSettingsTarget::queryCapability(), eve::fluids_editing::FluidSimulationTarget::queryCapability(), eve::fluids_editing::VolumeFluidTarget::queryCapability(), eve::lighting_editing::LightingPropertyTargetBase::queryCapability(), eve::material_editing::MaterialBatchTarget::queryCapability(), eve::material_editing::MaterialDocumentTarget::queryCapability(), eve::material_editing::MaterialPublishingTarget::queryCapability(), eve::map_editing::MapDocumentTarget::queryCapability(), eve::physics_editing::PhysicsColliderTarget::queryCapability(), eve::physics_editing::PhysicsJointTarget::queryCapability(), eve::procgen_editing::SplinePathDocument::queryCapability(), eve::scene_editing::SceneTargetBase::queryCapability(), eve::scene_editing::SceneHostEditorTarget::queryCapability(), eve::social_editing::SocialDocumentTarget::queryCapability(), eve::stylize_editing::MeshVfxAssetTarget::queryCapability(), eve::ui_editing::UiDocumentTarget::queryCapability(), eve::ui_editing::UiThemeCatalogTarget::queryCapability(), eve::procgen_editing::ProcgenScriptDocumentTarget::queryCapability(), eve::procgen_editing::RoadNetworkEditTarget::queryCapability() , 以及 eve::voxel_editing::VoxelWorldTarget::queryCapability().
◆ capability() [2/2]
|
inline |
◆ clearDirtyRegion()
|
pure virtual |
Clears dirty region.
在 eve::editor::ActionTimelineTarget, eve::audio_editing::AudioSourcePublishingTarget, eve::decal_editing::DecalPublishingTarget, eve::editing::EditableTargetState, eve::input_editing::InputMapTarget, eve::graphics_editing::VegetationFieldTarget, eve::lighting_editing::SnowFieldTarget, eve::material_editing::MaterialPublishingTarget, eve::map_editing::TileLayerTarget, eve::physics_editing::PhysicsColliderPublishingTarget, eve::procgen_editing::HeightmapTarget, eve::procgen_editing::ProcgenScriptDocumentTarget, eve::procgen_editing::RoadNetworkEditTarget , 以及 eve::voxel_editing::VoxelWorldTarget 内被实现.
被这些函数引用 eve::avatar_editing::AvatarDocumentTarget::loadSnapshot(), eve::hd2d_editing::Hd2dDocumentTarget::loadSnapshot(), eve::biome_editing::BiomeDocumentTarget::loadSnapshot(), eve::procgen_editing::TextureRecipeTarget::loadSnapshot(), eve::sceneloader_editing::SceneImportTarget::loadSnapshot(), eve::voxel_editing::VoxelCatalogTarget::loadSnapshot(), eve::voxel_editing::VoxelPaletteTarget::loadSnapshot(), eve::archspace_editing::ArchSpaceDocumentTarget::loadSnapshot(), eve::audio_editing::AudioSourceTarget::loadSnapshot(), eve::audio_editing::AudioMixerTarget::loadSnapshot(), eve::camera_editing::CameraDocumentTarget::loadSnapshot(), eve::decal_editing::DecalDocumentTarget::loadSnapshot(), eve::fluids_editing::FluidSimulationTarget::loadSnapshot(), eve::fluids_editing::SurfaceFluidTarget::loadSnapshot(), eve::fluids_editing::VolumeFluidTarget::loadSnapshot(), eve::lighting_editing::LightingPropertyTargetBase::loadSnapshot(), eve::material_editing::MaterialDocumentTarget::loadSnapshot(), eve::map_editing::MapDocumentTarget::loadSnapshot(), eve::physics_editing::PhysicsColliderTarget::loadSnapshot(), eve::housegen_editing::HouseGenDocumentTarget::loadSnapshot(), eve::spritestack_editing::SpriteStackDocumentTarget::loadSnapshot(), eve::stylize_editing::MeshVfxAssetTarget::loadSnapshot(), eve::stylize_editing::StylizeRecipeTarget::loadSnapshot(), eve::ui_editing::UiDocumentTarget::loadSnapshot(), eve::ui_editing::UiThemeCatalogTarget::loadSnapshot(), eve::virtualgeometry_editing::VirtualGeometryDocumentTarget::loadSnapshot() , 以及 eve::scene_editing::SceneHostEditorTarget::SceneHostEditorTarget().
◆ describe()
|
inlinevirtual |
Describe the target for tools and automation.
被 eve::editor::ActionTimelineTarget, eve::animation_editing::AnimationClipDocumentTarget, eve::archspace_editing::ArchSpaceDocumentTarget, eve::audio_editing::AudioEffectChainTarget, eve::audio_editing::AudioSourceTarget, eve::audio_editing::AudioSourcePublishingTarget, eve::audio_editing::AudioMixerTarget, eve::avatar_editing::AvatarDocumentTarget, eve::building_editing::BuildingPlacementTarget, eve::camera_editing::CameraDocumentTarget, eve::crowd_editing::CrowdDocumentTarget, eve::decal_editing::DecalDocumentTarget, eve::definitions_editing::DefinitionDocument, eve::editor::EditorCurveDocument, eve::editor::PluginPermissionTarget, eve::editor::ProjectSettingsTarget, eve::input_editing::InputMapTarget, eve::fluids_editing::FluidSimulationTarget, eve::fluids_editing::SurfaceFluidTarget, eve::fluids_editing::VolumeFluidTarget, eve::gpuagents_editing::GpuAgentsDocumentTarget, eve::graphics_editing::VegetationFieldTarget, eve::lighting_editing::LightingPropertyTargetBase, eve::material_editing::MaterialBatchTarget, eve::material_editing::MaterialDocumentTarget, eve::material_editing::MaterialPublishingTarget, eve::hd2d_editing::Hd2dDocumentTarget, eve::map_editing::MapDocumentTarget, eve::physics_editing::PhysicsColliderTarget, eve::physics_editing::PhysicsJointTarget, eve::biome_editing::BiomeDocumentTarget, eve::housegen_editing::HouseGenDocumentTarget, eve::procgen_editing::ProcgenScriptDocumentTarget, eve::procgen_editing::RoadNetworkEditTarget, eve::procgen_editing::SplinePathDocument, eve::procgen_editing::TextureRecipeTarget, eve::scene_editing::SceneTargetBase, eve::sceneloader_editing::SceneImportTarget, eve::social_editing::SocialDocumentTarget, eve::spritestack_editing::SpriteStackDocumentTarget, eve::stylize_editing::MeshVfxAssetTarget, eve::stylize_editing::StylizeRecipeTarget, eve::ui_editing::UiDocumentTarget, eve::ui_editing::UiThemeCatalogTarget, eve::virtualgeometry_editing::VirtualGeometryDocumentTarget, eve::voxel_editing::VoxelCatalogTarget, eve::voxel_editing::VoxelPaletteTarget , 以及 eve::voxel_editing::VoxelWorldTarget 重载.
在文件 EditableTarget.h 第 61 行定义.
引用了 revision() , 以及 targetId().
◆ dirtyRegion()
|
pure virtual |
Dirty region.
在 eve::editor::ActionTimelineTarget, eve::audio_editing::AudioSourcePublishingTarget, eve::decal_editing::DecalPublishingTarget, eve::editing::EditableTargetState, eve::input_editing::InputMapTarget, eve::graphics_editing::VegetationFieldTarget, eve::lighting_editing::SnowFieldTarget, eve::material_editing::MaterialPublishingTarget, eve::map_editing::TileLayerTarget, eve::physics_editing::PhysicsColliderPublishingTarget, eve::procgen_editing::HeightmapTarget, eve::procgen_editing::ProcgenScriptDocumentTarget, eve::procgen_editing::RoadNetworkEditTarget , 以及 eve::voxel_editing::VoxelWorldTarget 内被实现.
◆ query() [1/2]
|
inline |
Queries query.
在文件 EditableTarget.h 第 105 行定义.
被这些函数引用 eve::editor::IntFieldEditCommand::apply(), eve::editor::ScalarFieldEditCommand::apply(), eve::editor::IntVolumeEditCommand::apply(), eve::editor::ScalarFieldEditCommand::record(), eve::editor::IntFieldEditCommand::record(), eve::editor::IntVolumeEditCommand::record(), eve::editor::IntFieldEditCommand::revert(), eve::editor::ScalarFieldEditCommand::revert() , 以及 eve::editor::IntVolumeEditCommand::revert().
◆ query() [2/2]
|
inline |
Queries query.
在文件 EditableTarget.h 第 111 行定义.
◆ queryCapability()
|
inlinevirtual |
Query an optional stable capability.
- 参数
-
capability Stable capability identifier.
- 返回
- Borrowed pointer owned by this target, or null when unsupported. @lifetime Valid until this target is destroyed or the capability is explicitly invalidated.
被 eve::avatar_editing::AvatarDocumentTarget, eve::definitions_editing::DefinitionDocument, eve::input_editing::InputMapTarget, eve::hd2d_editing::Hd2dDocumentTarget, eve::biome_editing::BiomeDocumentTarget, eve::procgen_editing::TextureRecipeTarget, eve::sceneloader_editing::SceneImportTarget, eve::voxel_editing::VoxelCatalogTarget, eve::voxel_editing::VoxelPaletteTarget, eve::editor::ActionTimelineTarget, eve::archspace_editing::ArchSpaceDocumentTarget, eve::building_editing::BuildingPlacementTarget, eve::camera_editing::CameraDocumentTarget, eve::crowd_editing::CrowdDocumentTarget, eve::editor::EditorCurveDocument, eve::editor::PluginPermissionTarget, eve::editor::ProjectSettingsTarget, eve::fluids_editing::FluidSimulationTarget, eve::fluids_editing::SurfaceFluidTarget, eve::fluids_editing::VolumeFluidTarget, eve::gpuagents_editing::GpuAgentsDocumentTarget, eve::lighting_editing::LightingPropertyTargetBase, eve::housegen_editing::HouseGenDocumentTarget, eve::procgen_editing::SplinePathDocument, eve::social_editing::SocialDocumentTarget, eve::virtualgeometry_editing::VirtualGeometryDocumentTarget, eve::procgen_editing::ProcgenScriptDocumentTarget, eve::graphics_editing::VegetationFieldTarget, eve::procgen_editing::RoadNetworkEditTarget , 以及 eve::voxel_editing::VoxelWorldTarget 重载.
在文件 EditableTarget.h 第 70 行定义.
引用了 capability().
被这些函数引用 capability().
◆ revision()
|
pure virtual |
Revision.
在 eve::editor::ActionTimelineTarget, eve::audio_editing::AudioSourcePublishingTarget, eve::decal_editing::DecalPublishingTarget, eve::editing::EditableTargetState, eve::input_editing::InputMapTarget, eve::graphics_editing::VegetationFieldTarget, eve::lighting_editing::SnowFieldTarget, eve::material_editing::MaterialPublishingTarget, eve::map_editing::TileLayerTarget, eve::physics_editing::PhysicsColliderPublishingTarget, eve::procgen_editing::HeightmapTarget, eve::procgen_editing::ProcgenScriptDocumentTarget, eve::procgen_editing::RoadNetworkEditTarget , 以及 eve::voxel_editing::VoxelWorldTarget 内被实现.
被这些函数引用 eve::scene_editing::SceneComponentPropertyBindings::bind(), eve::editing::LocalWorldAuthority::commit(), eve::editing::LocalWorldAuthority::compensate(), describe(), eve::editor::EditorTargetCoordinator::Impl::execute() , 以及 eve::editing::LocalWorldAuthority::preflight().
◆ targetId()
|
pure virtual |
Target id.
在 eve::editor::ActionTimelineTarget, eve::animation_editing::AnimationClipDocumentTarget, eve::archspace_editing::ArchSpaceDocumentTarget, eve::audio_editing::AudioEffectChainTarget, eve::audio_editing::AudioSourceTarget, eve::audio_editing::AudioSourcePublishingTarget, eve::audio_editing::AudioMixerTarget, eve::avatar_editing::AvatarDocumentTarget, eve::building_editing::BuildingPlacementTarget, eve::camera_editing::CameraDocumentTarget, eve::crowd_editing::CrowdDocumentTarget, eve::decal_editing::DecalDocumentTarget, eve::decal_editing::DecalPublishingTarget, eve::definitions_editing::DefinitionDocument, eve::editor::EditorCurveDocument, eve::editor::PluginPermissionTarget, eve::editor::ProjectSettingsTarget, eve::input_editing::InputMapTarget, eve::fluids_editing::FluidSimulationTarget, eve::fluids_editing::SurfaceFluidTarget, eve::fluids_editing::VolumeFluidTarget, eve::gpuagents_editing::GpuAgentsDocumentTarget, eve::graphics_editing::VegetationFieldTarget, eve::lighting_editing::LightingPropertyTargetBase, eve::lighting_editing::SnowFieldTarget, eve::material_editing::MaterialBatchTarget, eve::material_editing::MaterialDocumentTarget, eve::material_editing::MaterialPublishingTarget, eve::hd2d_editing::Hd2dDocumentTarget, eve::map_editing::MapDocumentTarget, eve::map_editing::TileLayerTarget, eve::level_editing::TileBufferTarget, eve::physics_editing::PhysicsColliderTarget, eve::physics_editing::PhysicsColliderPublishingTarget, eve::physics_editing::PhysicsJointTarget, eve::biome_editing::BiomeDocumentTarget, eve::procgen_editing::HeightmapTarget, eve::housegen_editing::HouseGenDocumentTarget, eve::procgen_editing::ProcgenScriptDocumentTarget, eve::procgen_editing::RoadNetworkEditTarget, eve::procgen_editing::SplinePathDocument, eve::procgen_editing::TextureRecipeTarget, eve::scene_editing::SceneTargetBase, eve::sceneloader_editing::SceneImportTarget, eve::social_editing::SocialDocumentTarget, eve::spritestack_editing::SpriteStackDocumentTarget, eve::stylize_editing::MeshVfxAssetTarget, eve::stylize_editing::StylizeRecipeTarget, eve::ui_editing::UiDocumentTarget, eve::ui_editing::UiThemeCatalogTarget, eve::virtualgeometry_editing::VirtualGeometryDocumentTarget, eve::voxel_editing::VoxelCatalogTarget, eve::voxel_editing::VoxelPaletteTarget , 以及 eve::voxel_editing::VoxelWorldTarget 内被实现.
被这些函数引用 eve::scene_editing::SceneComponentPropertyBindings::bind(), eve::editor::EditorSession::bindTarget(), eve::editing::LocalWorldAuthority::compensate(), describe() , 以及 eve::editing::LocalWorldAuthority::preflight().
该类的文档由以下文件生成:
- src/modules/editing/EditableTarget.h