Navigation
API > API/Editor > API/Editor/UnrealEd
Provides convenience methods for interacting with Bookmarks.
| Name | IBookmarkTypeTools |
| Type | class |
| Header File | /Engine/Source/Editor/UnrealEd/Public/Bookmarks/IBookmarkTypeTools.h |
| Include Path | #include "Bookmarks/IBookmarkTypeTools.h" |
Syntax
class IBookmarkTypeTools : public FNoncopyable
Inheritance Hierarchy
- FNoncopyable → IBookmarkTypeTools
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IBookmarkTypeTools() |
Bookmarks/IBookmarkTypeTools.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const bool CheckBookmark
(
const uint32 InIndex, |
Checks to see if a bookmark exists at a given index | Bookmarks/IBookmarkTypeTools.h | |
void ClearAllBookmarks
(
FEditorViewportClient* InViewportClient |
Clears all book marks | Bookmarks/IBookmarkTypeTools.h | |
void ClearBookmark
(
const uint32 InIndex, |
Clears a bookmark from the list. | Bookmarks/IBookmarkTypeTools.h | |
void CompactBookmarks
(
FEditorViewportClient* InViewportClient |
Compacts the available bookmarks into mapped spaces. | Bookmarks/IBookmarkTypeTools.h | |
void CreateOrSetBookmark
(
const uint32 InIndex, |
Sets the specified bookmark based on the given viewport, allocating it if necessary. | Bookmarks/IBookmarkTypeTools.h | |
const TSubclassOf< class UBookmarkBase > GetBookmarkClass
(
const FEditorViewportClient* InViewportClient |
Gets the currently configured Bookmark class. | Bookmarks/IBookmarkTypeTools.h | |
const uint32 GetMaxNumberOfBookmarks
(
const FEditorViewportClient* InViewportClient |
Gets the current maximum number of bookmarks allowed. | Bookmarks/IBookmarkTypeTools.h | |
void JumpToBookmark
(
const uint32 InIndex, |
Jumps to a bookmark from the list. | Bookmarks/IBookmarkTypeTools.h | |
void RegisterBookmarkTypeActions
(
const TSharedRef< class IBookmarkTypeActions >& InActions |
Registers the given Bookmark Type Actions so they can be used by the editor. | Bookmarks/IBookmarkTypeTools.h | |
void UnregisterBookmarkTypeActions
(
const TSharedRef< class IBookmarkTypeActions >& InActions |
Unregisters the given Bookmark Type Actions so they are no longer considered by the editor. | Bookmarks/IBookmarkTypeTools.h | |
void UpgradeBookmarks
(
FEditorViewportClient* InViewportClient, |
Upgrades all bookmarks, ensuring they are of appropriate class. Note, this is currently not used. | Bookmarks/IBookmarkTypeTools.h |
Protected
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IBookmarkTypeTools & Get() |
Bookmarks/IBookmarkTypeTools.h |