Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > AlembicLibrary > FAbcFile

Light Theme

Dark Theme

FAbcFile

Windows

MacOS

Linux

References

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

Syntax

class FAbcFile

Variables

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

Constructors

	Name	Description
	FAbcFile ( const FString& InFilePath )

Destructors

	Name	Description
	~FAbcFile()

Functions

	Name	Description
void	CleanupFrameData ( const int32 ReadIndex )	Cleans up frame data.
const bool	ContainsHeterogeneousMeshes()
void	ExtractCustomAttributes ( const Alembic::AbcGeom::IPolyMesh&... )
const FBoxSp...	GetArchiveBounds()
TArray< FMet...	GetArchiveMetaData()	Returns the metadata of the Alembic archive
const int32	GetEndFrameIndex()
const FStrin...	GetFilePath()	Get file path for currently opened ABC file
int32	GetFrameIndex ( float Time )	Returns frame index equivalent to a given time, based on the frame rate of the file
const int32	GetFramerate()
const float	GetImportLength()
const int32	GetImportNumFrames()
const UAbcIm...	GetImportSettings()	Returns user specified import settings
const float	GetImportTimeOffset()
UMaterialInt...	GetMaterialByName ( const FString& InMaterialName )	Returns a material for the specified material(faceset) name or null if it wasn't created or found
const int32	GetMaxFrameIndex()
IMeshUtiliti...	GetMeshUtilities()	Return mesh utilities module ptr (used in non-gamethread jobs)
const int32	GetMinFrameIndex()	Returns ABC specific frame and timing information
const int32	GetNumPolyMeshes()	Return number of PolyMeshes inside of the ABC file
const TArray...	GetPolyMeshes()	Return array of PolyMeshes inside of the ABC file
const float	GetSecondsPerFrame()
const int32	GetStartFrameIndex()	Returns start/end frame index of imported playback range
const TArray...	GetTransforms()	Return array of Transform Objects inside of the ABC file
const TArray...	GetUniqueFaceSetNames()	Returns the list of unique face set names from the meshes to be imported
EAbcImportEr...	Import ( UAbcImportSettings* InImportSe... )	Sets up import data and propagates import settings to read objects
EAbcImportEr...	Open()	Opens the ABC file and reads initial data for import options
void	ProcessFrames ( TFunctionRef< void, FAbcFile ..., const EFrameReadFlags InFlags )	Process all to-import frames for each poly mesh inside of the ABC file
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)
void	TraverseAbcHierarchy ( const Alembic::Abc::IObject& InObj..., IAbcObject* InParent )

Typedefs

Name	Description
FMetaData

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss