UFtsViewBookmarkFunctionLibrary Class Reference

Function library to work with bookmark data. More...

#include <FtsViewBookmarkFunctionLibrary.h>

Inheritance diagram for UFtsViewBookmarkFunctionLibrary:

Static Public Member Functions
static bool	GetBookmarkFromClipboard (FFtsViewBookmark &OutBookmark)
	Reads the contents of the clipboard and converts the json string to a bookmark.
static void	CopyBookmarkToClipboard (const FFtsViewBookmark &Bookmark)
	Converts a bookmark into condensed json and saves it in the clipboard.
static bool	CreateBookmarkFromCameraView (UCameraComponent *Camera, FFtsViewBookmark &OutBookmark)
	Takes a camera component and saves its transform and the current level into a bookmark.
static bool	WriteBookmarkToJson (const FFtsViewBookmark &Bookmark, FString &OutJsonString)
	Converts bookmark data into a condensed json string.
static bool	ReadBookmarkFromJson (const FString &JsonString, FFtsViewBookmark &OutBookmark)
	Takes a json string and reads data into a bookmark.
static bool	GetBookmarkMetaDataEntry (UPARAM(Ref) const FFtsViewBookmark &Bookmark, const FString &Key, FString &OutValue)
	Gets the value that fits the key for a bookmarks meta data if it exists.
static void	SetBookmarkMetaDataEntry (UPARAM(Ref) FFtsViewBookmark &Bookmark, const FString &Key, const FString &Value)
	Sets a new value to a given key for the bookmarks meta data.
static void	DeleteBookmarkMetaDataEntry (UPARAM(Ref) FFtsViewBookmark &Bookmark, const FString &Key)
	Deletes a value from the bookmarks meta data.

Detailed Description

Function library to work with bookmark data.

Member Function Documentation

CopyBookmarkToClipboard()

void UFtsViewBookmarkFunctionLibrary::CopyBookmarkToClipboard ( const FFtsViewBookmark & Bookmark )

static

Converts a bookmark into condensed json and saves it in the clipboard.

Parameters

Bookmark

Bookmark to write into clipboard

CreateBookmarkFromCameraView()

bool UFtsViewBookmarkFunctionLibrary::CreateBookmarkFromCameraView ( UCameraComponent * Camera, FFtsViewBookmark & OutBookmark )

static

Takes a camera component and saves its transform and the current level into a bookmark.

Parameters

Camera	Camera to capture view from
OutBookmark	Resulting bookmark data

Returns

True if bookmark was created

DeleteBookmarkMetaDataEntry()

void UFtsViewBookmarkFunctionLibrary::DeleteBookmarkMetaDataEntry ( UPARAM(Ref) FFtsViewBookmark & Bookmark, const FString & Key )

static

Deletes a value from the bookmarks meta data.

Parameters

Bookmark	Bookmark to modify
Key	Key of value to delete from data

GetBookmarkFromClipboard()

bool UFtsViewBookmarkFunctionLibrary::GetBookmarkFromClipboard ( FFtsViewBookmark & OutBookmark )

static

Reads the contents of the clipboard and converts the json string to a bookmark.

Parameters

OutBookmark

Bookmark read from clipboard

Returns

True if clipboard contents could be converted to a bookmark

GetBookmarkMetaDataEntry()

bool UFtsViewBookmarkFunctionLibrary::GetBookmarkMetaDataEntry ( UPARAM(Ref) const FFtsViewBookmark & Bookmark, const FString & Key, FString & OutValue )

static

Gets the value that fits the key for a bookmarks meta data if it exists.

Parameters

Bookmark	Bookmark reference to get meta data from
Key	Key to get value for
OutValue	Meta data value

Returns

True if bookmark has data for the given key

ReadBookmarkFromJson()

bool UFtsViewBookmarkFunctionLibrary::ReadBookmarkFromJson ( const FString & JsonString, FFtsViewBookmark & OutBookmark )

static

Takes a json string and reads data into a bookmark.

Parameters

JsonString	Json data to parse
OutBookmark	Resulting bookmark data

Returns

True if conversion was a success

SetBookmarkMetaDataEntry()

void UFtsViewBookmarkFunctionLibrary::SetBookmarkMetaDataEntry ( UPARAM(Ref) FFtsViewBookmark & Bookmark, const FString & Key, const FString & Value )

static

Sets a new value to a given key for the bookmarks meta data.

Parameters

Bookmark	Bookmark reference to write to
Key	Meta data key to set
Value	Value to set for key

WriteBookmarkToJson()

bool UFtsViewBookmarkFunctionLibrary::WriteBookmarkToJson ( const FFtsViewBookmark & Bookmark, FString & OutJsonString )

static

Converts bookmark data into a condensed json string.

Parameters

Bookmark	Bookmark to serialize
OutJsonString	Data converted into json string

Returns

True if conversion was a success

---

The documentation for this class was generated from the following files:

• Plugins/FtsViewBookmarks/Source/FtsViewBookmarks/Public/FtsViewBookmarkFunctionLibrary.h
• Plugins/FtsViewBookmarks/Source/FtsViewBookmarks/Private/FtsViewBookmarkFunctionLibrary.cpp