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.
AzToolsFramework::SharedViewBookmarkComponent Class Reference

component that stores a vector of View bookmarks stored in the prefab. so they can be shared in version control easily. More...

#include <SharedViewBookmarkComponent.h>

Inherits AzToolsFramework::Components::EditorComponentBase.

Public Member Functions

 AZ_EDITOR_COMPONENT (SharedViewBookmarkComponent, ViewBookmarkComponentTypeId, EditorComponentBase)
 
AZStd::optional< ViewBookmarkGetBookmarkAtIndex (int index) const
 
void AddBookmark (ViewBookmark viewBookmark)
 
bool RemoveBookmarkAtIndex (int index)
 
bool ModifyBookmarkAtIndex (int index, const ViewBookmark &newBookmark)
 
- Public Member Functions inherited from AzToolsFramework::Components::EditorComponentBase
 AZ_RTTI (EditorComponentBase, "{D5346BD4-7F20-444E-B370-327ACD03D4A0}", AZ::Component)
 
 EditorComponentBase ()
 
void SetDirty ()
 
virtual void Init () override
 
virtual void Activate () override
 
virtual void Deactivate () override
 
void OnAfterEntitySet () override final
 
void SetSerializedIdentifier (AZStd::string serializedIdentifier) override final
 
AZStd::string GetSerializedIdentifier () const override final
 
AZ::TransformInterface * GetTransform () const
 
AZ::Transform GetWorldTM () const
 
AZ::Transform GetLocalTM () const
 
bool IsSelected () const
 
virtual void BuildGameEntity (AZ::Entity *)
 
virtual void SetPrimaryAsset (const AZ::Data::AssetId &)
 
virtual void AddContextMenuActions (QMenu *)
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from AzToolsFramework::Components::EditorComponentBase
static void Reflect (AZ::ReflectContext *context)
 

Static Public Attributes

static constexpr AZ::TypeId ViewBookmarkComponentTypeId { "{6959832F-9382-4C7D-83AC-380DA9F138DE}" }
 

Static Protected Member Functions

static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &services)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &services)
 

Detailed Description

component that stores a vector of View bookmarks stored in the prefab. so they can be shared in version control easily.


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