Skip to content

ProcessWriteAbc

ProcessWriteAbc#

(Write Abc)

Go to User page.

Description#

Process that writes an input context into an Alembic archive.

Public Attributes#

Type Name Visual Hint Description
reference input_context VISUAL_HINT_DEFAULT Input context to export.
string filename VISUAL_HINT_FILENAME_SAVE Output filename.
long batch_process_mode VISUAL_HINT_DEFAULT Defines the kind of output when the process is called by batch process. When using 'Multiple Output Files', a separate file is created each time the process is run (e.g. 1 file per frame exported). When using 'Single Output File', a single monolithic file is created for the whole batch (e.g. 1 file containing the whole frame range).
bool export_combiners VISUAL_HINT_DEFAULT When checked, combiners will be exported as pivots with their sub-objects as direct children. Sub-combiners are exported recursively.
bool export_scatterers VISUAL_HINT_DEFAULT When checked, scatterers will be exported as a hierarchy of instances, otherwise scatterers and their instances are not exported.
long scatterer_export_mode VISUAL_HINT_DEFAULT When using the Geometries mode, scattered instances are exported as is. When using the Bounding Boxes mode, instances are replaced by their bounding box.
bool export_properties VISUAL_HINT_DEFAULT When checked, Particle Container properties will be exported. The exported properties are created under the standard Alembic property group .arbGeomParams.
long compatibility_mode VISUAL_HINT_DEFAULT Select a preset for the properties options Fill Sparse Properties, Promote To Geometry Parameter and Bake Indexed Properties. Options are editable when using the mode None, otherwise they are read-only with pre-defined values.
bool fill_sparse_properties VISUAL_HINT_DEFAULT When checked, sparse properties will be filled with a default value (zero). This option must be enabled to be compatible with applications that don't support sparse properties (e.g. Houdini).
bool promote_to_geometry_parameter VISUAL_HINT_DEFAULT When checked, all properties whose traits (type, size, ...) match Alembic's Typed Geometry Parameters will be exported as Geometry Parameters, and properties that don't match such traits are exported as regular properties. When unchecked, all properties are exported as regular properties. It is recommended to enable this option unless the target application doesn't support Geometry Parameters (e.g. Katana).
bool bake_indexed_properties VISUAL_HINT_DEFAULT When checked, all indexed properties except Geometry Parameters will be baked as non-sparse array properties: values are unshared and will use more memory and disk space. Enabling this option can improve compatibility with other applications. When unchecked, indexed properties will be exported unchanged (a compound property with 2 children properties: an array of indices and an array of indexed values).

Inherited Public Attributes#

Type Name Visual Hint Description
action run_process VISUAL_HINT_DEFAULT

CID#

class "ProcessWriteAbc" "Process" {
    #license {
        flavor "advanced"
    }
    #version 0.96
    icon "../icons/object_icons/process_abc_export.iconrc"
    doc "Process that writes an input context into an Alembic archive."
    aliases "ProcessAlembicExport"
    attribute_group "input" {
        reference "input_context" {
            doc "Input context to export."
            filter "Context"
            value ""
        }
        long "export" {
            hidden yes
            read_only yes
            preset "Current Context (Recursive)" "0"
            preset "Selection" "1"
            preset "Current Scene (using 3DLayer)" "2"
            preset "Whole Project" "3"
            value 0
        }
        reference "layer_3d" {
            filter "Layer3d"
            hidden yes
            read_only yes
            value ""
        }
    }
    attribute_group "output" {
        filename_save "filename" {
            doc "Output filename."
            extension "abc"
            value ""
        }
        long "batch_process_mode" {
            doc "Defines the kind of output when the process is called by batch process. When using \'Multiple Output Files\', a separate file is created each time the process is run (e.g. 1 file per frame exported). When using \'Single Output File\', a single monolithic file is created for the whole batch (e.g. 1 file containing the whole frame range)."
            preset "Multiple Output Files" "0"
            preset "Single Output File" "1"
            value 0
        }
    }
    attribute_group "animation" {
        long "frame_range_mode" {
            hidden yes
            read_only yes
            preset "Current Frame" "0"
            preset "Use Timeline Range" "1"
            preset "Custom" "2"
            value 0
        }
        long[2] "frame_range" {
            doc "Specify the start/end frames to export."
            hidden yes
            read_only yes
            value 0 0
        }
        bool "write_one_frame_per_file" {
            doc "When checked, the export process will create one file per frame."
            hidden yes
            read_only yes
            value yes
        }
        bool "transfer_source_data" {
            doc "When checked, Alembic objects will be exported by transferring the original data from the source file to the new one. Disabling this option will re-bake objects using Clarisse\'s frame rate, and custom properties will be lost."
            hidden yes
            read_only yes
            value no
        }
        bool "restrict_to_clarisse_frame_range" {
            doc "When checked, only samples in the export frame range are transfered for the original Alembic cache."
            hidden yes
            read_only yes
            value yes
        }
    }
    attribute_group "hierarchy" {
        long "hierarchy" {
            hidden yes
            read_only yes
            preset "Export As Is" "0"
            preset "Flatten Hierarchy And Bake Global Matrices" "2"
            preset "Export Missing Parents" "3"
            value 0
        }
        bool "apply_only_on_orphans" {
            hidden yes
            read_only yes
            value no
        }
    }
    attribute_group "combiners" {
        bool "export_combiners" {
            doc "When checked, combiners will be exported as pivots with their sub-objects as direct children. Sub-combiners are exported recursively."
            value yes
        }
    }
    attribute_group "scatterers" {
        bool "export_scatterers" {
            doc "When checked, scatterers will be exported as a hierarchy of instances, otherwise scatterers and their instances are not exported."
            value yes
        }
        long "scatterer_export_mode" {
            doc "When using the Geometries mode, scattered instances are exported as is. When using the Bounding Boxes mode, instances are replaced by their bounding box."
            preset "Instances As Geometries" "0"
            preset "Instances As Bounding Boxes" "1"
            value 0
        }
    }
    attribute_group "properties" {
        bool "export_properties" {
            doc "When checked, Particle Container properties will be exported. The exported properties are created under the standard Alembic property group .arbGeomParams."
            value yes
        }
        long "compatibility_mode" {
            doc "Select a preset for the properties options Fill Sparse Properties, Promote To Geometry Parameter and Bake Indexed Properties. Options are editable when using the mode None, otherwise they are read-only with pre-defined values."
            preset "None" "0"
            preset "Houdini" "1"
            preset "Houdini and Katana" "2"
            value 0
        }
        bool "fill_sparse_properties" {
            doc "When checked, sparse properties will be filled with a default value (zero). This option must be enabled to be compatible with applications that don\'t support sparse properties (e.g. Houdini)."
            value no
        }
        bool "promote_to_geometry_parameter" {
            doc "When checked, all properties whose traits (type, size, ...) match Alembic\'s Typed Geometry Parameters will be exported as Geometry Parameters, and properties that don\'t match such traits are exported as regular properties. When unchecked, all properties are exported as regular properties. It is recommended to enable this option unless the target application doesn\'t support Geometry Parameters (e.g. Katana)."
            value yes
        }
        bool "bake_indexed_properties" {
            doc "When checked, all indexed properties except Geometry Parameters will be baked as non-sparse array properties: values are unshared and will use more memory and disk space. Enabling this option can improve compatibility with other applications. When unchecked, indexed properties will be exported unchanged (a compound property with 2 children properties: an array of indices and an array of indexed values)."
            value no
        }
    }
}