1. Epic GamesDeveloper
  3. FAbcFile

FAbcFile

API > API/Plugins > API/Plugins/AlembicLibrary

References

   
Module AlembicLibrary
Header /Engine/Plugins/Importers/AlembicImporter/Source/AlembicLibrary/Public/AbcFile.h
Include #include "AbcFile.h"

Syntax

class FAbcFile

Variables

  Type Name Description
Protected variable FString AppName  
Protected variable Alembic::Abc::IArchive Archive Archive-typed ABC file
Protected variable FBoxSphereBounds ArchiveBounds Entire bounds of the archive over time
Protected variable float ArchiveSecondsPerFrame FPS stored inside of the ABC file
Protected variable Alembic::AbcCoreFactory::IFactory::CoreType CompressionType  
Protected variable TMap< FString, FString > CustomAttributes  
Protected variable FString DateWritten  
Protected variable int32 EndFrameIndex  
Protected variable Alembic::AbcCoreFactory::IFactory Factory Factory used to generate objects
Protected variable const FString FilePath File path for the ABC file
Protected variable float FramesPerSecond Frames per second (retrieved and specified in top Alembic object)
Protected variable FString Hash  
Protected variable float ImportLength Final length (in seconds)_of sequence we are importing
Protected variable UAbcImportSettings * ImportSettings Cached user set import settings
Protected variable float ImportTimeOffset  
Protected variable uint32 LibVersion  
Protected variable FString LibVersionString  
Protected variable TArray< int32 > LookupMaterialSlot  
Protected variable TMap< FString, UMaterialInterface * > MaterialMap Map of material created for the imported alembic file identified by material names
Protected variable int32 MaxFrameIndex  
Protected variable float MaxTime  
Protected variable IMeshUtilities * MeshUtilities Cached Mesh utilities ptr for normal calculations
Protected variable int32 MinFrameIndex Min and maximum frame index which contain actual data in the Alembic file
Protected variable float MinTime Min and maximum time found in the Alembic file
Protected variable int32 NumFrames Total (max) number of frames in the Alembic file
Protected variable TArray< IAbcObject * > Objects Abstract and typed objects part of this ABC file
Protected variable TArray< FAbcPolyMesh * > PolyMeshes  
Protected variable IAbcObject * RootObject Root (top) object in the ABC file
Protected variable float SecondsPerFrame Seconds per frame (calculated according to FPS)
Protected variable int32 StartFrameIndex Frame indices at which to start and stop importing
Protected variable Alembic::Abc::IObject TopObject Alembic typed root (top) object
Protected variable TArray< FAbcTransform * > Transforms  
Protected variable TArray< FString > UniqueFaceSetNames  
Protected variable FString UserDescription  

Constructors

  Type Name Description
Public function  

FAbcFile ( const FString& InFilePath
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

CleanupFrameData ( const int32 ReadIndex
)

 Cleans up frame data.
Public function Const const bool  
Protected function void

ExtractCustomAttributes ( const Alembic::AbcGeom::IPolyMesh& InMesh
)

  
Public function Const const FBoxSphereBounds &  
Public function Const TArray< FMetaData > Returns the metadata of the Alembic archive
Public function Const const int32  
Public function Const const FString Get file path for currently opened ABC file
Public function int32

GetFrameIndex ( float Time
)

 Returns frame index equivalent to a given time, based on the frame rate of the file
Public function Const const float  
Public function Const const float  
Public function Const const int32  
Public function Const const UAbcImportSettings * Returns user specified import settings
Public function Const const float  
Public function Const const TArray< int32 > & Returns the mapping from material index (stored in per triangle material indices of FAbcMeshSample) to material slot (one for each unique faceset name)
Public function UMaterialInterface **

GetMaterialByName ( const FString& InMaterialName
)

 Returns a material for the specified material(faceset) name or null if it wasn't created or found
Public function Const const int32  
Public function Const IMeshUtilities * Return mesh utilities module ptr (used in non-gamethread jobs)
Public function Const const int32 Returns ABC specific frame and timing information
Public function Const int32 Returns the number of material slots ( == number of unique facesets )
Public function Const const int32 Return number of PolyMeshes inside of the ABC file
Public function Const const TArray< FAbcPolyMesh * > & Return array of PolyMeshes inside of the ABC file
Public function Const const float  
Public function Const const int32 Returns start/end frame index of imported playback range
Public function Const const TArray< FAbcTransform * > & Return array of Transform Objects inside of the ABC file
Public function Const const TArray< FString > & Returns the list of unique face set names from the meshes to be imported
Public function EAbcImportError

Import ( UAbcImportSettings* InImportSettings
)

 Sets up import data and propagates import settings to read objects
Public function EAbcImportError

Open ()

 Opens the ABC file and reads initial data for import options
Public function bool

ProcessFrames ( TFunctionRef< void(int32, FAbcFile*)> InCallback,
const EFrameReadFlags InFlags,
const FSlowTask* SlowTask
)

 Process all to-import frames for each poly mesh inside of the ABC file, optional SlowTask to interrupt process and returns 'completed'
Public function void

ReadFrame ( int32 FrameIndex,
const EFrameReadFlags InFlags,
const int32 ReadIndex
)

 Reads the frame data for the given FrameIndex, with the ReadIndex used to specify the current read when doing concurrent reads (up to 8 at the same time)
Protected function void

TraverseAbcHierarchy ( const Alembic::Abc::IObject& InObject,
IAbcObject* InParent
)

  

Typedefs

Name Description
FMetaData  

Constants

Name Description
NoFaceSetNameStr  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page