IBookmarkTypeTools

Provides convenience methods for interacting with Bookmarks.

Windows
MacOS
Linux

Inheritance Hierarchy

FNoncopyable

IBookmarkTypeTools

References

Module

UnrealEd

Header

/Engine/Source/Editor/UnrealEd/Public/Bookmarks/IBookmarkTypeTools.h

Include

#include "Bookmarks/IBookmarkTypeTools.h"

Syntax

class IBookmarkTypeTools : public FNoncopyable

Remarks

Provides convenience methods for interacting with Bookmarks.

Destructors

Name Description

Protected function Virtual

~IBookmarkTypeTools()

Functions

Name Description

Public function Const

const bool

 

CheckBookmark

(
    const uint32 InIndex,
    const FEditorViewportClient* I...
)

Checks to see if a bookmark exists at a given index

Public function Const

void

 

ClearAllBookmarks

(
    FEditorViewportClient* InViewp...
)

Clears all book marks

Public function Const

void

 

ClearBookmark

(
    const uint32 InIndex,
    FEditorViewportClient* InViewp...
)

Clears a bookmark from the list.

Public function Const

void

 

CompactBookmarks

(
    FEditorViewportClient* InViewp...
)

Compacts the available bookmarks into mapped spaces.

Public function Const

void

 

CreateOrSetBookmark

(
    const uint32 InIndex,
    FEditorViewportClient* InViewp...
)

Sets the specified bookmark based on the given viewport, allocating it if necessary.

Public function Static

IBookmarkTyp...

 

Get()

Public function Const

const TSubcl...

 

GetBookmarkClass

(
    const FEditorViewportClient* I...
)

Gets the currently configured Bookmark class.

Public function Const

const uint32

 

GetMaxNumberOfBookmarks

(
    const FEditorViewportClient* I...
)

Gets the current maximum number of bookmarks allowed.

Public function Const

void

 

JumpToBookmark

(
    const uint32 InIndex,
    const TSharedPtr< struct FBookmarkB...,
    FEditorViewportClient* InViewp...
)

Jumps to a bookmark from the list.

Public function

void

 

RegisterBookmarkTypeActions

(
    const TSharedRef< class IBookmarkTy...
)

Registers the given Bookmark Type Actions so they can be used by the editor.

Public function

void

 

UnregisterBookmarkTypeActions

(
    const TSharedRef< class IBookmarkTy...
)

Unregisters the given Bookmark Type Actions so they are no longer considered by the editor.

Public function Const

void

 

UpgradeBookmarks

(
    FEditorViewportClient* InViewp...,
    AWorldSettings* InWorldSetting...
)

Upgrades all bookmarks, ensuring they are of appropriate class. Note, this is currently not used.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss