AlembicArchiveWriter (object)

The AlembicArchiveWriter is a wrapper for the AlembicOArchive. It provides access to the higher level writer objects such as the AlembicXformWriter, for example.

AlembicArchiveWriter AlembicArchiveWriter AlembicArchiveWriter

/*
** Example: AlembicArchiveWriter
*/

require AlembicWrapper;
require FileIO;

operator entry() {
  
  FilePath path = FilePath("${TEMP}/archivewriter.abc").expandEnvVars();

  AlembicArchiveWriter archive(path.string());

  AlembicXformWriter xformA = archive.addXform('/xfoA', Alembic_kConstantTimeSampling);
  AlembicXformWriter xformB = archive.addXform('/xfoA/xfoB', Alembic_kConstantTimeSampling);

  xformA.writeSample(Mat44());
  xformB.writeSample(Mat44());

  archive.reset();

  report(path.exists());
  report('Alembic file written: '+path.string());
}

/*
** Output:

true
Alembic file written: R:\Temp/archivewriter.abc

*/

Methods

  AlembicArchiveWriter ( in AlembicArchiveWriter other )
  AlembicArchiveWriter ( in String fileName )
  AlembicArchiveWriter ()
AlembicCameraWriter addCamera ! ( in Ref<AlembicObjectWriter> parentWriter, in String childPath, in SInt32 timeSampling )
AlembicCameraWriter addCamera ! ( in String childPath, in SInt32 timeSampling )
AlembicCameraWriter addCamera ! ( in String parentPath, in String childPath, in SInt32 timeSampling )
AlembicCurvesWriter addCurves ! ( in Ref<AlembicObjectWriter> parentWriter, in String childPath, in SInt32 timeSampling )
AlembicCurvesWriter addCurves ! ( in String childPath, in SInt32 timeSampling )
AlembicCurvesWriter addCurves ! ( in String parentPath, in String childPath, in SInt32 timeSampling )
AlembicPointsWriter addPoints ! ( in Ref<AlembicObjectWriter> parentWriter, in String childPath, in SInt32 timeSampling )
AlembicPointsWriter addPoints ! ( in String childPath, in SInt32 timeSampling )
AlembicPointsWriter addPoints ! ( in String parentPath, in String childPath, in SInt32 timeSampling )
AlembicPolyMeshWriter addPolyMesh ! ( in Ref<AlembicObjectWriter> parentWriter, in String childPath, in SInt32 timeSampling )
AlembicPolyMeshWriter addPolyMesh ! ( in String childPath, in SInt32 timeSampling )
AlembicPolyMeshWriter addPolyMesh ! ( in String parentPath, in String childPath, in SInt32 timeSampling )
AlembicPropertyWriter addProperty ! ( in String path, in String key, in AlembicPropertyType propertyType, in AlembicPOD pod, in UInt32 extent, in SInt32 timeSampling )
AlembicSubDWriter addSubD ! ( in Ref<AlembicObjectWriter> parentWriter, in String childPath, in SInt32 timeSampling )
AlembicSubDWriter addSubD ! ( in String childPath, in SInt32 timeSampling )
AlembicSubDWriter addSubD ! ( in String parentPath, in String childPath, in SInt32 timeSampling )
SInt32 addTimeSampling ! ( in Float64 times[] )
AlembicXformWriter addXform ! ( in Ref<AlembicObjectWriter> parentWriter, in String childPath, in SInt32 timeSampling )
AlembicXformWriter addXform ! ( in String childPath, in SInt32 timeSampling )
AlembicXformWriter addXform ! ( in String parentPath, in String childPath, in SInt32 timeSampling )
AlembicArchiveWriter clone ? ()
  closeArchive ! ( in Boolean close )
String getMetaData ! ( in String path, in String key )
String[] getMetaDataKeys ! ( in String path )
String getPath ? ()
AlembicOObject getTop ? ()
  informOfSampleArrayStore ! ( in Boolean succeeded[] )
  informOfSampleStore ! ( in Boolean succeeded )
  reset ! ()
  setMetaData ! ( in String path, in String key, in String value )
Boolean valid ? ()

Methods in detail

AlembicArchiveWriter ( in AlembicArchiveWriter other )

copy constructor


AlembicArchiveWriter ( in String fileName )

default constructor provided a fileName to create


AlembicArchiveWriter ()

default constructor


AlembicCameraWriter AlembicArchiveWriter.addCamera! ( in Ref<AlembicObjectWriter> parentWriter, in String childPath, in SInt32 timeSampling )

adds a new AlembicOCamera object based on a fullpath and a given timeSampling index.


AlembicCameraWriter AlembicArchiveWriter.addCamera! ( in String childPath, in SInt32 timeSampling )

adds a new AlembicOCamera object based on a fullpath and a given timeSampling index.


AlembicCameraWriter AlembicArchiveWriter.addCamera! ( in String parentPath, in String childPath, in SInt32 timeSampling )

adds a new AlembicOCamera object below the parent (specified by its path), using the childPath as its name and a given timeSampling index.


AlembicCurvesWriter AlembicArchiveWriter.addCurves! ( in Ref<AlembicObjectWriter> parentWriter, in String childPath, in SInt32 timeSampling )

adds a new AlembicOCurves object based on a fullpath and a given timeSampling index.


AlembicCurvesWriter AlembicArchiveWriter.addCurves! ( in String childPath, in SInt32 timeSampling )

adds a new AlembicOCurves object based on a fullpath and a given timeSampling index.


AlembicCurvesWriter AlembicArchiveWriter.addCurves! ( in String parentPath, in String childPath, in SInt32 timeSampling )

adds a new AlembicOCurves object below the parent (specified by its path), using the childPath as its name and a given timeSampling index.


AlembicPointsWriter AlembicArchiveWriter.addPoints! ( in Ref<AlembicObjectWriter> parentWriter, in String childPath, in SInt32 timeSampling )

adds a new AlembicOPoints object based on a fullpath and a given timeSampling index.


AlembicPointsWriter AlembicArchiveWriter.addPoints! ( in String childPath, in SInt32 timeSampling )

adds a new AlembicOPoints object based on a fullpath and a given timeSampling index.


AlembicPointsWriter AlembicArchiveWriter.addPoints! ( in String parentPath, in String childPath, in SInt32 timeSampling )

adds a new AlembicOPoints object below the parent (specified by its path), using the childPath as its name and a given timeSampling index.


AlembicPolyMeshWriter AlembicArchiveWriter.addPolyMesh! ( in Ref<AlembicObjectWriter> parentWriter, in String childPath, in SInt32 timeSampling )

adds a new AlembicOPolyMesh object based on a fullpath and a given timeSampling index.


AlembicPolyMeshWriter AlembicArchiveWriter.addPolyMesh! ( in String childPath, in SInt32 timeSampling )

adds a new AlembicOPolyMesh object based on a fullpath and a given timeSampling index.


AlembicPolyMeshWriter AlembicArchiveWriter.addPolyMesh! ( in String parentPath, in String childPath, in SInt32 timeSampling )

adds a new AlembicOPolyMesh object below the parent (specified by its path), using the childPath as its name and a given timeSampling index.


AlembicPropertyWriter AlembicArchiveWriter.addProperty! ( in String path, in String key, in AlembicPropertyType propertyType, in AlembicPOD pod, in UInt32 extent, in SInt32 timeSampling )


AlembicSubDWriter AlembicArchiveWriter.addSubD! ( in Ref<AlembicObjectWriter> parentWriter, in String childPath, in SInt32 timeSampling )

adds a new AlembicOSubD object based on a fullpath and a given timeSampling index.


AlembicSubDWriter AlembicArchiveWriter.addSubD! ( in String childPath, in SInt32 timeSampling )

adds a new AlembicOSubD object based on a fullpath and a given timeSampling index.


AlembicSubDWriter AlembicArchiveWriter.addSubD! ( in String parentPath, in String childPath, in SInt32 timeSampling )

adds a new AlembicOSubD object below the parent (specified by its path), using the childPath as its name and a given timeSampling index.


SInt32 AlembicArchiveWriter.addTimeSampling! ( in Float64 times[] )

adds a new AlembicTimeSampling based on an array of sample times and returns its index.


AlembicXformWriter AlembicArchiveWriter.addXform! ( in Ref<AlembicObjectWriter> parentWriter, in String childPath, in SInt32 timeSampling )

adds a new AlembicOXform object below the parent writer, using the childPath as its name and a given timeSampling index.


AlembicXformWriter AlembicArchiveWriter.addXform! ( in String childPath, in SInt32 timeSampling )

adds a new AlembicOXform object based on a fullpath and a given timeSampling index.


AlembicXformWriter AlembicArchiveWriter.addXform! ( in String parentPath, in String childPath, in SInt32 timeSampling )

adds a new AlembicOXform object below the parent (specified by its path), using the childPath as its name and a given timeSampling index.


AlembicArchiveWriter AlembicArchiveWriter.clone? ()

clone method


AlembicArchiveWriter.closeArchive! ( in Boolean close )

closes the file after writing


String AlembicArchiveWriter.getMetaData! ( in String path, in String key )

Returns the meta data given a path and a key


String[] AlembicArchiveWriter.getMetaDataKeys! ( in String path )

Returns all meta data keys given a path


String AlembicArchiveWriter.getPath? ()

returns the path of the open archive


AlembicOObject AlembicArchiveWriter.getTop? ()


AlembicArchiveWriter.informOfSampleArrayStore! ( in Boolean succeeded[] )

informs the AlembicArchiveWriter of several successfull sample stores


AlembicArchiveWriter.informOfSampleStore! ( in Boolean succeeded )

informs the AlembicArchiveWriter of a successfull sample store


AlembicArchiveWriter.reset! ()

clears the content of the archive and closes all related writer objects


AlembicArchiveWriter.setMetaData! ( in String path, in String key, in String value )

Sets the meta data given a path, key and value


Boolean AlembicArchiveWriter.valid? ()

returns true if the wrapped archive is valid