FQueryContextForwarder

Because this is a thin wrapper called from within a query callback, it's better to inline fully so all function pre/postambles can be optimized away.

API > API/Runtime > API/Runtime/TypedElementFramework

Because this is a thin wrapper called from within a query callback, it's better to inline fully so all function pre/postambles can be optimized away.

   
Name FQueryContextForwarder
Type struct
Header File /Engine/Source/Runtime/TypedElementFramework/Public/Elements/Framework/TypedElementQueryBuilder.h
Include Path #include "Elements/Framework/TypedElementQueryBuilder.h"

Syntax

struct FQueryContextForwarder : public UE::Editor::DataStorage::IQueryContext

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FQueryContextForwarder ( const FQueryDescription& InDescription,
IQueryContext& InParentContext
)

 FQueryContextForwarder Elements/Framework/TypedElementQueryBuilder.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FQueryContextForwarder()

   Elements/Framework/TypedElementQueryBuilder.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Description const FQueryDescription &   Elements/Framework/TypedElementQueryBuilder.h  
ParentContext IQueryContext &   Elements/Framework/TypedElementQueryBuilder.h  

Functions

Public

Public Virtual

Overridden from IQueryContext

Name Remarks Include Path Unreal Specifiers

virtual void GetDependencies ( TArrayView< UObject* > RetrievedAddresses,
TConstArrayView< TWeakObjectPtr< const UClass > > DependencyTypes,
TConstArrayView< EQueryAccessType > AccessTypes
)

 Returns a list of dependencies or nullptrs if a dependency wasn't found. Elements/Framework/TypedElementQueryBuilder.h  

virtual const UObject * GetDependency ( const UClass* DependencyClass
)

 Returns an immutable instance of the requested dependency or a nullptr if not found. Elements/Framework/TypedElementQueryBuilder.h  

virtual UObject * GetMutableDependency ( const UClass* DependencyClass
)

 Returns a mutable instance of the requested dependency or a nullptr if not found. Elements/Framework/TypedElementQueryBuilder.h  

virtual FQueryResult RunQuery ( QueryHandle Query
)

 Runs a previously created query. Elements/Framework/TypedElementQueryBuilder.h  

virtual FQueryResult RunSubquery ( int32 SubqueryIndex,
SubqueryCallbackRef Callback
)

 Runs the provided callback on a subquery registered with the current query. Elements/Framework/TypedElementQueryBuilder.h  

virtual FQueryResult RunSubquery ( int32 SubqueryIndex
)

 Runs a subquery registered with the current query. Elements/Framework/TypedElementQueryBuilder.h  

virtual FQueryResult RunSubquery ( int32 SubqueryIndex,
RowHandle Row,
SubqueryCallbackRef Callback
)

 Runs the provided callback on a subquery registered with the current query for the exact provided row. Elements/Framework/TypedElementQueryBuilder.h  

Overridden from ICommonQueryWithEnvironmentContext

Name Remarks Include Path Unreal Specifiers

virtual void AddColumns ( TConstArrayView< RowHandle > Rows,
TConstArrayView< const UScriptStruct* > ColumnTypes
)

 Adds new empty columns to the listed rows of the provided type. Elements/Framework/TypedElementQueryBuilder.h  

virtual void AddColumns ( RowHandle Row,
TConstArrayView< const UScriptStruct* > ColumnTypes
)

 Adds new empty columns to a row of the provided type. Elements/Framework/TypedElementQueryBuilder.h  

virtual void RemoveColumns ( RowHandle Row,
TConstArrayView< const UScriptStruct* > ColumnTypes
)

 Removes columns of the provided types from a row. Elements/Framework/TypedElementQueryBuilder.h  

virtual void RemoveColumns ( TConstArrayView< RowHandle > Rows,
TConstArrayView< const UScriptStruct* > ColumnTypes
)

 Removes columns of the provided types from the listed rows. Elements/Framework/TypedElementQueryBuilder.h  

virtual void RemoveRow ( RowHandle Row
)

 Removes the row with the provided row handle. Elements/Framework/TypedElementQueryBuilder.h  

virtual void RemoveRows ( TConstArrayView< RowHandle > Rows
)

 Removes rows with the provided row handles. Elements/Framework/TypedElementQueryBuilder.h  

Overridden from ICommonQueryContext

Name Remarks Include Path Unreal Specifiers

virtual const void * GetColumn ( const UScriptStruct* ColumnType
) const

 Return the address of a immutable column matching the requested type or a nullptr if not found. Elements/Framework/TypedElementQueryBuilder.h  

virtual void GetColumns ( TArrayView< char* > RetrievedAddresses,
TConstArrayView< TWeakObjectPtr< const UScriptStruct > > ColumnTypes,
TConstArrayView< EQueryAccessType > AccessTypes
)

 Get a list of columns or nullptrs if the column type wasn't found. Elements/Framework/TypedElementQueryBuilder.h  

virtual void GetColumnsUnguarded ( int32 TypeCount,
char** RetrievedAddresses,
const TWeakObjectPtr< const UScriptStruct >* ColumnTypes,
const EQueryAccessType* AccessTypes
)

 Get a list of columns or nullptrs if the column type wasn't found. Elements/Framework/TypedElementQueryBuilder.h  

virtual void * GetMutableColumn ( const UScriptStruct* ColumnType
)

 Return the address of a mutable column matching the requested type or a nullptr if not found. Elements/Framework/TypedElementQueryBuilder.h  

virtual uint32 GetRowCount()

 Returns the number rows in the batch. Elements/Framework/TypedElementQueryBuilder.h  

virtual TConstArrayView< RowHandle > GetRowHandles ()

 Returns an immutable view that contains the row handles for all returned results. Elements/Framework/TypedElementQueryBuilder.h  

virtual bool HasColumn ( const UScriptStruct* ColumnType
) const

 Returns whether a column matches the requested type or not. Elements/Framework/TypedElementQueryBuilder.h  

virtual void PushCommand ( void(*)(void*) CommandFunction,
void* CommandData
)

   Elements/Framework/TypedElementQueryBuilder.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page