1. Epic GamesDeveloper
  3. AUsdStageActor

AUsdStageActor

API > API/Plugins > API/Plugins/USDStage

Inheritance Hierarchy

References

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

Syntax

UCLASS (MinimalAPI, Config=USDImporter)  
class AUsdStageActor : public AActor

Variables

  Type Name Description
Protected variable UsdUtils::FObjectChangesByPath AccumulatedInfoChanges USD can emit multiple notices within the same UE transaction.
Protected variable UsdUtils::FObjectChangesByPath AccumulatedResyncChanges  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< UUsdAssetCache3 > AssetCache  
Protected variable TSharedPtr< UE::FUsdGeomBBoxCache > BBoxCache USD bounding box cache for the stage. Constructed on-demand
Public variable UProperty bool bCollapseTopLevelPointInstancers If true, will cause us to collapse any point instancer prim into a single static mesh and static mesh component.
Protected variable bool bIsAddingBinding  
Protected variable bool bIsModifyingAProperty  
Protected variable bool bIsPendingTransactorReset  
Protected variable bool bIsTransitioningIntoPIE We use PostRegisterAllComponents and PostUnregisterAllComponents as main entry points to decide when to load/unload the USD stage.
Protected variable bool bIsUndoRedoing  
Protected variable bool bLayerReloaded  
Protected variable UsdUtils::FBlendShapeMap BlendShapesByPath Keep track of blend shapes so that we can map 'inbetween shapes' to their separate morph targets when animating
Protected variable UProperty Category, Meta BlueprintReadOnly visibleanywhere   BlueprintReadOnly  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config bool bMergeIdenticalMaterialSlots If enabled, when multiple mesh prims are collapsed into a single static mesh, identical material slots are merged into one slot.
Public variable UProperty bool bReuseIdenticalAssets  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config bool bShareAssetsForIdenticalPrims If true, whenever two prims would have generated identical UAssets (like identical StaticMeshes or materials) then only one instance of that asset is generated, and the asset is shared by the components generated for both prims.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config bool bUsePrimKindsForCollapsing Use KindsToCollapse to determine when to collapse prim subtrees or not (defaults to enabled).
Protected variable UProperty Category, Meta BlueprintReadOnly visibleanywhere   Category  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config EGeometryCacheImport GeometryCacheImport  
Protected variable PRAGMA_DISABLE_DEPRECATION_WARNINGSTSharedPtr< FUsdInfoCache > InfoCache Caches various information about prims that are expensive to query
Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config EUsdInitialLoadSet InitialLoadSet These properties are configs so that spawned actors read them from the CDO when spawned.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config EUsdInterpolationType InterpolationType  
Protected variable FThreadSafeCounter IsBlockedFromUsdNotices  
Protected variable UE::FUsdStage IsolatedStage Another stage that has as root layer one of the non-root local layers of UsdStage.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly Config int32 KindsToCollapse Whether to try to combine individual assets and components of the same type on a kind-per-kind basis, like multiple Mesh prims into a single Static Mesh
Protected variable UProperty Category Transient visibleanywhere TObjectPtr< ULevelSequence > LevelSequence  
Protected variable FUsdLevelSequenceHelper LevelSequenceHelper  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config FName MaterialPurpose Specifies which material purbose to use when parsing USD material bindings, in addition to the "allPurpose" fallback.
Protected variable TMap< FString, TMap< FString, int32 > > MaterialToPrimvarToUVIndex When parsing materials, we keep track of which primvar we mapped to which UV channel.
Protected variable UProperty Category, Meta BlueprintReadOnly visibleanywhere   meta  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config FUsdMetadataImportOptions MetadataOptions Describes if/how we should collect metadata from USD prims onto the assets and components we generate when opening stages
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly Config int32 NaniteTriangleThreshold Try enabling Nanite for static meshes that are generated with at least this many triangles
Protected variable UProperty Transient TMap< TObjectPtr< UObject >, FString > ObjectsToWatch  
Protected variable FFilePath OldRootLayer Helps us know whether a transaction changed our RootLayer or not.
Public variable FOnStageActorEvent OnActorDestroyed  
Public variable FOnStageActorEvent OnPreStageChanged  
Public variable FOnPrimChanged OnPrimChanged  
Protected variable FDelegateHandle OnRedoHandle  
Protected variable FDelegateHandle OnSequencerCreatedHandle  
Public variable FOnStageActorEvent OnStageChanged  
Public variable FOnStageActorEvent OnStageLoaded  
Public variable FOnStageActorEvent OnStageUnloaded  
Public variable FOnUsdStageTimeChanged OnTimeChanged  
Public variable UProperty TObjectPtr< UUsdPrimLinkCache > PrimLinkCache  
Protected variable UProperty Transient TSet< FString > PrimsToAnimate  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly Config int32 PurposesToLoad Only load prims with these specific purposes from the USD file
Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config FName RenderContext Specifies which set of shaders to use when parsing USD materials, in addition to the universal render context.
Protected variable TArray< UE::FSdfPath > ResyncedPrimsForThisTransaction  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FFilePath RootLayer  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config EUsdRootMotionHandling RootMotionHandling Describes what to add to the root bone animation within generated AnimSequences, if anything.
Protected variable UProperty Transient TObjectPtr< UUsdPrimTwin > RootUsdTwin Note: This cannot be instanced: Read the comment in the constructor.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config EUsdStageState StageState What to do with the USD Stage pointed to by RootLayer, if any
Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config int32 SubdivisionLevel Subdivision level to use for all subdivision meshes on the opened stage.
Protected variable UProperty Category, EditAnywhere float Time TimeCode to evaluate the USD stage at
Protected variable UProperty Transient TObjectPtr< UUsdTransactor > Transactor  
Public variable UProperty TObjectPtr< UUsdAssetCache2 > UsdAssetCache  
Public variable UProperty TObjectPtr< UUsdInfoCache > UsdInfoCache  
Protected variable FUsdListener UsdListener  
Protected variable UE::FUsdStage UsdStage The main UsdStage that is currently opened.
Protected variable UProperty Category, Meta BlueprintReadOnly visibleanywhere   VisibleAnywhere  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function void  
Public function void  
Protected function void

CloseUsdStage ( bool bUnloadIfNeeded
)

  
Protected function UUsdPrimTwin *

ExpandPrim ( const UE::FUsdPrim& Prim,
bool bResync,
FUsdSchemaTranslationContext& TranslationContext,
TOptional< bool > bParentHasAnimatedVisibility
)

  
Public function Const const UE::FUsdStage & Always returns the base stage, regardless of whether we have an isolated stage or not.
Public function TSharedPtr< UE::FUsdGeomBBoxCache >  
Public function const UsdUtils::FBlendShapeMap &  
Public function Const UFunction BlueprintCallable, Category, Meta TArray< UObject * >

GetGeneratedAssets ( const FString& PrimPath
)

 Gets the transient assets that were generated for a prim with a given prim path.
Public function Const UFunction BlueprintCallable, Category, Meta USceneComponent *

GetGeneratedComponent ( const FString& PrimPath
)

 Gets the transient component that was generated for a prim with a given prim path.
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGSTSharedPtr< FUsdInfoCache >  
Public function Const UFunction BlueprintCallable, Category, Meta FString Returns the root layer identifier of the currently isolated stage if we're in isolated mode, and the empty string otherwise.
Public function Const const UE::FUsdStage & Always returns the isolated stage, being an invalid stage in case we're not isolating anything.
Public function UFunction BlueprintCallable, Category, Meta ULevelSequence *  
Public function TMap< FString, TMap< FString, int32 > >  
Protected function UUsdPrimTwin *

GetOrCreatePrimTwin ( const UE::FSdfPath& UsdPrimPath
)

  
Public function UE::FUsdStage &  
Public function UE::FUsdStage & Opens the stage with RootLayer if its not loaded already, and returns the either the isolated stage (if any) or the base stage
Protected function Const UUsdPrimTwin *  
Protected function UUsdPrimTwin *  
Public function Const UFunction BlueprintCallable, Category, Meta FString

GetSourcePrimPath ( const UObject* Object
)

 Gets the path to the prim that was parsed to generate the given `Object_.
Public function Const UFunction BlueprintCallable, Category, Meta float

GetTime ()

  
Public function FUsdListener &  
Public function Const const FUsdListener &  
Public function Const const UE::FUsdStage & Returns either the isolated stage (if any) or the base stage.
Protected function void  
Protected function void  
Protected function void

HandleTransactionStateChanged ( const FTransactionContext& InTransactionContext,
const ETransactionStateEventType InTransactionState
)

  
Protected function Const bool  
Public function Const bool  
Public function void

IsolateLayer ( const UE::FSdfLayer& Layer
)

 Enters isolated mode by creating a new USD Stage using the provided layer as its root.
Protected function bool

LoadAsset ( FUsdSchemaTranslationContext& TranslationContext,
const UE::FUsdPrim& Prim
)

 Loads the asset for a single prim
Protected function bool

LoadAssets ( FUsdSchemaTranslationContext& TranslationContext,
const UE::FUsdPrim& StartPrim
)

 Loads the assets for all prims from StartPrim and its children
Protected function void

LoadUsdStage ( bool bOpenIfNeeded
)

  
Public function UFunction BlueprintCallable, Category, Meta void Creates a brand new, memory-only USD stage and opens it.
Protected function void

OnBeginPIE ( bool bIsSimulating
)

  
Protected function void

OnLevelActorDeleted ( AActor* DeletedActor
)

  
Protected function void

OnObjectPropertyChanged ( UObject* ObjectBeingModified,
FPropertyChangedEvent& PropertyChangedEvent
)

  
Protected function void

OnObjectsReplaced ( const TMap< UObject*, UObject* >& ObjectReplacementMap
)

  
Protected function void

OnPostPIEStarted ( bool bIsSimulating
)

  
Protected function void

OnPostUsdImport ( FString FilePath
)

  
Protected function void

OnPreUsdImport ( FString FilePath
)

  
Protected function void

OnSkelAnimationBaked ( const FString& SkeletonPrimPath
)

  
Protected function void

OnUsdObjectsChanged ( const UsdUtils::FObjectChangesByPath& InfoChanges,
const UsdUtils::FObjectChangesByPath& ResyncChanges
)

  
Protected function void

OnUsdPrimTwinDestroyed ( const UUsdPrimTwin& UsdPrimTwin
)

  
Protected function void  
Protected function void  
Protected function Const void

Refresh ()

  
Public function void Creates new ULevelSequence assets for the root layer and sublayers.
Public function void  
Public function void Fills in the current LevelSequences with animations for the prims of the opened stage.
Protected function void  
Public function void  
Public function void  
Public function UFunction BlueprintCallable, Category, Meta void  
Public function UFunction BlueprintCallable, Category, Meta void

SetBlockedPrefixFilters ( const TArray< FString >& NewFilters
)

  
Public function UFunction BlueprintCallable, Category, Meta void  
Public function UFunction BlueprintCallable, Category, Meta void

SetCollectFromEntireSubtrees ( bool bNewCollectValue
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetCollectMetadata ( bool bNewCollectValue
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetCollectOnComponents ( bool bNewCollectValue
)

  
Public function UFunction BlueprintCallable, Category, Meta void  
Public function UFunction BlueprintCallable, Category, Meta void  
Public function UFunction BlueprintCallable, Category, Meta void  
Public function UFunction BlueprintCallable, Category, Meta void

SetInvertFilters ( bool bNewInvertValue
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetIsolatedRootLayer ( const FString& IsolatedStageRootLayer
)

 If IsolatedStageRootLayer is the identifier of one of the sublayers of the currently opened stage, this will enter isolated mode by creating a new stage with IsolatedStageRootLayer as its root, and displaying that.
Public function UFunction BlueprintCallable, Category, Meta void

SetKindsToCollapse ( int32 NewKindsToCollapse
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetMaterialPurpose ( const FName& NewMaterialPurpose
)

  
Public function UFunction BlueprintCallable, Category, Meta void  
Public function UFunction BlueprintCallable, Category, Meta void

SetNaniteTriangleThreshold ( int32 NewNaniteTriangleThreshold
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetPurposesToLoad ( int32 NewPurposesToLoad
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetRenderContext ( const FName& NewRenderContext
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetReuseIdenticalAssets ( bool bReuse
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetRootLayer ( const FString& RootFilePath
)

  
Public function UFunction BlueprintCallable, Category, Meta void  
Public function UFunction BlueprintCallable, Category, Meta void  
Public function UFunction BlueprintCallable, Category, Meta void

SetStageState ( EUsdStageState NewStageState
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetSubdivisionLevel ( int32 NewLevel
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetTime ( float InTime
)

  
Protected function void  
Protected function void  
Public function UFunction BlueprintCallable, Category, Meta void  
Public function void

SetUsdStage ( const UE::FUsdStage& NewStage
)

  
Public function UFunction BlueprintCallable, Category, Meta void  
Public function void Control whether we respond to USD notices or not.
Public function void Prevents writing back data to the USD stage whenever our LevelSequences are modified
Protected function bool

UnloadAssets ( const UE::FSdfPath& PrimPath,
bool bForEntireSubtree
)

  
Protected function void  
Protected function void

UpdatePrim ( const UE::FSdfPath& UsdPrimPath,
bool bResync,
FUsdSchemaTranslationContext& TranslationContext
)

  
Protected function void

UpdateSpawnedObjectsTransientFlag ( bool bTransient
)

  

Overridden from AActor

  Type Name Description
Public function Virtual void Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending
Public function Virtual void 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.
Public function Virtual void Called after all the components in the Components array are registered, called both in editor and during gameplay.
Public function Virtual void Called after all currently registered components are cleared
Public function Virtual void

Reset ()

 Reset actor to initial state - used when restarting level without reloading.
Public function Virtual void

UnregisterAllComponents ( bool bForReregister
)

 Unregister all currently registered components

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

 Called after duplication & serialization and before PostLoad.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void

PostRename ( UObject* OldOuter,
const FName OldName
)

 Called at the end of Rename(), but only if the rename was actually carried out
Public function Virtual void

PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

 Called after the object has been transacted in some way.
Public function Virtual void

PreEditChange ( FProperty* PropertyThatWillChange
)

 This is called when a property is about to be modified externally
Public function Virtual void Called before applying a transaction to the object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Classes

  Type Name Description
Public class FOnActorLoaded    
Public class FOnOpenStageEditorClicked    
Public class FOnPrimChanged    
Public class FOnStageActorEvent    

Typedefs

Name Description
FOnUsdStageTimeChanged  

Constants

Name Description
OnActorLoaded  
OnOpenStageEditorClicked  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page