Navigation
| Name | UnrealUSDWrapper |
| Type | Runtime |
| Part of Plugins | USD Core |
| Location | /Engine/Plugins/Runtime/USDCore/Source/UnrealUSDWrapper/ |
| Module Build Rules | UnrealUSDWrapper.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FDummyPtrBase | We use these types so that we can keep the same FUsdStage, etc. |
| FDummyRefPtrType | |
| FDummyWeakPtrType | |
| FScopedBlockNotices | |
| FSdfAttributeSpec | Minimal pxr::SdfAttributeSpecHandle wrapper for Unreal that can be used from no-rtti modules. |
| FSdfChangeBlock | Minimal pxr::SdfChangeBlock wrapper for Unreal that can be used from no-rtti modules. |
| FSdfLayerBase | Minimal pxr::SdfLayer pointer wrapper for Unreal that can be used from no-rtti modules. |
| FSdfLayerUtils | Wrapper for global functions in pxr/usd/sdf/layerUtils.h |
| FSdfPath | Minimal pxr::SdfPath wrapper for Unreal that can be used from no-rtti modules. |
| FSdfPrimSpec | Minimal pxr::SdfPrimSpecHandle wrapper for Unreal that can be used from no-rtti modules. |
| FUsdAttribute | Minimal pxr::UsdAttribute wrapper for Unreal that can be used from no-rtti modules. |
| FUsdEditContext | Minimal pxr::UsdEditContext wrapper for Unreal that can be used from no-rtti modules. |
| FUsdGeomBBoxCache | Minimal pxr::UsdGeomBBoxCache wrapper for Unreal that can be used from no-rtti modules. |
| FUsdGeomSubset | Minimal pxr::UsdGeomSubset wrapper for Unreal that can be used from no-rtti modules. |
| FUsdGeomXformable | Minimal pxr::UsdGeomXformable wrapper for Unreal that can be used from no-rtti modules. |
| FUsdListener | Registers to Usd Notices and emits events when the Usd Stage has changed |
| FUsdMemoryManager | |
| FUsdPayloads | Minimal pxr::UsdPayloads wrapper for Unreal that can be used from no-rtti modules. |
| FUsdPrim | Minimal pxr::UsdPrim wrapper for Unreal that can be used from no-rtti modules. |
| FUsdReferences | Minimal pxr::UsdReferences wrapper for Unreal that can be used from no-rtti modules. |
| FUsdRelationship | Minimal pxr::UsdRelationship wrapper for Unreal that can be used from no-rtti modules. |
| FUsdSkelAnimQuery | Minimal pxr::UsdSkelAnimQuery wrapper for Unreal that can be used from no-rtti modules. |
| FUsdSkelBinding | Minimal pxr::UsdSkelBinding wrapper for Unreal that can be used from no-rtti modules. |
| FUsdSkelBlendShape | Minimal pxr::UsdSkelBlendShape wrapper for Unreal that can be used from no-rtti modules. |
| FUsdSkelBlendShapeQuery | Minimal pxr::UsdSkelBlendShapeQuery wrapper for Unreal that can be used from no-rtti modules. |
| FUsdSkelCache | Minimal pxr::UsdSkelCache wrapper for Unreal that can be used from no-rtti modules. |
| FUsdSkelInbetweenShape | Minimal pxr::UsdSkelInbetweenShape wrapper for Unreal that can be used from no-rtti modules. |
| FUsdSkelSkeletonQuery | Minimal pxr::UsdSkelSkeletonQuery wrapper for Unreal that can be used from no-rtti modules. |
| FUsdSkelSkinningQuery | Minimal pxr::UsdSkelSkinningQuery wrapper for Unreal that can be used from no-rtti modules. |
| FUsdStageBase | Minimal pxr::UsdStage pointer wrapper for Unreal that can be used from no-rtti modules. |
| FUsdTyped | Minimal pxr::UsdTyped wrapper for Unreal that can be used from no-rtti modules. |
| FUsdVariantSet | Minimal pxr::UsdVariantSet wrapper for Unreal that can be used from no-rtti modules. |
| FUsdVariantSets | Minimal pxr::UsdVariantSets wrapper for Unreal that can be used from no-rtti modules. |
| FVtValue | Minimal pxr::VtValue wrapper for Unreal that can be used from no-rtti modules. |
| TScopedAllocs | Activates an allocator on construction and deactivates it on destruction |
| TUsdStore | Stores a USD object. |
| UnrealUSDWrapper |
Structs
| Name | Remarks |
|---|---|
| FFieldChange | Analogous to pxr::SdfChangeList::Entry::InfoChange, describes a change to an attribute. |
| FMatrix2D | Corresponds to pxr::GfMatrix2d. |
| FMatrix3D | Corresponds to pxr::GfMatrix3d. |
| FPrimChangeFlags | Analogous to pxr::SdfChangeList::Entry::_Flags |
| FSdfChangeListEntry | Analogous to pxr::SdfChangeList::Entry, describes a generic change to an object |
| FSdfLayerOffset | |
| FSdfPayload | |
| FSdfReference | In the USD API, pxr::SdfPayload and pxr::SdfReference are very similar except that the latter includes support for a custom data dictionary. |
| FUsdDelegates |
Interfaces
| Name | Remarks |
|---|---|
| IUnrealUSDWrapperModule | |
| IUsdPrim |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FScopedUnrealAllocs | TScopedAllocs< EUsdActiveAllocator::Unreal > | USDMemory.h | |
| FScopedUsdAllocs | TScopedAllocs< EUsdActiveAllocator::System > | USDMemory.h |
Enums
Public
| Name | Remarks |
|---|---|
| EGeometryCacheImport | Stage option on how to handle geometry caches in stage workflow |
| EUsdActiveAllocator | |
| EUsdCollisionType | |
| EUsdDefaultKind | |
| EUsdGeomOrientation | |
| EUsdInitialLoadSet | |
| EUsdInterpolationMethod | |
| EUsdInterpolationType | |
| EUsdListPosition | Corresponds to pxr::UsdListPosition, refer to the USD SDK documentation |
| EUsdLoadPolicy | Corresponds to pxr::UsdLoadPolicy, refer to the USD SDK documentation |
| EUsdPurpose | |
| EUsdRootMotionHandling | |
| EUsdSubdivisionScheme |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CurrentAperturePropertyName | FName | UnrealUSDWrapper.h | ||
| CurrentFocalLengthPropertyName | FName | UCineCameraComponent properties. | UnrealUSDWrapper.h | |
| CustomNearClipppingPlanePropertyName | FName | UnrealUSDWrapper.h | ||
| DoubleSided | FString | UnrealUSDWrapper.h | ||
| ExportedSkeletonPrimName | const TCHAR * | The prim name we always use when exporting Skeletons inside SkelRoots to USD. | UnrealUSDWrapper.h | |
| ExposureCompensationPropertyName | FName | UnrealUSDWrapper.h | ||
| HiddenInGamePropertyName | FName | UnrealUSDWrapper.h | ||
| HiddenPropertyName | FName | UnrealUSDWrapper.h | ||
| IdentifierPrefix | const TCHAR * | UnrealUSDWrapper.h | ||
| Inherited | const TCHAR * | UnrealUSDWrapper.h | ||
| InnerConeAnglePropertyName | FName | UnrealUSDWrapper.h | ||
| IntensityPropertyName | FName | LightComponentBase properties. | UnrealUSDWrapper.h | |
| Invisible | const TCHAR * | UnrealUSDWrapper.h | ||
| LayerSavedComment | const TCHAR * | UnrealUSDWrapper.h | ||
| LightColorPropertyName | FName | UnrealUSDWrapper.h | ||
| LightSourceAnglePropertyName | FName | UDirectionalLightComponent properties. | UnrealUSDWrapper.h | |
| ManualFocusDistancePropertyName | FName | UnrealUSDWrapper.h | ||
| MaterialAllPurpose | FString | Material purpose tokens that we convert from USD, if available. | UnrealUSDWrapper.h | |
| MaterialAllPurposeText | FString | UnrealUSDWrapper.h | ||
| MaterialFullPurpose | FString | UnrealUSDWrapper.h | ||
| MaterialPreviewPurpose | FString | UnrealUSDWrapper.h | ||
| MaterialXRenderContext | const FName | UnrealUSDWrapper.h | ||
| MdlRenderContext | const FName | UnrealUSDWrapper.h | ||
| ModelApplyDrawMode | FString | UnrealUSDWrapper.h | ||
| ModelDrawMode | FString | Tokens from UsdGeomModelAPI that we need to reference from the UsdStageActor. | UnrealUSDWrapper.h | |
| OrthoFarClipPlanePropertyName | FName | UnrealUSDWrapper.h | ||
| OrthoNearClipPlanePropertyName | FName | UnrealUSDWrapper.h | ||
| OuterConeAnglePropertyName | FName | USpotLightComponent properties. | UnrealUSDWrapper.h | |
| PointInstancerTag | const FName | This marks a generated scene component as corresponding to a PointInstancer prim. | UnrealUSDWrapper.h | |
| PrimvarsDisplayColor | FString | UnrealUSDWrapper.h | ||
| PrimvarsDisplayOpacity | FString | UnrealUSDWrapper.h | ||
| ProjectionModePropertyName | FName | UnrealUSDWrapper.h | ||
| SensorHeightPropertyName | FName | UnrealUSDWrapper.h | ||
| SensorHorizontalOffsetPropertyName | FName | UnrealUSDWrapper.h | ||
| SensorVerticalOffsetPropertyName | FName | UnrealUSDWrapper.h | ||
| SensorWidthPropertyName | FName | UnrealUSDWrapper.h | ||
| SourceHeightPropertyName | FName | UnrealUSDWrapper.h | ||
| SourceRadiusPropertyName | FName | UPointLightComponent properties. | UnrealUSDWrapper.h | |
| SourceWidthPropertyName | FName | URectLightComponent properties. | UnrealUSDWrapper.h | |
| TemperaturePropertyName | FName | UnrealUSDWrapper.h | ||
| TransformPropertyName | FName | USceneComponent properties. | UnrealUSDWrapper.h | |
| TwoSidedMaterialSuffix | const TCHAR * | UnrealUSDWrapper.h | ||
| UniversalRenderContext | const FName | UnrealUSDWrapper.h | ||
| UniversalRenderContextDisplayString | const FString | UnrealUSDWrapper.h | ||
| UnrealRenderContext | const FName | UnrealUSDWrapper.h | ||
| UsdNamespaceDelimiter | FString | The character used to separate property namespaces (usually just ':') | UnrealUSDWrapper.h | |
| UseTemperaturePropertyName | FName | LightComponent properties. | UnrealUSDWrapper.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedRef< ObjectType > MakeSharedUnreal
(
ArgTypes&&... Args |
MakeShared version that makes sure that the SharedPointer allocs are made with the Unreal allocator. | USDMemory.h | |
TUsdStore< UsdObjectType > MakeUsdStore
(
ArgTypes&&... Args |
USDMemory.h | ||
bool operator!
(
EUsdPurpose E |
UnrealUSDWrapper.h | ||
bool operator!
(
EUsdDefaultKind E |
UnrealUSDWrapper.h | ||
EUsdPurpose operator&
(
EUsdPurpose Lhs, |
UnrealUSDWrapper.h | ||
EUsdDefaultKind operator&
(
EUsdDefaultKind Lhs, |
UnrealUSDWrapper.h | ||
EUsdPurpose & operator&=
(
EUsdPurpose& Lhs, |
UnrealUSDWrapper.h | ||
EUsdDefaultKind & operator&=
(
EUsdDefaultKind& Lhs, |
UnrealUSDWrapper.h | ||
EUsdPurpose operator^
(
EUsdPurpose Lhs, |
UnrealUSDWrapper.h | ||
EUsdDefaultKind operator^
(
EUsdDefaultKind Lhs, |
UnrealUSDWrapper.h | ||
EUsdPurpose & operator^=
(
EUsdPurpose& Lhs, |
UnrealUSDWrapper.h | ||
EUsdDefaultKind & operator^=
(
EUsdDefaultKind& Lhs, |
UnrealUSDWrapper.h | ||
EUsdPurpose operator|
(
EUsdPurpose Lhs, |
UnrealUSDWrapper.h | ||
EUsdDefaultKind operator|
(
EUsdDefaultKind Lhs, |
UnrealUSDWrapper.h | ||
EUsdPurpose & operator|=
(
EUsdPurpose& Lhs, |
UnrealUSDWrapper.h | ||
EUsdDefaultKind & operator|=
(
EUsdDefaultKind& Lhs, |
UnrealUSDWrapper.h | ||
EUsdPurpose operator~
(
EUsdPurpose E |
UnrealUSDWrapper.h | ||
| UnrealUSDWrapper.h |