Navigation
API > API/Plugins > API/Plugins/OptimusCore
| Name | UOptimusComponentSource |
| Type | class |
| Header File | /Engine/Plugins/Animation/DeformerGraph/Source/OptimusCore/Public/OptimusComponentSource.h |
| Include Path | #include "OptimusComponentSource.h" |
Syntax
UCLASS (MinimalAPI, Abstract)
class UOptimusComponentSource : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UOptimusComponentSource
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FName GetBindingName() |
Returns a suggested name for the binding. The name may be modified to preserve uniqueness. | OptimusComponentSource.h | |
virtual TSubclassOf< UActorComponent > GetComponentClass() |
Returns the actor component that this provider can operate on | OptimusComponentSource.h | |
| For a given execution domain, and component LOD index, return the range of the domain as given by the component that is associated with this source. | OptimusComponentSource.h | ||
virtual uint32 GetDefaultNumInvocations
(
const UActorComponent* InComponent, |
Returns the total number of thread invocations a component requires in case of non-unified dispatch. | OptimusComponentSource.h | |
virtual FText GetDisplayName() |
Returns the component display name to show in the lister. Should be unique. | OptimusComponentSource.h | |
virtual TArray< FName > GetExecutionDomains () |
Returns the available execution contexts. | OptimusComponentSource.h | |
virtual int32 GetLodIndex
(
const UActorComponent* InComponent |
Returns the current LOD index associated with a component associated with this source. | OptimusComponentSource.h | |
virtual bool IsUsableAsPrimarySource() |
Returns true if the source can be used by primary bindings. | OptimusComponentSource.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSet< FName > GetAllExecutionDomains() |
Returns all execution domains from all available sources | OptimusComponentSource.h | |
static TArray< const UOptimusComponentSource * > GetAllSources() |
Returns all registered component source objects | OptimusComponentSource.h | |
static const UOptimusComponentSource * GetSourceFromDataInterface
(
const UOptimusComputeDataInterface* InDataInterface |
Returns a component source that matches a data interface, or nullptr if nothing does | OptimusComponentSource.h |