1. Epic GamesDeveloper
  3. AUsdStageActor

AUsdStageActor

API > API/Plugins > API/Plugins/USDStage

   
Name AUsdStageActor
Type class
Header File /Engine/Plugins/Importers/USDImporter/Source/USDStage/Public/USDStageActor.h
Include Path #include "USDStageActor.h"

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

AUsdStageActor()

   USDStageActor.h  

Classes

Name Remarks
FOnActorLoaded  
FOnOpenStageEditorClicked  
FOnPrimChanged  
FOnStageActorEvent  

Typedefs

Name Type Remarks Include Path
FOnUsdStageTimeChanged TMulticastDelegate_NoParams< void >   USDStageActor.h

Constants

Name Type Remarks Include Path
OnActorLoaded FOnActorLoaded   USDStageActor.h
OnOpenStageEditorClicked FOnOpenStageEditorClicked   USDStageActor.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AssetCache TObjectPtr< UUsdAssetCache3 >   USDStageActor.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="USD"
bCollapseTopLevelPointInstancers bool If true, will cause us to collapse any point instancer prim into a single static mesh and static mesh component. USDStageActor.h  
bMergeIdenticalMaterialSlots bool If enabled, when multiple mesh prims are collapsed into a single static mesh, identical material slots are merged into one slot. USDStageActor.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="USD"
  • Config
bReuseIdenticalAssets bool   USDStageActor.h  
bShareAssetsForIdenticalPrims bool 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. USDStageActor.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="USD"
  • Config
bUsePrimKindsForCollapsing bool Use KindsToCollapse to determine when to collapse prim subtrees or not (defaults to enabled). USDStageActor.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="USD"
  • Config
FallbackCollisionType EUsdCollisionType What type of collision to use for static meshes generated from Prims that don't have physics schemas applied. USDStageActor.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="USD"
  • Config
GeometryCacheImport EGeometryCacheImport   USDStageActor.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="USD"
  • Config
InitialLoadSet EUsdInitialLoadSet These properties are configs so that spawned actors read them from the CDO when spawned. USDStageActor.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="USD"
  • Config
InterpolationType EUsdInterpolationType   USDStageActor.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="USD"
  • Config
KindsToCollapse int32 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 USDStageActor.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="USD"
  • Config
  • Meta=(Bitmask, BitmaskEnum="/Script/UnrealUSDWrapper.EUsdDefaultKind")
MaterialPurpose FName Specifies which material purbose to use when parsing USD material bindings, in addition to the "allPurpose" fallback. USDStageActor.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="USD"
  • Config
MetadataOptions FUsdMetadataImportOptions Describes if/how we should collect metadata from USD prims onto the assets and components we generate when opening stages USDStageActor.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="USD"
  • Config
NaniteTriangleThreshold int32 Try enabling Nanite for static meshes that are generated with at least this many triangles USDStageActor.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="USD"
  • Config
  • Meta=(NoSpinbox="true", UIMin="0", ClampMin="0")
OnActorDestroyed FOnStageActorEvent   USDStageActor.h  
OnPreStageChanged FOnStageActorEvent   USDStageActor.h  
OnPrimChanged FOnPrimChanged   USDStageActor.h  
OnStageChanged FOnStageActorEvent   USDStageActor.h  
OnStageLoaded FOnStageActorEvent   USDStageActor.h  
OnStageUnloaded FOnStageActorEvent   USDStageActor.h  
OnTimeChanged FOnUsdStageTimeChanged   USDStageActor.h  
PrimLinkCache TObjectPtr< UUsdPrimLinkCache >   USDStageActor.h
  • Transient
  • Instanced
PurposesToLoad int32 Only load prims with these specific purposes from the USD file USDStageActor.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="USD"
  • Config
  • Meta=(Bitmask, BitmaskEnum="/Script/UnrealUSDWrapper.EUsdPurpose")
RenderContext FName Specifies which set of shaders to use when parsing USD materials, in addition to the universal render context. USDStageActor.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="USD"
  • Config
RootLayer FFilePath   USDStageActor.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="USD"
  • Meta=(RelativeToGameDir)
RootMotionHandling EUsdRootMotionHandling Describes what to add to the root bone animation within generated AnimSequences, if anything. USDStageActor.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="USD"
  • Config
StageState EUsdStageState What to do with the USD Stage pointed to by RootLayer, if any USDStageActor.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="USD"
  • Config
SubdivisionLevel int32 Subdivision level to use for all subdivision meshes on the opened stage. USDStageActor.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="USD"
  • Config
UsdAssetCache TObjectPtr< UUsdAssetCache2 >   USDStageActor.h  
UsdInfoCache TObjectPtr< UUsdInfoCache > 'Transient' as this shouldn't be saved and should be zero'd when loading (i.e. each stage actor should always have a unique instance). USDStageActor.h
  • Transient
  • Instanced

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BlockMonitoringLevelSequenceForThisTransaction()

   USDStageActor.h  

const UE::FUsdStage & GetBaseUsdStage()

 Always returns the base stage, regardless of whether we have an isolated stage or not. USDStageActor.h  

PRAGMA_ENABLE_DEPRECATION_WARNINGSTSharedPtr< UE::FUsdGeomBBoxCache > GetBBoxCache()

   USDStageActor.h  

const UsdUtils::FBlendShapeMap & GetBlendShapeMap()

   USDStageActor.h  

TArray< UObject * > GetGeneratedAssets ( const FString& PrimPath
) const

 Gets the transient assets that were generated for a prim with a given prim path. USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

USceneComponent * GetGeneratedComponent ( const FString& PrimPath
) const

 Gets the transient component that was generated for a prim with a given prim path. USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

PRAGMA_DISABLE_DEPRECATION_WARNINGSTSharedPtr< FUsdInfoCache > GetInfoCache()

   USDStageActor.h  

FString GetIsolatedRootLayer()

 Returns the root layer identifier of the currently isolated stage if we're in isolated mode, and the empty string otherwise. USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

const UE::FUsdStage & GetIsolatedUsdStage()

 Always returns the isolated stage, being an invalid stage in case we're not isolating anything. USDStageActor.h  

ULevelSequence * GetLevelSequence()

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

TMap< FString, TMap< FString, int32 > > GetMaterialToPrimvarToUVIndex()

   USDStageActor.h  

UE::FUsdStage & GetOrLoadUsdStage()

   USDStageActor.h  

UE::FUsdStage & GetOrOpenUsdStage()

 Opens the stage with RootLayer if its not loaded already, and returns the either the isolated stage (if any) or the base stage USDStageActor.h  

FString GetSourcePrimPath ( const UObject* Object
) const

 Gets the path to the prim that was parsed to generate the given `Object_. USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

float GetTime()

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")
  USDStageActor.h  
  USDStageActor.h  

const UE::FUsdStage & GetUsdStage()

 Returns either the isolated stage (if any) or the base stage. USDStageActor.h  

bool IsListeningToUsdNotices()

   USDStageActor.h  

void IsolateLayer ( const UE::FSdfLayer& Layer,
bool bLoadUsdStage
)

 Enters isolated mode by creating a new USD Stage using the provided layer as its root. USDStageActor.h  

void NewStage()

 Creates a brand new, memory-only USD stage and opens it. USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void OpenLevelSequence()

   USDStageActor.h  
Creates new ULevelSequence assets for the root layer and sublayers. USDStageActor.h  

void ReloadAnimations()

   USDStageActor.h  
Fills in the current LevelSequences with animations for the prims of the opened stage. USDStageActor.h  

void ResumeListeningToUsdNotices()

   USDStageActor.h  

void ResumeMonitoringLevelSequence()

   USDStageActor.h  

void SetAssetCache ( UUsdAssetCache2* NewCache
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetBlockedPrefixFilters ( const TArray< FString >& NewFilters
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD|Metadata"
  • Meta=(CallInEditor="true")

void SetCollapseTopLevelPointInstancers ( bool bCollapse
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetCollectFromEntireSubtrees ( bool bNewCollectValue
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD|Metadata"
  • Meta=(CallInEditor="true")

void SetCollectMetadata ( bool bNewCollectValue
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD|Metadata"
  • Meta=(CallInEditor="true")

void SetCollectOnComponents ( bool bNewCollectValue
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD|Metadata"
  • Meta=(CallInEditor="true")

void SetFallbackCollisionType ( EUsdCollisionType NewCollisionType
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetGeometryCacheImport ( EGeometryCacheImport ImportOption
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetInitialLoadSet ( EUsdInitialLoadSet NewLoadSet
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetInterpolationType ( EUsdInterpolationType NewType
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetInvertFilters ( bool bNewInvertValue
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD|Metadata"
  • Meta=(CallInEditor="true")

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. USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetKindsToCollapse ( int32 NewKindsToCollapse
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetMaterialPurpose ( const FName& NewMaterialPurpose
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetMergeIdenticalMaterialSlots ( bool bMerge
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetNaniteTriangleThreshold ( int32 NewNaniteTriangleThreshold
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetPurposesToLoad ( int32 NewPurposesToLoad
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetRenderContext ( const FName& NewRenderContext
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetReuseIdenticalAssets ( bool bReuse
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetRootLayer ( const FString& RootFilePath
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetRootMotionHandling ( EUsdRootMotionHandling NewHandlingStrategy
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetShareAssetsForIdenticalPrims ( bool bShare
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetStageState ( EUsdStageState NewStageState
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetSubdivisionLevel ( int32 NewLevel
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetTime ( float InTime
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetUsdAssetCache ( UUsdAssetCache3* NewCache
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")

void SetUsdStage ( const UE::FUsdStage& NewStage
)

   USDStageActor.h  

void SetUsePrimKindsForCollapsing ( bool bUse
)

   USDStageActor.h
  • BlueprintCallable
  • Category="USD"
  • Meta=(CallInEditor="true")
Control whether we respond to USD notices or not. USDStageActor.h  

void StopMonitoringLevelSequence()

 Prevents writing back data to the USD stage whenever our LevelSequences are modified USDStageActor.h  

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual void Destroyed()

   USDStageActor.h  

virtual void PostActorCreated()

   USDStageActor.h  

virtual void PostRegisterAllComponents()

   USDStageActor.h  

virtual void PostUnregisterAllComponents()

   USDStageActor.h  

virtual void Reset()

   USDStageActor.h  

virtual void UnregisterAllComponents ( bool bForReregister
)

   USDStageActor.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   USDStageActor.h  

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   USDStageActor.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   USDStageActor.h  

virtual void PostInitProperties()

   USDStageActor.h  

virtual void PostRename ( UObject* OldOuter,
const FName OldName
)

   USDStageActor.h  

virtual void PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

   USDStageActor.h  

virtual void PreEditChange ( FProperty* PropertyThatWillChange
)

   USDStageActor.h  

virtual void PreEditUndo()

   USDStageActor.h  

virtual void Serialize ( FArchive& Ar
)

   USDStageActor.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AnimatePrims()

   USDStageActor.h  

void CloseUsdStage ( bool bUnloadIfNeeded
)

   USDStageActor.h  

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

   USDStageActor.h  

UUsdPrimTwin * GetOrCreatePrimTwin ( const UE::FSdfPath& UsdPrimPath
)

   USDStageActor.h  
  USDStageActor.h  
  USDStageActor.h  

void HandleAccumulatedNotices()

   USDStageActor.h  

void HandlePropertyChangedEvent ( FPropertyChangedEvent& PropertyChangedEvent
)

   USDStageActor.h  

void HandleTransactionStateChanged ( const FTransactionContext& InTransactionContext,
const ETransactionStateEventType InTransactionState
)

   USDStageActor.h  

bool HasAuthorityOverStage()

   USDStageActor.h  

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

 Loads the asset for a single prim USDStageActor.h  

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

 Loads the assets for all prims from StartPrim and its children USDStageActor.h  

void LoadUsdStage ( bool bOpenIfNeeded
)

   USDStageActor.h  

void OnBeginPIE ( bool bIsSimulating
)

   USDStageActor.h  

void OnLevelActorDeleted ( AActor* DeletedActor
)

   USDStageActor.h  

void OnObjectPropertyChanged ( UObject* ObjectBeingModified,
FPropertyChangedEvent& PropertyChangedEvent
)

   USDStageActor.h  

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

   USDStageActor.h  

void OnPostPIEStarted ( bool bIsSimulating
)

   USDStageActor.h  

void OnPostUsdImport ( FString FilePath
)

   USDStageActor.h  

void OnPreUsdImport ( FString FilePath
)

   USDStageActor.h  

void OnSkelAnimationBaked ( const FString& SkeletonPrimPath
)

   USDStageActor.h  

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

   USDStageActor.h  

void OnUsdPrimTwinDestroyed ( const UUsdPrimTwin& UsdPrimTwin
)

   USDStageActor.h  

void OpenUsdStage()

   USDStageActor.h  

void RebuildInfoCacheFromStoredChanges()

   USDStageActor.h  

void Refresh()

   USDStageActor.h  

void RequestDelayedTransactorReset()

   USDStageActor.h  

void SetupAssetCacheIfNeeded()

   USDStageActor.h  

void SetupBBoxCacheIfNeeded()

   USDStageActor.h  

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

   USDStageActor.h  

void UnloadUsdStage()

   USDStageActor.h  

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

   USDStageActor.h  

void UpdateSpawnedObjectsTransientFlag ( bool bTransient
)

   USDStageActor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page