1/*!
2\page usdabc_page_front UsdAbc : Alembic File Format Plugin
3\if ( PIXAR_MFB_BUILD )
4\mainpage UsdAbc : Alembic File Format Plugin
5\publicLib
6\endif
7
8\section usdAbc_overview Overview
9
10This library currently exists to provide the alembic file format plugin for
11USD, and currently has no user-level API.
12
13\section usdAbc_behavior Behavior
14
15\subsection SDF_FORMAT_ARGS
16UsdAbc accepts some SDF_FORMAT_ARGS for controlling behavior.
17
18SDF_FORMAT_ARGS                     | Meaning                                                                                                                       | Default Value
19------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|-------
20abcReRoot=STRING                    | 'ReRoot' the immediate children of the IArchive on a single Xform whose name is the value of STRING                           | empty / ""
21abcLayers=LAYER_1,LAYER_2,LAYER_N   | Additional / Layered alembic files for IFactory::getArchive.\n These are expected as paths already resolved (likely absolute) | empty / []
22
23testenv/testUsdAbcSDFArguments/testUsdAbcSDFArguments.usda has the following example, which will load all children in
24testUsdAbcSDFArgumentsMesh.abc into the 'AlembicRoot' Xform, using layered Alembic to load UVs from testUsdAbcSDFArgumentsUV.abc.
25\verbatim
26def Xform "AlembicRoot" (
27    references = @./testUsdAbcSDFArgumentsMesh.abc:SDF_FORMAT_ARGS:abcReRoot=AlembicRoot&abcLayers=./testUsdAbcSDFArgumentsUV.abc@
28)
29{
30}
31\endverbatim
32
33\subsection TfEnvSettings
34
35UsdAbc exposes some TfEnvSettings for controlling behavior.
36
37Setting Name                        | Meaning                                                         | Default Value
38------------------------------------|-----------------------------------------------------------------|-------
39USD_ABC_NUM_OGAWA_STREAMS           | The number of threads available for reading ogawa-backed files. | 4
40USD_ABC_EXPAND_INSTANCES            | Force alembic instances to be expanded                          | false
41USD_ABC_DISABLE_INSTANCES           | Disable instancing on prototypes created from alembic           | false
42USD_ABC_PARENT_INSTANCES            | Make parent of instance source into prototypes where possible   | true
43USD_ABC_WARN_ALL_UNSUPPORTED_VALUES | Issue warnings for all unsupported values encountered.          | false
44
45*/
46