Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
A context object store allows tools to get access to arbitrary objects which expose data or APIs to enable additional functionality. Some example use cases of context objects:
- A tool builder may disallow a particular tool if a needed API object is not present in the context store.
- A tool may allow extra actions if it has access to a particular API object in the context store.
- A tool may choose to initialize itself differently based on the presence of a selection-holding data object in the context store.
| Name | UContextObjectStore |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/ContextObjectStore.h |
| Include Path | #include "ContextObjectStore.h" |
Syntax
UCLASS (Transient, MinimalAPI)
class UContextObjectStore : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UContextObjectStore
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddContextObject
(
UObject* InContextObject |
Adds a data object to the tool manager's set of shared data objects. | ContextObjectStore.h | |
TObjectType * FindContext() |
Finds the first the context object of the given type. Can return a subclass of the given type. | ContextObjectStore.h | |
| Finds the first context object that derives from the given class. | ContextObjectStore.h | ||
bool RemoveContextObject
(
UObject* InContextObject |
Removes a data object from the tool manager's set of shared data objects. | ContextObjectStore.h | |
bool RemoveContextObjectsOfType () |
ContextObjectStore.h | ||
bool RemoveContextObjectsOfType
(
const UClass* InClass |
Removes any data objects from the tool manager's set of shared data objects that are of type | ContextObjectStore.h | |
void Shutdown() |
Shuts down the context object store, releasing hold on any stored content objects. | ContextObjectStore.h |