Open 3D Engine AzToolsFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Attributes | List of all members
AzToolsFramework::LocalViewBookmarkLoader Class Referencefinal

class used to load/store local ViewBookmarks from project/user/Registry/ViewBookmarks. More...

#include <LocalViewBookmarkLoader.h>

Inherits AzToolsFramework::ViewBookmarkInterface, and AzToolsFramework::ViewBookmarkPersistInterface.

Public Member Functions

 AZ_CLASS_ALLOCATOR (LocalViewBookmarkLoader, AZ::SystemAllocator)
 
 AZ_RTTI (LocalViewBookmarkLoader, "{A64F2300-0958-4430-9EEA-1D457997E618}", ViewBookmarkInterface)
 
void RegisterViewBookmarkInterface ()
 
void UnregisterViewBookmarkInterface ()
 
bool SaveBookmarkAtIndex (const ViewBookmark &bookmark, int index) override
 
bool SaveLastKnownLocation (const ViewBookmark &bookmark) override
 
bool RemoveBookmarkAtIndex (int index) override
 
AZStd::optional< ViewBookmark > LoadBookmarkAtIndex (int index) override
 
AZStd::optional< ViewBookmark > LoadLastKnownLocation () override
 
void OverrideStreamWriteFn (StreamWriteFn streamWriteFn) override
 
void OverrideStreamReadFn (StreamReadFn streamReadFn) override
 
void OverrideFileExistsFn (FileExistsFn fileExistsFn) override
 
virtual bool SaveBookmarkAtIndex (const ViewBookmark &bookmark, int index)=0
 
virtual bool SaveLastKnownLocation (const ViewBookmark &bookmark)=0
 
virtual AZStd::optional< ViewBookmark > LoadBookmarkAtIndex (int index)=0
 
virtual AZStd::optional< ViewBookmark > LoadLastKnownLocation ()=0
 
virtual bool RemoveBookmarkAtIndex (int index)=0
 
virtual void OverrideStreamWriteFn (StreamWriteFn streamWriteFn)=0
 
virtual void OverrideStreamReadFn (StreamReadFn streamReadFn)=0
 
virtual void OverrideFileExistsFn (FileExistsFn fileExistsFn)=0
 

Static Public Attributes

static constexpr int DefaultViewBookmarkCount = 12
 

Additional Inherited Members

- Public Types inherited from AzToolsFramework::ViewBookmarkPersistInterface
using StreamWriteFn = AZStd::function< bool(const AZ::IO::PathView &localBookmarksFileName, AZStd::string_view stringBuffer, AZStd::function< bool(AZ::IO::GenericStream &genericStream, const AZStd::string &stringBuffer)>)>
 
using StreamReadFn = AZStd::function< AZStd::vector< char >(const AZ::IO::PathView &localBookmarksFileName)>
 
using FileExistsFn = AZStd::function< bool(const AZ::IO::PathView &localBookmarksFileName)>
 

Detailed Description

class used to load/store local ViewBookmarks from project/user/Registry/ViewBookmarks.

Member Function Documentation

◆ LoadBookmarkAtIndex()

AZStd::optional< ViewBookmark > AzToolsFramework::LocalViewBookmarkLoader::LoadBookmarkAtIndex ( int  index)
overridevirtual

Implements AzToolsFramework::ViewBookmarkInterface.

◆ LoadLastKnownLocation()

AZStd::optional< ViewBookmark > AzToolsFramework::LocalViewBookmarkLoader::LoadLastKnownLocation ( )
overridevirtual

Implements AzToolsFramework::ViewBookmarkInterface.

◆ OverrideFileExistsFn()

void AzToolsFramework::LocalViewBookmarkLoader::OverrideFileExistsFn ( FileExistsFn  fileExistsFn)
overridevirtual

Overrides the check for if the persistent View Bookmark Settings Registry exists or not.

Note
By default this will check for a file on disk.

Implements AzToolsFramework::ViewBookmarkPersistInterface.

◆ OverrideStreamReadFn()

void AzToolsFramework::LocalViewBookmarkLoader::OverrideStreamReadFn ( StreamReadFn  streamReadFn)
overridevirtual

Overrides the behavior of reading from a stream.

Note
By default this will read from a file on disk.

Implements AzToolsFramework::ViewBookmarkPersistInterface.

◆ OverrideStreamWriteFn()

void AzToolsFramework::LocalViewBookmarkLoader::OverrideStreamWriteFn ( StreamWriteFn  streamWriteFn)
overridevirtual

Overrides the behavior of writing to a stream.

Note
By default this will write to a file on disk.

Implements AzToolsFramework::ViewBookmarkPersistInterface.

◆ RemoveBookmarkAtIndex()

bool AzToolsFramework::LocalViewBookmarkLoader::RemoveBookmarkAtIndex ( int  index)
overridevirtual

Implements AzToolsFramework::ViewBookmarkInterface.

◆ SaveBookmarkAtIndex()

bool AzToolsFramework::LocalViewBookmarkLoader::SaveBookmarkAtIndex ( const ViewBookmark &  bookmark,
int  index 
)
overridevirtual

Implements AzToolsFramework::ViewBookmarkInterface.

◆ SaveLastKnownLocation()

bool AzToolsFramework::LocalViewBookmarkLoader::SaveLastKnownLocation ( const ViewBookmark &  bookmark)
overridevirtual

Implements AzToolsFramework::ViewBookmarkInterface.

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