Skip to content

Commit

Permalink
Updating FEEDBACK.txt and MANIFEST.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
lamiller0 committed Aug 8, 2011
1 parent 8c9d64f commit 4e8ab50
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 67 deletions.
82 changes: 34 additions & 48 deletions FEEDBACK.txt
@@ -1,52 +1,38 @@
This 0.9 release of Alembic has a dual purpose: it is a beta release,
but it is also the beginning of a conversation. We are fairly
confident that the Alembic library, as it exists now, performs well
and is bug free. We are at the beginning of building the tools
that will leverage the features that Alembic provides.
By making our beta version of this library public,
we hope that the attention of the community will ferret out subtle
problems or insufficiently supported use-cases that are meaningful to
the industry as a whole.

However, in addition to bug-hunting and performance tuning we are also
seeking feedback from the visual effects community on the style,
explorability, and extensibility of the user-facing API layers.
Specifically:

* Design and API of AbcGeom?
We have worked to make AbcGeom both a statement of industry
consensus of what certain geometric primitives are (polygon meshes,
for example), but to also be extensible, so advanced users can
quickly create their own high-level schemas to support other
types of data, such as lights, bezier curves and so forth. Have
we struck the right balance between extensibility and standardization?

* Design and API of Abc
The "Abc" API layer is what we consider the lowest-level of the
Alembic library that authors of plug-ins or utilities will use. It
has grown from a set of "thin" wrapper classes into a full-fledged
API for reading and writing arbitrary data, and this ancestry shows
in its design. To use the "Abc" API, you will need to use
classes and types defined in the "AbcCoreAbstract" and the "Util"
libraries. We already have some simplification plans in mind for 1.0,
but we want to know if there are parts of this API that you find hard
to understand or use.

There are several items that we know aren't in version 0.9. This list is the starting point for our plans as we work toward 1.0:
This is the 1.0 release of Alembic.

We are confident it performs well, is feature complete, and is bug free enough
to make the following promises:

1. Alembic Data will be backwards compatible with any version of the API.

2. Read performance will be the same or improve with future versions.

3. API will remain source code compatible unless read performance can be
greatly improved.

4. Write performance will stay the same or improve unless read performance can
be greatly increased.

5. Disk space usage will stay the same or improve unless read performance can
be greatly increased.

6. Traversing the hierarchy must remain fast and not require much data
loading/memory usage to guarantee on-demand loading.

7. Reading and writing the data for a specific node will not require the data
of any other node for on-demand loading and writing.

8. Reading and writing a frame for a node will not require any other frame for
on-demand loading and writing.

There are several items that aren't in version 1.0 but will hopefully be
included in a future patch:
* Python bindings for the public-facing API.
* A full-featured Maya importer and exporter
* More complete documentation of the Abc and AbcGeom layers
* An Alembic file stitcher
* Katana/Arnold plugin
* Exploration of Windows support (currently, we believe Alembic works under
Windows but we haven't tried all the variations between 32 bit vs. 64 bit,
and Windows XP, Windows Vista, and Windows 7)

These topics, and the questions that descend from them, aren't meant
to be prescriptive but rather representative of the feedback we'd like
to get from our users. Alembic is stable and usable, but far from
finished, and any comments, criticisms or insights that you can
provide are more than welcome. We hope you'll share your thoughts
* Katana plugin
* Houdini exporter

Alembic is stable and usable, and any comments, criticisms or insights that you
can provide are more than welcome. We hope you'll share your thoughts
and feedback with us on alembic-discussion@googlegroups.com.
To join the alembic-discussion mailing list, please visit
http://groups.google.com/group/alembic-discussion.
Expand Down
57 changes: 38 additions & 19 deletions MANIFEST.txt
@@ -1,27 +1,44 @@
arnold
|
`-- Procedural start of a procedural for Arnold
|
`-- Tests
|
` -- arnold_procedural_testbed - Uses the Arnold procedural and an Alembic
Archive to print out an Arnold "ass" file
to stdout.

build -- Cmake files and bootstrap utilities

doc -- Documentation for how to build dependencies, doxygen generated doc will
also end up here

examples - Unsupported examples that use Alembic

examples - Examples that use Alembic
|
`-- AbcClients
| |
| `-- FluidSimDemo - example CUDA simulation, slightly older API, won't
| | currently build
| `-- WFObjConvert - Convert WaveFront OBJ files to Alembic Archives
|
`-- bin
|
`-- GlutSkeleton - skeletal template for OpenGL-based Alembic utility
`-- AbcEcho
|
`-- abcecho - Prints some basic information about all of the IObjects,
IScalarProperties, and IArrayProperties in the Alembic
Archive.
|
`-- AbcEchoBounds - example which prints accumulated bounds for all of
the IPolyMeshes and ISubDs in the Alembic Archive.
|
`-- AbcStitcher - Used to combine Alembic Archives with the same hierarchy
but different yet continuous time samples.
|
`-- GtoMeshesToAbc - Convert GTO mesh files into Alembic Archives
| (requires Open-GTO libraries)
`-- SimpleAbcViewer - Simple OpenGL viewer for Alembic Archives

houdini
|
`-- SOP_AlembicIn
houdini
|
`-- SOP_AlembicIn - Reference implementation for reading an Alembic Archive
into Houdini.

lib
|
Expand All @@ -35,25 +52,27 @@ houdini
| |
| `-- AbcCoreHDF5 - Implementation of AbcCoreAbstract using HDF5
| |
| `-- MD5Hash - Checksum library used in conjunction with HDF5
| |
| `-- GLUtil - OpenGL utilities for working with Alembic
| |
| `-- Util - Low level utilities used by all other layers
|
`-- python - python utilities that help the bootstrap build script

maya
|
`-- AbcExport - Official Maya export plugin.
`-- AbcExport - Reference implementation for writing Alembic Archives
out of Maya.
|
`-- AbcImport - Official Maya import plugin.
`-- AbcImport - Reference implementation for reading Alembic Archives into
Maya.

prman
|
`-- Procedural - start of a Renderman DSO suitable for use in a
'Procedural "DynamicLoad"' RIB statement.

`-- Procedural - Renderman DSO suitable for use in a
'Procedural "DynamicLoad"' RIB statement.
|
`-- Tests
|
`-- testbed - Uses the Renderman DSO and an Alembic Archive to print RIB
statements to stdout.
python
|
`-- alembic - Start of Boost.Python bindings.
Expand Down

0 comments on commit 4e8ab50

Please sign in to comment.