Skip to content

AbcXform

AbcXform#

(Abc Xform)

No corresponding User page.

Description#

Xform imported from alembic. The object original position can not be edited. The transformation that can be set by its attributes is applied on the orginal matrix.

Public Attributes#

Type Name Visual Hint Description
string filename VISUAL_HINT_FILENAME_OPEN ABC file path.
long pivot_mode VISUAL_HINT_DEFAULT Set the way pivot information is read in the file: using the baked matrix or individual attributes.
long frame VISUAL_HINT_DEFAULT Defines the value of the frame that will be used to evaluate the mesh.
long anim_frame_count VISUAL_HINT_DEFAULT Count of frames available in the file
long frame_offset VISUAL_HINT_DEFAULT Offset the ABC time. If you set the value to 50 while the animation in the ABC starts at frame 10, it then starts at frame 60.
long animation_behavior VISUAL_HINT_DEFAULT Set how the animation will loop.
bool force_animation_range VISUAL_HINT_DEFAULT
long[2] animation_range VISUAL_HINT_DEFAULT Start and end of the forced animation.

Inherited Public Attributes#

Type Name Visual Hint Description
double[3] translate VISUAL_HINT_DISTANCE Set the XYZ position of the item relative to its parent item.
double[3] rotate VISUAL_HINT_ANGLE Set the XYZ rotation of the item relative to its parent item.
double[3] scale VISUAL_HINT_SCALE Set the XYZ scaling of the item relative to its parent item.
double[3] shear VISUAL_HINT_SCALE Set the XYZ shear of the item relative to its parent item.
long rotation_order VISUAL_HINT_DEFAULT Specify on which order the Euler rotations are composed. By default Clarisse's uses YXZ
reference (SceneItem) parent VISUAL_HINT_DEFAULT Set the parent item of the item.
bool inherit_transform VISUAL_HINT_DEFAULT Does the current object inherits its parent transformation ?
long reference_frame VISUAL_HINT_FRAME Set the reference frame that defines the base transform and deformation state of the item. This reference is used when computing texture projections or when generating point cloud (in Global Base) on the base geometry.
object[] (Constraint) constraints VISUAL_HINT_DEFAULT Stack of constraint operators. Constraints like Target, Point, Orient... are applied to a Scene Item in order to drive the transformation of the item.
double[3] scale_pivot VISUAL_HINT_DISTANCE Set the coordinates of the scale pivot.
double[3] rotate_pivot VISUAL_HINT_DISTANCE Set the coordinates of the rotation pivot.
double[3] translate_offset VISUAL_HINT_DISTANCE Set the XYZ position of the pivot point of the item.
double[3] rotate_offset VISUAL_HINT_ANGLE Set the XYZ rotation of the pivot point of the item.
double[3] scale_offset VISUAL_HINT_SCALE Set the XYZ scaling of the pivot point of the item.
long rotation_offset_order VISUAL_HINT_DEFAULT Set the rotation axis mode.
bool display_visible VISUAL_HINT_DEFAULT Set whether the item is shown in the 3D View or not.
bool display_pickable VISUAL_HINT_DEFAULT Set whether the item is pickable in the 3D View or in the Image View.
long display_color VISUAL_HINT_DEFAULT Set the item color for constant or simple shading display in the 3D View.
double[3] display_custom_color VISUAL_HINT_COLOR Set the item custom color used for display in the 3D View when the Display Color attribute is set to Custom.
long visibility_mode VISUAL_HINT_DEFAULT Set how visibility attributes 'Display Visible' and 'Unseen By Renderer' are driven. In Use Project Preferences mode, the mode uses the project preference value. In Override mode, the attributes are set manually. In Use Property mode, the attributes are driven by a property (e.g. Alembic visibility property).
bool enable_motion_blur VISUAL_HINT_DEFAULT Set whether the renderer will do motion blur on the item or not.

CID#

class "AbcXform" "Locator" {
    abstract yes
    #version 0.99
    icon "../icons/object_icons/xform_abc.iconrc"
    doc "Xform imported from alembic. The object original position can not be edited. The transformation that can be set by its attributes is applied on the orginal matrix."
    attribute_group "alembic" {
        list<filename_open> "filename" {
            doc "ABC file path."
            extension "abc"
            saveable no
            value ""
        }
        list<string> "filename_sys" {
            private yes
            value ""
        }
        string "object_name" {
            doc "Object path in the file"
            hidden yes
            value ""
        }
        list<long> "data_hash_key_timestamp" {
            doc "Files modificiation times."
            private yes
            value <empty>
        }
    }
    attribute_group "alembic>playback" {
        collapsed yes
        long "pivot_mode" {
            doc "Set the way pivot information is read in the file: using the baked matrix or individual attributes."
            preset "Use Matrix" "0"
            preset "Use Attributes" "1"
            value 0
        }
        long "frame" {
            doc "Defines the value of the frame that will be used to evaluate the mesh."
            animatable yes
            value[] 0
            expression "F"
        }
        long "anim_frame_count" {
            doc "Count of frames available in the file"
            dg_active no
            read_only yes
            value 1
        }
        long "frame_offset" {
            doc "Offset the ABC time. If you set the value to 50 while the animation in the ABC starts at frame 10, it then starts at frame 60."
            animatable yes
            ui_range yes -1000 1000
            value 0
        }
        double "current_anim_time" {
            doc "Time currently used. Attribute is set after time change"
            private yes
            saveable no
            dg_active no
            value 0.0
        }
        double[16] "base_matrix" {
            doc "Base transformation matrix."
            private yes
            dg_active no
            value 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0
        }
        double[2] "anim_range" {
            doc "Start and end time of the animation."
            private yes
            value 0.0 0.0
        }
        long "animation_behavior" {
            doc "Set how the animation will loop."
            preset "Hold" "0"
            preset "Repeat" "1"
            value 0
        }
        bool "force_animation_range" {
            value no
        }
        long[2] "animation_range" {
            doc "Start and end of the forced animation."
            read_only yes
            value 0 50
        }
        long "visibility_type" {
            private yes
            dg_active no
            read_only yes
            value 0
        }
        double[2] "visibility_range" {
            doc "Time range of the visibility property."
            private yes
            saveable no
            dg_active no
            read_only yes
            value 0.0 0.0
        }
    }
}