Navigation
Unreal Engine C++ API Reference > 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 | |
---|---|---|---|
FString | AppName | ||
Alembic::Abc::IArchive | Archive | Archive-typed ABC file | |
FBoxSphereBounds | ArchiveBounds | Entire bounds of the archive over time | |
float | ArchiveSecondsPerFrame | FPS stored inside of the ABC file | |
Alembic::AbcCoreFactory::IFactory::CoreType | CompressionType | ||
TMap< FString, FString > | CustomAttributes | ||
FString | DateWritten | ||
int32 | EndFrameIndex | ||
Alembic::AbcCoreFactory::IFactory | Factory | Factory used to generate objects | |
const FString | FilePath | File path for the ABC file | |
float | FramesPerSecond | Frames per second (retrieved and specified in top Alembic object) | |
FString | Hash | ||
float | ImportLength | Final length (in seconds)_of sequence we are importing | |
UAbcImportSettings * | ImportSettings | Cached user set import settings | |
float | ImportTimeOffset | ||
uint32 | LibVersion | ||
FString | LibVersionString | ||
TArray< int32 > | LookupMaterialSlot | ||
TMap< FString, UMaterialInterface * > | 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< IAbcObject * > | Objects | Abstract and typed objects part of this ABC file | |
TArray< FAbcPolyMesh * > | 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::IObject | TopObject | Alembic typed root (top) object | |
TArray< FAbcTransform * > | Transforms | ||
TArray< FString > | UniqueFaceSetNames | ||
FString | UserDescription |
Constructors
Destructors
Type | Name | Description | |
---|---|---|---|
~FAbcFile () |
Functions
Type | Name | Description | |
---|---|---|---|
void | CleanupFrameData
(
const int32 ReadIndex |
Cleans up frame data. | |
const bool | |||
void | ExtractCustomAttributes
(
const Alembic::AbcGeom::IPolyMesh& InMesh |
||
const FBoxSphereBounds & | |||
TArray< FMetaData > | Returns the metadata of the Alembic archive | ||
const int32 | |||
const FString | 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 float | GetFramerate () |
||
const float | |||
const int32 | |||
const UAbcImportSettings * | Returns user specified import settings | ||
const float | |||
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) | ||
UMaterialInterface ** | GetMaterialByName
(
const FString& InMaterialName |
Returns a material for the specified material(faceset) name or null if it wasn't created or found | |
const int32 | |||
IMeshUtilities * | Return mesh utilities module ptr (used in non-gamethread jobs) | ||
const int32 | Returns ABC specific frame and timing information | ||
int32 | Returns the number of material slots ( == number of unique facesets ) | ||
const int32 | Return number of PolyMeshes inside of the ABC file | ||
const TArray< FAbcPolyMesh * > & | Return array of PolyMeshes inside of the ABC file | ||
const float | |||
const int32 | Returns start/end frame index of imported playback range | ||
const TArray< FAbcTransform * > & | Return array of Transform Objects inside of the ABC file | ||
const TArray< FString > & | Returns the list of unique face set names from the meshes to be imported | ||
EAbcImportError | Import
(
UAbcImportSettings* InImportSettings |
Sets up import data and propagates import settings to read objects | |
EAbcImportError | Open () |
Opens the ABC file and reads initial data for import options | |
bool | ProcessFrames
(
TFunctionRef< void(int32, FAbcFile*)> InCallback, |
Process all to-import frames for each poly mesh inside of the ABC file, optional SlowTask to interrupt process and returns 'completed' | |
void | ReadFrame
(
int32 FrameIndex, |
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& InObject, |
Typedefs
Name | Description |
---|---|
FMetaData |
Constants
Name | Description |
---|---|
NoFaceSetNameStr |