Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > USDStage > AUsdStageActor

Light Theme

Dark Theme

AUsdStageActor

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AUsdStageActor

References

Module	USDStage
Header	/Engine/Plugins/Importers/USDImporter/Source/USDStage/Public/USDStageActor.h
Include	#include "USDStageActor.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(MinimalAPI)
class AUsdStageActor : public AActor

Variables

	Name	Description
EUsdInitialLoad...	InitialLoadSet
FOnStageActorEv...	OnActorDestroyed
FOnPrimChanged	OnPrimChanged
FOnStageActorEv...	OnStageChanged
FOnUsdStageTime...	OnTimeChanged
int32	PurposesToLoad	Only load prims with these specific purposes from the USD file
FName	RenderContext
FFilePath	RootLayer

Constructors

	Name	Description
	AUsdStageActor()

Destructors

	Name	Description
	~AUsdStageActor()

Functions

	Name	Description
void	AnimatePrims()
void	BlockMonitoringLevelSequenceForThisTransaction()
UUsdPrimTwin...	ExpandPrim ( const UE::FUsdPrim& Prim, FUsdSchemaTranslationContext& Tran... )
UUsdAssetCac...	GetAssetCache()
TArray< UObj...	GetGeneratedAssets ( const FString& PrimPath )	Gets the transient assets that were generated for a prim with a given prim path.
USceneCompon...	GetGeneratedComponent ( const FString& PrimPath )	Gets the transient component that was generated for a prim with a given prim path.
TMap< FStrin...	GetMaterialToPrimvarToUVIndex()
UUsdPrimTwin...	GetOrCreatePrimTwin ( const UE::FSdfPath& UsdPrimPath )
UE::FUsdStag...	GetOrLoadUsdStage()
FString	GetSourcePrimPath ( UObject* Object )	Gets the path to the prim that was parsed to generate the given `Object_.
float	GetTime()
float	GetTime()
const FUsdLi...	GetUsdListener()
FUsdListener...	GetUsdListener()
UE::FUsdStag...	GetUsdStage()
const UE::FU...	GetUsdStage()
void	HandleTransactionStateChanged ( const FTransactionContext& InTrans..., const ETransactionStateEventType In... )
bool	IsListeningToUsdNotices()
void	LoadAsset ( FUsdSchemaTranslationContext& Tran..., const UE::FUsdPrim& Prim )	Loads the asset for a single prim
void	LoadAssets ( FUsdSchemaTranslationContext& Tran..., const UE::FUsdPrim& StartPrim )	Loads the assets for all prims from StartPrim and its children
void	OnPostUsdImport ( FString FilePath )
void	OnPreUsdImport ( FString FilePath )
void	Refresh()
void	ReloadAnimations()
void	ResumeListeningToUsdNotices()
void	ResumeMonitoringLevelSequence()
void	SetInitialLoadSet ( EUsdInitialLoadSet NewLoadSet )
void	SetPurposesToLoad ( int32 NewPurposesToLoad )
void	SetRenderContext ( const FName& NewRenderContext )
void	SetRootLayer ( const FString& RootFilePath )
void	SetTime ( float InTime )
void	StopListeningToUsdNotices()	Control whether we respond to USD notices or not.
void	StopMonitoringLevelSequence()	Prevents writing back data to the USD stage whenever our LevelSequences are modified
void	UpdatePrim ( const UE::FSdfPath& UsdPrimPath, bool bResync, FUsdSchemaTranslationContext& Tran... )

Overridden from AActor

	Name	Description
void	Destroyed()	Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending
void	PostActorCreated()	Called when an actor is done spawning into the world (from UWorld::SpawnActor), both in the editor and during gameplay For actors with a root component, the location and rotation will have already been set.
void	PostRegisterAllComponents()	Called after all the components in the Components array are registered, called both in editor and during gameplay
void	PostUnregisterAllComponents()	Called after all currently registered components are cleared
void	Reset()	Reset actor to initial state - used when restarting level without reloading.

Overridden from UObject

	Name	Description
void	PostDuplicate ( bool bDuplicateForPIE )	Called after duplication & serialization and before PostLoad.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostTransacted ( const FTransactionObjectEvent& Tra... )	Called after the object has been transacted in some way.
void	PreEditChange ( FProperty* PropertyAboutToChan... )	This is called when a property is about to be modified externally
void	PreEditUndo()	Called before applying a transaction to the object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Classes

	Name	Description
	FOnActorLoaded
	FOnPrimChanged
	FOnStageActorEvent

Typedefs

Name	Description
FOnUsdStageTimeChanged

Constants

Name	Description
OnActorLoaded

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss