1. Epic GamesDeveloper
  3. FUsdStageBase

FUsdStageBase

Minimal pxr::UsdStage pointer wrapper for Unreal that can be used from no-rtti modules.

API > API/Plugins > API/Plugins/UnrealUSDWrapper

Minimal pxr::UsdStage pointer wrapper for Unreal that can be used from no-rtti modules. Use the aliases FUsdStage and FUsdStageWeak instead (defined on ForwardDeclarations.h)

   
Name FUsdStageBase
Type class
Header File /Engine/Plugins/Runtime/USDCore/Source/UnrealUSDWrapper/Public/UsdWrappers/ForwardDeclarations.h
Include Path #include "UsdWrappers/ForwardDeclarations.h"
Source /Engine/Plugins/Runtime/USDCore/Source/UnrealUSDWrapper/Public/UsdWrappers/UsdStage.h

Syntax

template<typename PtrType>  
class FUsdStageBase

Constructors

Name Remarks Include Path Unreal Specifiers

FUsdStageBase ( FUsdStage&& Other
)

   UsdWrappers/UsdStage.h  

FUsdStageBase ( const FUsdStageWeak& Other
)

   UsdWrappers/UsdStage.h  

FUsdStageBase ( FUsdStageWeak&& Other
)

   UsdWrappers/UsdStage.h  

FUsdStageBase ( const FUsdStage& Other
)

   UsdWrappers/UsdStage.h  
  UsdWrappers/UsdStage.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FUsdStageBase()

   UsdWrappers/UsdStage.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
FUsdStage friend So we can use the Other's Impl on copy constructor/operators. UsdWrappers/UsdStage.h  
FUsdStageWeak friend   UsdWrappers/UsdStage.h  
Impl TUniquePtr< Internal::FUsdStageImpl< PtrType > >   UsdWrappers/UsdStage.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ClearMetadata ( const TCHAR* Key
) const

   UsdWrappers/UsdStage.h  

FUsdPrim CreateClassPrim ( const FSdfPath& RootPrimPath
)

   UsdWrappers/UsdStage.h  

FUsdPrim DefinePrim ( const FSdfPath& Path,
const TCHAR* TypeName
)

   UsdWrappers/UsdStage.h  

bool Export ( const TCHAR* FileName,
bool bAddSourceFileComment,
const TMap< FString, FString >& FileFormatArguments
) const

 Saves a flattened copy of the stage to the given path (e.g. "C:/Folder/FlattenedStage.usda"). UsdWrappers/UsdStage.h  

FUsdPrim GetDefaultPrim()

   UsdWrappers/UsdStage.h  

FSdfLayer GetEditTarget()

   UsdWrappers/UsdStage.h  

double GetEndTimeCode()

   UsdWrappers/UsdStage.h  

double GetFramesPerSecond()

   UsdWrappers/UsdStage.h  

EUsdInterpolationType GetInterpolationType()

   UsdWrappers/UsdStage.h  

TArray< FSdfLayer > GetLayerStack ( bool bIncludeSessionLayers
) const

   UsdWrappers/UsdStage.h  

bool GetMetadata ( const TCHAR* Key,
UE::FVtValue& Value
) const

   UsdWrappers/UsdStage.h  

FUsdPrim GetPrimAtPath ( const FSdfPath& Path
) const

   UsdWrappers/UsdStage.h  

FUsdPrim GetPseudoRoot()

   UsdWrappers/UsdStage.h  

FSdfLayer GetRootLayer()

   UsdWrappers/UsdStage.h  

FSdfLayer GetSessionLayer()

   UsdWrappers/UsdStage.h  

double GetStartTimeCode()

   UsdWrappers/UsdStage.h  

double GetTimeCodesPerSecond()

   UsdWrappers/UsdStage.h  

TArray< FSdfLayer > GetUsedLayers ( bool bIncludeClipLayers
) const

   UsdWrappers/UsdStage.h  

bool HasLocalLayer ( const FSdfLayer& Layer
) const

   UsdWrappers/UsdStage.h  

bool HasMetadata ( const TCHAR* Key
) const

   UsdWrappers/UsdStage.h  

bool IsEditTargetValid()

   UsdWrappers/UsdStage.h  

bool IsLayerMuted ( const FString& LayerIdentifier
) const

   UsdWrappers/UsdStage.h  

void LoadAndUnload ( const TSet< UE::FSdfPath >& LoadSet,
const TSet< UE::FSdfPath >& UnloadSet,
EUsdLoadPolicy Policy
)

 Wrapped pxr::UsdStage functions, refer to the USD SDK documentation. UsdWrappers/UsdStage.h  

void MuteAndUnmuteLayers ( const TArray< FString >& MuteLayers,
const TArray< FString >& UnmuteLayers
)

   UsdWrappers/UsdStage.h  

FUsdPrim OverridePrim ( const FSdfPath& Path
)

   UsdWrappers/UsdStage.h  

bool RemovePrim ( const FSdfPath& Path
)

   UsdWrappers/UsdStage.h  

void SetDefaultPrim ( const FUsdPrim& Prim
)

   UsdWrappers/UsdStage.h  

void SetEditTarget ( const FSdfLayer& Layer
)

   UsdWrappers/UsdStage.h  

void SetEndTimeCode ( double TimeCode
)

   UsdWrappers/UsdStage.h  

void SetFramesPerSecond ( double FramesPerSecond
)

   UsdWrappers/UsdStage.h  

void SetInterpolationType ( EUsdInterpolationType InterpolationType
)

   UsdWrappers/UsdStage.h  

bool SetMetadata ( const TCHAR* Key,
const UE::FVtValue& Value
) const

   UsdWrappers/UsdStage.h  

void SetStartTimeCode ( double TimeCode
)

   UsdWrappers/UsdStage.h  

void SetTimeCodesPerSecond ( double TimeCodesPerSecond
)

   UsdWrappers/UsdStage.h  

Operators

Name Remarks Include Path Unreal Specifiers

operator bool()

   UsdWrappers/UsdStage.h  

FUsdStageBase & operator= ( FUsdStageWeak&& Other
)

   UsdWrappers/UsdStage.h  

FUsdStageBase & operator= ( FUsdStage&& Other
)

   UsdWrappers/UsdStage.h  

FUsdStageBase & operator= ( const FUsdStage& Other
)

   UsdWrappers/UsdStage.h  

FUsdStageBase & operator= ( const FUsdStageWeak& Other
)

   UsdWrappers/UsdStage.h  

bool operator== ( const FUsdStageBase< OtherPtrType >& Other
) const

 We have to implement a templated comparison operator, or else we get ambigous conversions on the Mac targets when comparing FUsdStage and FUsdStageWeak UsdWrappers/UsdStage.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page